ikn / game-engine Goto Github PK

This is a template I use for Pygame games.

    DEPENDENCIES

Python (2.6 or later 2.x, 3.2 or later 3.x)
Pygame (1.8.1 or later, probably; tested with 1.9.1)

    RUNNING

To run from source, you must first compile.  This process requires GNU Make or
equivalent or the version of Visual whatever-it's-called that was used to
compile your Python version, and header files for SDL and Pygame must be
available on the system.  Just run

    make

On Windows, this requires the command-line compiler ('cl') to be on your path,
and assumes that SDL.h is in the directory 'sdl_include' above this directory
(horrible, I know).

The makefile supports a 'PYTHON_VERSION' argument which can be 2 (default) or
3, which determines which version to build for.

Now, on systems with a sh-compatible shell, do

    ./run

On other systems (Windows, for example), run run.py with your Python 2
executable.

    CONTROLS

F11, alt + enter: toggle fullscreen
F10: minimise
alt + F4: exit

    LICENSING

Source code in game/engine/ is available under the LGPL version 3 (included in
'LICENSE-engine').

Source code outside of game/engine is available under the 3-clause BSD license
(included in 'LICENSE').