jr-garcia / cybullet Goto Github PK

About
=====
CyBullet is a Python binding of the Bullet Physics library, based on the original PyBullet from:
https://launchpad.net/pybullet

Build
=====
Building CyBullet requires Cython and Bullet Physics headers and libraries. If these are
in the default search path on your platform, then a simple distutils build
command should succeed:

    $ python setup.py build

If they are elsewhere, you can specify their location with the --include-dirs
and --library-dirs command line options:

    $ python setup.py build_ext --include-dirs /path/to/includes \
                                --library-dirs /path/to/libraries

Install
=======
You can install CyBullet using the normal distutils install command:

    $ python setup.py install

Documentation
=============
To learn how to use CyBullet, there are several resources available:

  - The Python API documentation for the bullet package
  - The programs in the CyBullet demos/ directory

CyBullet attempts to be a very thin wrapper around the Bullet Physics C++ API.
This means that much of the Bullet Physics documentation is useful in learning
and understanding CyBullet:

  - The Bullet Physics API documentation:
      http://bulletphysics.com/Bullet/BulletFull/

  - The Bullet Physics User Manual:
      http://bulletphysics.com/ftp/pub/test/physics/Bullet_User_Manual.pdf

Bugs
====
Please report bugs at https://github.com/jr-garcia/CyBullet

License
=====
Zlib license.