README for PyRunner 0.1 - June 16th, 2001
=======================

PyRunner is a Lode Runner clone written in Python using the pygame toolkit.  It
is currently distributed in source-only form and assumes you already have
Python, pygame, and SDL (used by pygame) installed and operational.  If you can
run any of the pygame demo programs, you should be able to run PyRunner.

This is a beta version of PyRunner.  It is completely playable but doesn't have
all of the niceties of a full-blown game.  For example, there is no smooth
transition when moving between squares, and there is no sound.  There may also
be some bugs lurking.  Lastly, there is no standalone distribution (i.e. one
for those who don't have Python or pygame installed).  This means that if you
aren't somebody interested in game programming using pygame but still want to
play PyRunner, you will have to obtain and install Python, pygame, and SDL to
do so.  (Whether you are actually willing to do this or not depends on just how
much of a fan of Lode Runner clones you are!)

PyRunner is an experimental project designed so its author could evaluate
pygame for future use in larger projects.  (The best way to learn a new
language or toolkit is to write a small but useful project with it.)  As such,
it is most useful (in the author's opinion) as a teaching program for pygame.
PyRunner is the kind of game that's easy to experiment with.  You can make
minor changes (like tweaking the AI or changing the game speed) with ease, and
it's also not too hard to add totally new features.  The source code is
well documented and is geared towards those learning pygame and game
programming in general.  NOTE:  If you're going to be modifying the source,
be sure to read the small Source Notes section at the start of pyrunner.py
first.

That being said, PyRunner (like Lode Runner before it) is also very addictive
to play!

PyRunner is currently distributed in source only.  It does not need to be built
or installed; simply unpack all the files into a convenient location (if you
have not already doen so) and run the pyrunner.py script to play.

If you've never played a Lode Runner-type game before, read the file called
howtoplay.txt which will tell you the controls and what everything on the
screen is.  PyRunner is an easy game and you should pick it up in no time.

PyRunner allows you to design levels by editing simple text files.  (There is
no visual editor (yet)).  If you'd like to do this, read the file editing.txt
for a description of the symbols along with some guidelines for effective level
design.

PyRunner is distributed under the GNU General Public License (GPL).  For more
information, see the file COPYING.

Send questions, comments, suggestions to:
    Paul Sidorsky <paulsid@home.com>

For news, updates, new levels, etc. visit the PyRunner web site at:
    http://members.home.net/paulsid/pyrunner/

Quick Start
-----------

    Here's the most critical information for those who hate reading manuals:

Command Line:  python pyrunner.py [<gamefile>]

    <gamefile> defaults to pyrunner.gam if omitted.

Name Entry:  Only unshifted symbols are displayed.  Letters will be all caps.

Keys:       Arrows - Move runner
            Left Ctrl - Dig left / Flip switch on left
            Left Alt - Dig right / Flip switch on right
            P - Pause the game (press again to resume)
            R - Restart if you get trapped
            Esc - End game, go to high scores

Map Options:  Displayed as four letters on the right side of the status bar.
              Letters are omitted for disabled options.

            H - World wraps around horizontally.
            V - World wraps around vertically.
            T - Map can be exited by reaching the top of the screen.
            F - One-way gates flip when all stages are complete.
-- End of file:  README --
