### Navigation

- index
- modules |
- next |
- previous |
- pymunk 3.0.0 documentation »

# Examples

Here you will find a list of the included examples. Each example have a short description and a screenshot (if applicable).

To run the examples yourself either install pymunk or run it using the convenience run.py script.

Given that pymunk is installed where your python will find it:

    >cd examples
    >python breakout.py

To run directly without installing anything. From the pymunk source folder:

    >cd examples
    >python run.py breakout.py

Each example contains something unique. Not all of the examples use the same style. For example, some use the pymunk.pygame_util module to draw stuff, others contain the actual drawing code themselfs. However, each example is self contained. Except for external libraries (such as pygame) and pymunk each example can be run directly to make it easy to read the code and understand what happens even if it means that some code is repeated for each example.

Example files

- arrows.py
- balls_and_lines.py
- basic_test.py
- bouncing_balls.py
- box2d_pyramid.py
- box2d_vertical_stack.py
- breakout.py
- contact_and_no_flipy.py
- contact_with_friction.py
- flipper.py
- newtons_cradle.py
- no_debug.py
- platformer.py
- playground.py
- point_query.py
- polygon_triangulation.py
- py2exe_setup__basic_test.py
- py2exe_setup__breakout.py
- pygame_util_demo.py
- run.py
- slide_and_pinjoint.py
- using_sprites.py

## arrows.py

Location: examples/arrows.py

Showcase of flying arrows that can stick to objects in a somewhat realistic looking way.

## balls_and_lines.py

Location: examples/balls_and_lines.py

This example lets you dynamically create static walls and dynamic balls

## basic_test.py

Location: examples/basic_test.py

Very simple example that does not depend on any third party library such as pygame or pyglet like the other examples.

## bouncing_balls.py

Location: examples/bouncing_balls.py

This example spawns (bouncing) balls randomly on a L-shape constructed of two segment shapes. Not interactive.

## box2d_pyramid.py

Location: examples/box2d_pyramid.py

Remake of the pyramid demo from the box2d testbed.

## box2d_vertical_stack.py

Location: examples/box2d_vertical_stack.py

Remake of the veritcal stack demo from the box2d testbed.

## breakout.py

Location: examples/breakout.py

Very simple breakout clone. A circle shape serves as the paddle, then breakable bricks constructed of Poly-shapes.

The code showcases severaly pymunk concepts such as elasitcity, impulses, constant object speed, joints, collision handlers and post step callbacks.

## contact_and_no_flipy.py

Location: examples/contact_and_no_flipy.py

This example spawns (bouncing) balls randomly on a L-shape constructed of two segment shapes. For each collision it draws a red circle with size depending on collision strength. Not interactive.

## contact_with_friction.py

Location: examples/contact_with_friction.py

This example spawns (bouncing) balls randomly on a L-shape constructed of two segment shapes. Displays collsion strength and rotating balls thanks to friction. Not interactive.

## flipper.py

Location: examples/flipper.py

A very basic flipper game.

## newtons_cradle.py

Location: examples/newtons_cradle.py

A screensaver version of Newton’s Cradle with an interactive mode.

## no_debug.py

Location: examples/no_debug.py

Very simple showcase of how to run pymunk with debug mode off

## platformer.py

Location: examples/platformer.py

Showcase of a very basic 2d platformer

The red girl sprite is taken from Sithjester’s RMXP Resources: http://untamed.wild-refuge.net/rmxpresources.php?characters

Note

The code of this example is a bit messy. If you adapt this to your own code you might want to structure it a bit differently.

## playground.py

Location: examples/playground.py

A basic playground. Most interesting function is draw a shape, basically move the mouse as you want and pymunk will approximate a Poly shape from the drawing.

## point_query.py

Location: examples/point_query.py

This example showcase point queries by highlighting the shape under the mouse pointer.

## polygon_triangulation.py

Location: examples/polygon_triangulation.py

Quick demo of using triangulate.py to triangulate/convexise(?) a concave polygon. Not good code as such, but functional and cheap

display: thick red line: drawn polygon medium blue lines: triangles after triangulation thin white lines: convex polygons after convexisation(?)

input: click points (in clockwise order)* to draw a polygon press space to reset

- triangulate() and convexise() actually work on anticlockwise polys to match pymunk, but this demo’s coords are upside-down compared to pymunk (pygame style), so click clockwise to compensate :)

## py2exe_setup__basic_test.py

Location: examples/py2exe_setup__basic_test.py

Simple example of py2exe to create a exe of the basic_test example.

## py2exe_setup__breakout.py

Location: examples/py2exe_setup__breakout.py

Example script to create a exe of the breakout example using py2exe.

## pygame_util_demo.py

Location: examples/pygame_util_demo.py

Showcase what the output of pymunk.pygame_util draw methods will look like

## run.py

Location: examples/run.py

Use to run examples using pymunk located one folder level up. Useful if you have the whole pymunk source tree and want to run the examples in a quick and dirty way.

For example, to run the breakout demo:

    > cd examples
    > python run.py breakout.py

## slide_and_pinjoint.py

Location: examples/slide_and_pinjoint.py

A L shape attached with a joint and constrained to not tip over.

## using_sprites.py

Location: examples/using_sprites.py

Very basic example of using a sprite image to draw a shape more similar how you would do it in a real game instead of the simple line drawings used by the other examples.

### Navigation

- index
- modules |
- next |
- previous |
- pymunk 3.0.0 documentation »