#
# zc-reader
# 
# A python-based ZeldaClassic .qsu file reader
#
# Author:	John Berry (john -at- ulfmagnet -dot- com)
# Version:	0.1 
# Date:		09/08/2006
#
#

0. ACKNOWLEDGMENTS

Thanks to Mike Melanson, whose work on reverse engineering the
ZeldaClassic quest file format was essential to this project.

1. REQUIREMENTS

* Python 2.2 or greater (tested on 2.4)
* Python Image Library (PIL) package, v1.1.3 or greater 
  (available at http://www.pythonware.com/products/pil/index.htm)
* Numerical Python package, version 24.2
  (see http://numpy.scipy.org/#older_array - note zc-reader requires
   the Numeric package, not the newer NumPy package)

2. INSTALLATION

No special installation should be required, provided that you have a
working Python environment with the Numpy and PIL packages installed.
To check to see whether this is the case, enter the following from
within your python shell (accessible by typing 'python' from the
command line):

>>> import Numeric
>>> import Image
>>> import ImageEnhance

If no 'ImportError' messages appear, your Python environment should be
ready to go.

3. RUNNING

You can run the tool by typing 'python extract.py' from the command
line, providing the name of the .qsu file you wish to parse.  

Options:
   -l   Selects the level number of the map you wish to work with (default: 1)
   -m   Write PNG of overall level map to 'maps' directory (default: FALSE)
   -b   Set brightness correction factor for image output (default: 2.0)
   -c   Set color correction factor for image output (default: 1.5)
   -h   Displays this help message

4. EXAMPLES

A sample .qsu file for the "classic" Zelda game is provided in the
quests directory.  To generate the tiles and map for level 1 of this
quest, you could enter the following from the command line:

   python extract.py --level 1 -m quests/1st.qsu