CS2335 - Final Project - Fall 2003

"Oregon Trail Network Edition" 
(a module for the TrailBlazer Engine)

Team Members:
gtg592a Chris Kelly    ckdake@cc       
gtg804a Jason Fletcher fletch@cc
gtg324a Benjie Donahue palus@cc
gtg303m Chris Sidi     sidi@cc

Testing information:
 
-Our JUnit Tests are explained in the testplan.html
   
-type "ant test" in the otrail directory to run them.

Requirements prior to running the game:
-have the java 2 runtime environment 1.4.2 installed on your machine
 (other version may work, we make no guarantees)
-have write access to the directory you are running the game in,
 otherwise you will not be able to save high scores.
-To play a network game there must be no firewalls between the 
 various players.

Usage Instructions:
-For multiplayer, pick someone to host the game and have them start 
 it. Everyone else then joins.

Known Bugs: 
- sometimes the game locks up for no reason. the screen becomes 
        unresponsive and the process has to be killed.  we don't
        know why this happens and cannot reproduce it with any
        regularity.
- The game quits when you cancel once the server has been started.
        We couldn't figure out how to stop the server to free up the
        port, so we simply quit the game to keep bad things from
        happening.

Features that may be extra credit:
-auto discovery of games on the same subnet (unimplemented yet)
-game engine with the actual games as modules (only partially implemented)
-editor for modifying game data files (unimplemented so far)
-message system for players to send messages to each other 
        (not implemented yet)

Features to Add:
O/S(s) Developed/Tested under:
-Gentoo Linux 1.4 (server: compilation/cvs/testing)
                  (chrisk: development/testing)
-Redhat Linux 9.0 (jason:  development/testing)
-Mac OSX 10.3     (chrisk: development/testing)
-Windows XP       (jason:  testing)
                  (chriss: development) 

Comments:
-to use ant you must have the following:
    -the JAVA_HOME envoronment variable defined to be the location of you
     java installation
    -ant must be in your path
-and for everything to work perfectly you need to be on a machine in the
 coc using linux because the checkstyle and pmd library locations are
 hardcoded into the build.xml file

-CHECKSTYLE/PMD ERRORS WE COULD NOT FIX that the TAs cleared as ok:
     -src/OUtils.java:0: Got an exception - java.lang.NullPointerException
      the file is there, we don't know what its deal is. *shrug*


-the default ant task does everything, cleans, compiles, jar,
 pmd, checkstyle, javadoc, and then runs the compiled classes
-ant jar will generate a self-contained jar files:
    trailblazer.jar - the game engine and all datafiles

