Pygame Documentation

pygame documentation

|| Pygame Home || Help Contents || Reference Index ||

Cdrom || Color || Cursors || Display || Draw || Event || Examples || Font || Gfxdraw || Image || Joystick || Key || Locals || Mask || Mixer || Mouse || Movie || Music || Overlay || Pygame || Pixelarray || Rect || Scrap || Sndarray || Sprite || Surface || Surfarray || Tests || Time || Transform

Documents

Readme: Basic information about Pygame, what it is, who is involved, and and where to find it.
Install: Steps needed to compile Pygame on several platforms. Also help on finding and installing prebuilt binaries for your systems.
LGPL License: This is the license Pygame is distributed under. It provides for Pygame to be distributed with open source and commercial software. Generally, if Pygame is not changed, it can be used with any type of program.

Tutorials

Introduction to Pygame: An introduction to the basics of Pygame. This is written for users of Python and appeared in volume two of the Py magazine.
Import and Initialize: The beginning steps on importing and initializing Pygame. The Pygame package is made of several modules. Some modules are not included on all platforms.
How do I move an Image?: A basic tutorial that covers the concepts behind 2D computer animation. Information about drawing and clearing objects to make them appear animated.
Chimp Tutorial, Line by Line: The pygame examples includes a simple program with an interactive fist and a monkey. This was insprired by the annoying flash banner of the early 2000's. This tutorial examines every line of code used in the example.
Sprite Module Introduction: Pygame includes a higher level sprite module to help organize games. The sprite module includes several classes that help manage details found in almost all game types. The Sprite classes are a bit more advanced than the regular Pygame modules, and need more understanding to be properly used.
Surfarray Introduction: Pygame uses the Numeric python module to allow efficient per pixel effects on images. Using the surface arrays is an advanced feature that allows custom effects and filters. This also examines some of the simple effects from the Pygame example, arraydemo.py.
Camera Module Introduction: Pygame, as of 1.9, has a camera module that allows you to capture images, watch live streams, and do some basic computer vision. This tutorial covers those use cases.
Newbie Guide: A list of thirteen helpful tips for people to get comfortable using Pygame.
Making Games Tutorial: A larger tutorial that covers the bigger topics needed to create an entire game.

Reference

Index: A list of all functions, classes, and methods in the Pygame package.
Cdrom: How to access and control the CD audio devices.
Color: Color representation.
Cursors: Loading and compiling cursor images.
Display: Configuring the display surface.
Draw: Drawing simple shapes like lines and ellipses to surfaces.
Event: Manage the incoming events from various input devices and the windowing platform.
Examples: Various programs demonstrating the use of individual pygame modules.
Font: Loading and rendering Truetype fonts.
Gfxdraw: Anti-aliasing draw functions.
Image: Loading, saving, and transferring of surfaces.
Joystick: Manage the joystick devices.
Key: Manage the keyboard device.
Locals: Pygame constants.
Mixer: Load and play sounds.
Mouse: Manage the mouse device and display.
Movie: Video playback from MPEG movies.
Music: Play streaming music tracks.
Overlay: Access advanced video overlays
Pygame: Top level functions to manage Pygame.
PixelArray: Manipulate image pixel data.
Rect: Flexible container for a rectangle.
Scrap: Native clipboard access.
Sndarray: Manipulate sound sample data.
Sprite: Higher level objects to represent game images.
Surface: Objects for images and the screen.
Surfarray: Manipulate image pixel data.
Tests: Test Pygame.
Time: Manage timing and framerate.
Transform: Resize and move images.