How to Get Started:

Depending on which edition you bought, drag Objective-Chipmunk-iPhone/ or ChipmunkPro-iPhone/ directory into your Xcode project. At that point you should simply be able use #import "ObjectiveChipmunk.h" and go. If you bought the full edition of Chipmunk Pro with autogeometry support, you may also want to import ChipmunkAutoGeometry.h

Where to Go Next:

• Read the Chipmunk Physics manual. ( local | online) It's C API centric, but Chipmunk was programmed in an Object-Oriented style it's very easy to find the corresponding Objective-C API to use.
• Read out the Doxygen API reference: (local | online)
• Get sample code from the Chipmunk downloads page.

Building Chipmunk Pro:

While Objective-Chipmunk comes prebuilt, we also provide the full source code for those that bought the full Chipmunk Pro package. That way if you want to make any modifications or need to debug something you can.

The easiest way to build Objective-Chipmunk is to run the iphonestatic.command script (or macstatic.command) in the root directory (double click in the Finder or run in the Terminal). This will build the iPhone static library will all the optimizations turned on, and build a simulator build with all the debug options turned on. These scripts will build the ChipmunkPro-* directories as well as the Objective-Chipmunk-iPhone directory if you only want vanilla Objective-Chipmunk for some reason.

There is also an Xcode project provided. The iphonestatic.command script actually uses this same project file.

Thank you for supporting Chipmunk's development and happy Chipmunking!