/pygame_cffi

A cffi-based SDL wrapper that copies the pygame API.

Primary LanguagePythonGNU Lesser General Public License v2.1LGPL-2.1

pygame_cffi

Build Status PyPI Windows Build status

A cffi-based SDL wrapper that copies the pygame API.

We copy various code and API ideas from pygame, so we inherit pygame's LGPL v2.1, or later license.

Discussion

We have a Google Group: https://groups.google.com/forum/#!forum/pygame-cffi. Any pygame-cffi discussion welcome!

There is also the #pygame-cffi channel on irc.freenode.net

Installation

  1. Install the requirements listed below. On a Debian-based system, all requirements can be installed using sudo apt-get build-dep pygame (pygame_cffi requires most of the pygame dependencies).
  2. pip install pygame_cffi

Requirements

pygame_cffi requires a recent version of python-cffi to build (at least version 1.3.0).

  • libjpeg-dev
  • libpng-dev
  • libsdl1.2-dev
  • libsdl-image1.2-dev
  • libsdl-mixer1.2-dev
  • libsdl-ttf2.0-dev

Local Development

  1. Install dependencies (probably in a virtualenv)
  2. Run cffi_builders/build.py
  3. Hack

Running Tests

  • Upstream pygame unit tests: python -m test
  • Tests that are known to fail on pygame_cffi are marked as expected failures. To see these failures, pass the --expected-failures argument.
  • Conformance between pygame and pygame_cffi: See conformance/README
  • pygame_cffi functionality example apps are in the demos directory

Building on windows

To build on windows, you need to download the appropriate dependency libraries. The pygame project provides all the required libraries in a nicely bundled set, available from https://bitbucket.org/llindstrom/pygame/downloads/

For 32 bit machines, download the latest prebuilt-x86 zipfile and unzip it under the pygame_cffi directory.

For 64 bit machines, download the latest prebuild-x64 zipfile and unzip it under the pygame_cffi directory.

Then run python setup.py build to compile the modules.