pymunk 2.1.0

pymunk is a easy-to-use pythonic 2d physics library built on top of Chipmunk

ABOUT

pymunk is a easy-to-use pythonic 2d physics library that can be used whenever you need 2d rigid body physics from Python. It is built on top of the very nice 2d physics library Chipmunk.

2007 - 2011, Victor Blomqvist - [e-mail], MIT License

This release is based on the latest pymunk release (2.1.0), using chipmunk 6.x (github rev 82ba83e, source included)

Homepage:

http://code.google.com/p/pymunk/

Forum:

http://www.slembcke.net/forums/viewforum.php?f=6

Email:

[e-mail]

Getting the latest SVN copy:

svn checkout http://pymunk.googlecode.com/svn/trunk pymunk-read-only

Chipmunk:

http://code.google.com/p/chipmunk-physics/

HOW TO USE

pymunk ships with a number of demos in the examples directory, and the API documentation. There is also a few tutorials on the googlecode page and in the (shared) forum.

If chipmunk doesnt ship with a chipmunk binary your platform can understand (currently Windows and Linux 32bit are included) you will have to compile chipmunk before install. See section CHIPMUNK in this readme for (very simple) instructions.

To install you can either run:

> python setup.py install

or simply put the pymunk folder where your program/game can find it. (like /my_python_scripts/yourgame/pymunk). The chipmunk binary library is located in the pymunk folder.

The easy way to get started is to check out the examples/ directory, and run ‘python contact.py’ and so on, and see what it does :) (Note: you will have to place /pymunk in the examples directory if you dont install pymunk to site-packages)

EXAMPLE

See the included demos (in examples/)

DEPENDENCIES/REQUIREMENTS

• python (tested on 2.5, 2.6, 2.7 and 3.2)

• ctypes (included in python 2.5)

• pygame (optional, you need it to run most of the demos)

• pyglet (optional, you need it to run the moon buggy demo)

• ctypeslib & GCC_XML (optional, you need them to generate new bindings)

• chipmunk (pymunk ships with a set of chipmunk libraries)

CHIPMUNK

Compiled libraries of Chipmunk compatible Windows and Linux 32bit are distributed with pymunk. If pymunk doesnt have your particular platform included, you can compile Chipmunk by hand with a custom setup argument:

> python setup.py build_chipmunk

The compiled file goes into the /pymunk folder (same as _chipmunk.py, util.py and others). If the compile fail, please check the readme in chipmunk_src for generic instructions on how to compile with gcc, or download the relevant release from Chipmunk homepage and follow its instructions.

HOW TO GENERATE BINDINGS

(optional – if you want to experiment :)

You will need the ctypes code generator, it is part of the ctypeslib package. You will also need GCC_XML. See the ctypes wiki for instructions on how to set it up: http://starship.python.net/crew/theller/wiki/CodeGenerator

When ctypeslib (h2xml and xml2py) and gcc_xml is installed then run:

> python generate_bindings.py

(use –help to display options, you will most probably want to change the include path and possibly the lib path) you have now created a _chipmunk.py file with generated bindings.

Note: If you only want one or two new functions its probably easier to just add them manually to _chipmunk.py. See the ctypes documentation for instructions on how the function definitons/structs/whatever should look like.