Read Me

This is the README file of the csMonopoly project.

Code so far:
-------------
Monopoly.py -- The main game file, so far it only contains testing code for manipulating CS via
               the python binding.

mapEditor.py -- The map editor, it's actually a Jython script and it uses a lot of java
                libraries. The map editor is functional, meaning that you can create, load
                and save maps. However, its windowing functions are not completed, so you
                are gonna have to kill it if you want to exist.


Map.py -- The module in which all the road types are defined.


-------------

Data so far:

The Data directoy so far is oragnised as follows:

Data/
     Characters/
                00/
                   config -- Contains the configurations of the model for the character
                   <model_file> -- Should be a CS library file
                   <model_skeleton> -- Should be a CS skeleton file
                   <images> -- whatever images needed for this model

     Maps/
          00/
             config -- Contains the configurations of the model for the character
             <model_file> -- Should be a CS genmesh file
             <image> -- the image for the model of the map
             <map_file> -- The Python pickled file that contains info about the map

     Tools/

     Cards/


-------------

Requirements:

You need to have crystal space (CS) installed on your computer *WITH* the python
binding. The python binding consists of 4 files:

cspace.py -- The main python interface
_cspace.so -- The CS shared library compiled with python binding
pycscegui.py -- The python interface for CS's CEGUI.
_pycscegui.so -- The CS CEGUI shared library compiled with python binding
            
All 4 files have to be installed in PYTHON_PATH.

Additionally, if you wish to run the map editor, you need jdk1.5 or above
and Jython 2.2 or above.

If you wish to add models into csmonopoly, you may also need b2cs
(blender2CrystalSpace).


-------------

What you can do now:

Suppose that you have all the requirements met, you can run the Monopoly.py
by:

python Monopoly.py

This should show a partial map, with a strange looking character standing
on the road. You can get it to advance squares by the number buttons.  The
camera will track the movement of this character. You can use the c button
to "develop" the plots you are at, or use the d button to downgrade them.
You can also use the i button to make the character go to a plot, or use
the o button to make the character move from the plot back to the road.