Skip to main content

Grease: A component-based game engine and rapid development framework

Project description

Grease is a pluggable and highly extensible 2D game engine and framework for Python.

The intent of this project is to provide a fresh approach to Python game development. The component-based architecture allows games to be constructed bit by bit with built-in separation of concerns. The engine acknowledges that all game projects are unique and have different requirements. Thus Grease does not attempt to provide one-size-fits-all solutions. Instead it provides pluggable components and systems than can be configured, adapted and extended to fits the particular needs at hand.

The goals of the project include:

  • Making Python game development faster and more fun by allowing the developer to focus on creating their game rather than getting bogged down in architecture, low-level apis and adapting ill-fitting tools together.

  • To provide pluggable and extensible parts that implement first-class techniques and algorithms that can be leveraged for many projects.

  • To fully document the engine and provide examples that demonstrate best practices for others to base their projects on.

  • To facilitate outside contribution of parts and ideas into the framework that have proven useful in the wild.

  • To provide optional native-code optimized parts for maximum performance, but also provide equivalent parts coded in pure Python for ease of installation and distribution.

Not all of these goals have been realized yet, but I feel the project is well on their path.

License

Grease is distributed under a permissive MIT-style open source license. This license permits you to use grease for commercial or non-commercial purposes free of charge. It makes no demands on how, or whether, you license, or release the code derived from or built upon Grease, other than preservation of copyright notice.

For a complete text of the license see the LICENSE.txt file in the source distrbution.

Requirements

Grease is platform-independent and should run on any operating system supporting Python and Pyglet.

The following are required to build and install Grease:

Downloading Grease

You can download Grease from the python package index (pypi):

Development Status

Grease is alpha software under active development. The APIs may change in future releases, however efforts will be made to minimize breakage between releases.

Installation

To install Grease from the source distribution or repository use:

python2.6 setup.py install

Once installed you can try it out by running the unit tests and the included example game, but make sure you leave the grease source directory first or they will not work properly:

cd
python2.6 -m grease.test.run_all
python2.6 -m grease.examples.blasteroids3

Note on some platforms, such as MacOS X, you will need to use pythonw2.6 to run the tests and example game.

Note, you can also try out Grease without installing it by setting your PYTHONPATH to the source directory:

export PYTHONPATH=`pwd`
python2.6 test/run_all.py
python2.6 examples/blasteroids3.py

Documentation

You can browse the documentation online at:

The documentation is also available for offline viewing in the doc/build/html subdirectory for the source distribution.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distributions

grease-0.2.zip (2.6 MB view details)

Uploaded Source

grease-0.2.tar.gz (2.5 MB view details)

Uploaded Source

File details

Details for the file grease-0.2.zip.

File metadata

  • Download URL: grease-0.2.zip
  • Upload date:
  • Size: 2.6 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for grease-0.2.zip
Algorithm Hash digest
SHA256 122b099916c59fbe552d1a6d8d7329d74f3c34dc5d26469a1479c04d6d9109b1
MD5 169bdb05c1cfcfa00cd945d3f5d94a91
BLAKE2b-256 95705841a3c1a5a60e7306f204c658a2d5b08dd2a1ddaf8d6dcf879eacb54253

See more details on using hashes here.

File details

Details for the file grease-0.2.tar.gz.

File metadata

  • Download URL: grease-0.2.tar.gz
  • Upload date:
  • Size: 2.5 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for grease-0.2.tar.gz
Algorithm Hash digest
SHA256 aa502727a4e368efea935a554b5bdd2a708b2ac088e80ee8823dc7d0812c6256
MD5 e336b0420e88636f51e0e73465be288d
BLAKE2b-256 fecf107538f6b116503c51f3b282e724636b138a38c36350d70282444430b465

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page