Read Me

*******************************************************************************
*******************************************************************************
***       **      *****   **   ***     ***   **   **       ***   ***        ***
***  *******  ***  ****   **   **  ***  **   **   **  *******  *  *****  ******
***  *******  ****  ***   **   **  ***  **   **   **  *******  ********  ******
***       **  *****  **   **   **  ***  **   **   **       ***   ******  ******
***  *******  *****  **   **   **  ***  **   **   **  **********  *****  ******
***  *******  ****  ***   **   **  **   **   **   **  *******  *  *****  ******
***       **       *****      ****    ** **      ***       ***   ******  ******
*******************************************************************************
*******************************************************************************

 This project is released under the GNU General Public License v3.0

 The license can be viewed at http://www.opensource.org/licenses/gpl-3.0.html
 and is also contained in the GPLv3.txt file included with this software.

*******************************************************************************


This software is intended to run accross a network of multiple clients and a
server. Eduquest is developed in Java for the Linux environment.

The MultiServe module runs on the server and all clients are able
to connect to and interact with it.

Quests are specified in xml files. This package includes one quest
(multiserver/quests/Lost in Time [Gr12].xml)


COMPILING EDUQUEST
------------------

EduQuest can be built using Ant:

Make sure that the Ant package is installed on your machine.

$cd path_to_EduQuest/
$ant


CONFIGURATION
-------------

The eduquest.conf file specifies the server ip and port to be used.
Change it as necessary.

The respawn time for items (in milliseconds) can also be set there.


RUNNING EDUQUEST
----------------

to run the server:

$cd multiserve/bin/server
$java EduQuestMultiServe


to run the client:

$cd client/bin/client
$java EchoClient

**note**
 There's currently an error with the generated jar files, so execute the class
 files from the client/bin/client and multiserve/bin/server directories.
 (As described above)
************


To-do
-----

-Fix end of quest sequence
-Fix the build script to create working jar files



Known bugs
----------

-Sometimes a player shows up twice in a room

********************************************************************************