README.txt

PyMahjong is a Mahjong-esque game written in Python (2.7) using PyGame (latest, as of 5/17/2011).

To run the game simply point python at run_game.py or run_game.pyw.

Currently, there is support for high-scores but no way to enter your name through the interface. At the time being use --player_name [name] at the command line to specify who will be playing.

Currently, there is support for toggling music on/off but no way to do this in game. To disable music use --nosound at the command line.

To run the level editor use --editor [filename] at the command line. If the filename does not exist it will be created in levels/. 

While in the editor, you can press 's' to save and 'u' to remove your previously placed tile. Left click to place tiles. Tiles should stack pretty intuitively and will snap to a grid. Lastly, while in the editor you may use keys 1-9 to change your cursor and tile placed. Currently, this does not affect the tile in the game (which are random), but can be used to help you keep track of z-levels while in the editor.

TODO as of 5/26/2011:
	Implement a method for users to input their name in-game.
	Design/Implement settings window
		Allow resolution changes / full-screen toggle. This is a pretty complex one as it involves a lot of re-working.
		Allow sound toggle on/off and possibly volume control.
		Enable 'download levels from web'
	Speaking of, enable level downloads from the web.


LICENSE
  All code is free to distribute/modify, but may not be used commercially. I ask you credit me if you decide to use it for something, but am not holding you at knife point :).
  Font is 'Chocolate Box' by Paul Loyd Fonts (http://moorstation.org/typoasis/designers/lloyd/), permission to use is pending, couldn't find license on their site.
  All graphics done by me and are free to use.
  All sound effects generated with AS3FXR: http://www.superflashbros.net/as3sfxr/ 
  Music (Wish4U) attributed to L-Tron: https://8bc.org/members/L-tron/