----node.js MMOG framework----
Some general notes:
*** All scripts should be run from the root source directory ***
* Server is linux only
How to install files:
% ./scripts/setup.sh
How to start the database/browser for testing:
% ./scripts/start.sh
How to start the server:
% node server/main.js
How to do unit tests:
% ./scripts/run_tests.sh
Notes on the directory structure:
. - Root directory. Also server javascript files go here.
mongo/ - Generated by setup.sh contains local copy of mongodb.
scripts/ - Administration scripts for deployment, testing and execution
tests/ - Unit test directory
server/ - Server data files
client/ - Client data files
game/ - User game module directory
game/www - Web site information
Cluster Organization:
Browsers* ~~~~> Gateway ~~~~> Instance Servers*
\ /
\ /
v v
Database
Administration Scripts:
Main scripts:
setup.sh - Downloads node, npm, mongodb; installs packages; configures db.
run_tests.sh - Runs the unit tests
start.sh - Starts chrome, gedit and mongodb for testing
Style Conventions:
* camelCase for class names and methods
* use_underscores for member variables
* Spaces instead of tabs
* 2 space indent level
TODO:
Add firefox/opera test script
Add more unit tests
Get an actual hosting service :)
Contributors:
Mikola Lysenko