###############################################################################
# Instructions on how to run the JACK-based RACT-GOLD multi-agent system
# developed by the RACT group for the GOLD contest vs the official demo agent.
# (http://www.cs.rmit.edu.au/agents/ract/)
# 
# @author
# Abhijeet Anand 
# (abhijeet [dot] anand [at] student [dot] rmit [dot] edu [dot] au )
# 17 Nov 2009
#
###############################################################################

STEP_1
First you need to download the following files from these locations:
 1. The Game Server 
    (http://www.cs.rmit.edu.au/agents/ract/files/gameserver-GOLD.zip)
 2. The official Demo/Bot Agents 
    (http://www.cs.rmit.edu.au/agents/ract/files/demoAgent-GOLD.zip)
 2. The Jack Agent System 
    (http://www.cs.rmit.edu.au/agents/ract/files/JACKAGT.zip)
 4. The GUI Interface (http://www.cs.rmit.edu.au/agents/ract/files/gui.jar)

STEP_2
Now create a directory '~/game-bin' where you will place all the files needed.
 $ mkdir ~/game-bin

STEP_3
Copy all the downloaded files in this directory, '~/game-bin'
 $ cp /path/to/downloaded/files/*.zip /path/to/downloaded/files/*.jar ~/game-bin
Then change to the ~/game-bin directory
 $ cd ~/game-bin

STEP_4
Once you have all the .zip files in this directory, decompress them using the 
following command in Linux / Unix:
 $ unzip <zip_files>
for each of the compressed (.zip) files

STEP_5
There will be following sub-directories been created inside the '~/game-bin' 
directory after the decompression step
 gameserver-GOLD/
 demoAgent-GOLD/
 JACKAGT/

STEP_6
Now change to the '~/game-bin/JACKAGT/lib/' directory and confirm the following 
files are present there.

 1. climacomm.jar (The communication protocol to the game server)
 2. jackagt.jar (The Jack Agent)
 3. jack.jar (The JACK sub-system, that is, the JACK runtime kernel)
 4. extras.jar (To run the GUI)
 5. gui.jar (The GUI itself)

Initially only the files 1 and 2 will be present in the 
 '~/game-bin/JACKAGT/lib/' directory

Move file 5 from the '~/game-bin' directory to here.
 $ mv ~/game-bin/gui.jar ~/game-bin/JACKAGT/lib/

File 3 can be found on the ailab0N machines (Restricted Access) from the 
 following location, /opt/Agent_Software/lib/jack.jar
 or, from the following web location (Restricted Access)
 http://www.cs.rmit.edu.au/agents/aopd/files/protected/jack.jar

File 4 can be downloaded from here: 
 http://www.cs.rmit.edu.au/agents/aopd/files/system/extras.jar


STEP_7
Once the files are in place you need to run the game server and then connect the 
agents to the server, and then finally start the simulation from the server.

First, we start the server. Change to the following directory
 $ cd ~/game-bin/gameserver-GOLD

Here you can optionally set the ports that the server is going to use to listen 
to the agents and also for its internal RMI use, using the following script
 $ ./setmyports.sh <RMI_Port> <Game_Port>

RMI_Port defaults to 11100
Game_Port defaults to 12300

These can be left at the default values.

Now start the server by calling the following script
 $ ./startServer.sh

The server will start and listen to incoming agent requests

STEP_8
Now start the demo/bot agents and the Jack Agents
This will be needed to be done from a separate shell (since the current shell 
is being used by the game server :-) )

Change to the directory '~/game-bin/demoAgent-GOLD'
 $ cd ~/game-bin/demoAgent-GOLD

Inside the startAgent.sh script confirm that the Agent names are of the format 
'AC07botN' without quotes, where N is a positive integer. This is the username 
of the bot agent. The password will simply be N, where N is a positive integer.

Now start the agents
 $ ./startAgents.sh <game-host> <game-port>

In our case here the <game-host> is localhost and the <game-port> is 12300

STEP_9
This step will start your Jack Agents.

Open another shell and change to the following directory
 $ cd ~/game-bin/JACKAGT

And now run the Jack Agents
 $ ./run-team.sh

STEP_10
This is the final step where the game server finally starts the game simulations
Change to the shell where the game server was running and press the ENTER key 
there.


The simulation will start; after the game is over you can get the simulation svg
files from the output/ directory in the game server.

Enjoy the simulation!

###############################################################################
End of File
###############################################################################