Pygris Release 3 Readme

Contents
--------

1. Introduction
2. Acknowledgements
3. Requirements
4. About Pygris
5. How to Play
6. History
7. Links


1. Introduction
---------------

This is the readme for Pygris release 3, 31 May 2001. Pygris is available from
http://www21.brinkster.com/coonsta/pygris/index.html . I, Dominic Cooney, am the
author and can be contacted via email. My email address is
coonsta@ozemail.com.au .


2. Acknowledgements
-------------------

I would like to thank the many authors of Python, pygame and SDL. Don't let your
view of their fine work be discoloured by my clumsy use of it (hey-- I'm
learning!) Pygris is also heavily based on the Aliens example that comes with
pygame.


3. Requirements
---------------

To install Pygris, simply unpack the distribution, preserving the directory
structure. Note that you must run Pygris from the pygris directory so it can
find its data files. 

Pygris requires Python and pygame. To play in full screen mode, your video card
or X server will have to support 320*240 pixel high- or true-colour mode. For
music, you must install Timidity (see Links below.) A joystick is recommended
but not required.

If you are playing Pygris from the source and want to play in a tiny window,
instead of full screen, edit pygris.py and put a # before the | FULLSCREEN near
the top of the program.


4. About Pygris
---------------

Pygris is an implementation of the classic "falling block puzzle" game. It is
implemented in about 600 lines of Python. For more information, see
http://www21.brinkster.com/coonsta/pygris/index.html .


5. How to Play
--------------

Run Pygris. How you do this will vary from system to system. Typically it will
involve changing to the pygris directory that you unpacked from the distribution
archive and typing:

    python pygris.py

Windows users can run the pygris.exe application.

Press space on the title screen to view the instructions. Press space again to
start the game.

Blocks fall from the top of the screen. You can move them left or right, or
rotate them. By stacking the blocks as they fall into complete lines, you score
points. More points are awarded for finishing a set of lines together:

    # Lines  Points
    ---------------
         1       1
         2       3
         3       9
         4*     27    * A "pygris"

After a certain number of lines, your level will increase and so too will the
speed the blocks fall.

If your stack of blocks reaches the top of the screen, the game ends. You can
end the game prematurely by pressing ESC. Press ESC again at the title screen to
quit.  


6. History
----------

Release 3 Changes, 31 May 2001

 The third release in three days to fix problems! You know the maxim--
 "Release early, release often:"

 - Sped up the blocks initial rate of fall.

 - Increased the change to the rate of fall when you go up a level.

 - Changed all the (large) background PNGs to JPGs to reduce the size of the
   archive.

 - Changed the drawing of "next block" to be centered in the next block area.
   This looks much better (previously it was drawn in the top-left or bottom-
   right hand corner.)

Release 2 Changes, 30 May 2001

 - Implemented drop button and key repeating in response to user suggestions.
 
 - Changed title screen artwork to include a pygame logo, and a "press start"
   message. Some people didn't know what to press to start the game.
	 
 - Redrew the instruction screen to show joystick controls, new drop buttons and
   use new Pygris logo.
	 
 - Changed scoring system. Lines are worth 3^(nlines-1) points.
 
 - Added levels. Your level increases after every 2^(5+current_level) lines.
   After each increase, blocks take a little less time to fall. Also, a new
   sound is played.
	 
 - Added level and lines to the in-game display.
 
 - After a "game over" your score is drawn on top of the game over message, so
   you can see what you scored.
	 
 - Added more backgrounds.
 
 - Fixed the kerning on the digit graphics (previously they were monospaced.) 


7. Links
--------

pygame   http://www.pygame.org/
Python   http://www.python.org/
SDL      http://www.libsdl.org/
Timidity http://www.libsdl.org/projects/SDL_mixer/timidity/timidity.tar.gz

