this is a location-based game with pursuit-evasion scenario. More documentation will be available shortly


How to install 

1. Clone the repository.
2. Install RVM! http://rvm.beginrescueend.com/
3. Set your environment to Ruby 1.9: rvm install 1.9.2 && rvm use 1.9.2
4. Install bundler: gem install bundler
5. Install the packages by running this command: bundle install
6. Add database login, socket.io address and port into config.yml 
7. Start the server: bundle exec rackup -s thin -p 49992
8. Point your browser to http://localhost:49992

The game server have to run with a socket.io server
Install node.js. http://nodejs.org/
Install socket.io: npm install socket.io
Install mysql for node.js: npm install mysql
Go to home directory of the game, start socket.io: node main.js 49991 8080


Models

Game - game session 

Team - define the role of players

Player - game players including controller, street runner, and virtual  truck

Dropoffpoints - static entity in the game

For detailed attributes please refer to files in folder “models”




How to implement an agent. 

A easy to way to implement an agent for this game is to write a piece of js code running on node.js.

A template agent and a helper class can be found in folder agent/


This template agent controls a truck player running on a fixed router.

to run this agent
1.install node.js : http://nodejs.org
2.install socket.io client: npm install socket.io-client
3.config server info on top section of agent.js
4.run agent: node agent.js [game_id]


A complete agent api documentation will be available shortly. 


TODO 

1. put initials on icon
2. socketIO need to handle disconnect
3. user logout
3. mainloop inplementation.
	- e.g. tasks only carried by specified players/roles etc.(done) 
	- destination drop off point(new)
4. virtual agent implementation (done)
5. messaging system 
	- add text field in mobile web view