HTTPS SSH
WHAT'S NEW IN 2.0.0
===================
  * Greatly optimized SpatialHash (thanks, DR0ID :))
  * New and improved HUD (hudlight, with fancy fonts and themes: thanks, Cosmologican and DR0ID :))
  * Removed old unused/unsupported stuff: PGU, world editor, and a few demos.

WHAT'S IN THE DISTRIBUTION
==========================

data/
  The game resource directory. The data module knows how to look files up in
  here.

docs/
  * Gummworld2 HTML docs produced by pydoc.
  * A third_party/ subdirectory containing licenses and other readmes for
    third-party components included with Gummworld2.

examples/
  Demonstrations of some of what's possible with Gummworld2:
  * Scrolling maps
  * Supermaps: autoloading and unloading maps too big to fit in memory
  * Tiled maps
  * Custom maps: world editor included--req. Python 2.6 or 2.7
  * Parallax layers
  * Collapsing and reducing map layers to boost performance
  * SpatialHash exercisers
  * Geometry collisions: any line or polygon versus any other
  * Views (subsurfaces)
  * HUDs
  * Renderer: newest feature; super fast, multilayer, high tile count rendering

gamelib/
  Subdirectories:
  * gummworld2/, the map scrolling library for use in games
  * tiledtmxloader/, an orthogonal Tiled map loader

make_docs, pydoc
  The script used to create the HTML docs, and to start the pydoc viewer web
  service.

paths.py*
  Convenient module for run-time configuration of library path.


WHAT'S NOT IN THE DISTRIBUTION
==============================
  You may want to get these. Look in downloads on the repo.
  * gummworld2_tmw_2: maps and images from The Mana World, needed for demos 07 and 16. It's worth it.
  * gw2_skeleton: a full skeleton with intro, main menu, game, and credits.
  * imagecache: a cache for all your images, with aging, memory cap, and stats.
  * Xbox-360-Controller-for-pygame: pygamey wrapper for the Windows controller library.


USING GUMMWORLD2
================

See the docs/ directory of the distribution for the HTML version of library
docstrings. There is a convenience pydoc script in the base directory that can
be used to start a PyDoc server.

There are many simple examples in the examples/ directory.

See gamelib/gummworl2/toolkit.py for examples of how to work directly with
classes like BasicMap, BasicLayer, Camera, HUD, etc.


REQUESTING HELP AND IMPROVEMENTS
================================

Enhancement requests and bug reports may be submitted at the project site
https://bitbucket.org/gummbum/gummworld2.

Gummbum can usually be found in IRC #pygame at freenode.net. Come say hello.