Shintolin

A node.js port of Isaac Lewis' Ruby version of Shintolin - a persistent multiplayer browser game, set in the stone age.

Local Development / Testing

Initial Setup (Mac OSX)

Install homebrew: $ ruby -e "$(curl -fsSkL raw.github.com/mxcl/homebrew/go)"
Install node.js: $ brew install node
Install mongodb: $ brew install mongo
Download the code via git: $ git clone https://github.com/shintolin/shintolin

Running the Game

Go into the Shintolin directory: $ cd shintolin
Get latest code from git: $ git pull
Install dependencies via npm: $ npm install
Create a separate Terminal tab (CMD+T) and run mongodb: $ mongod
In the original tab, run some bootstrap scripts: $ bin/dev/bootstrap
Finally, run Shintolin: $ npm start
Browse to http://localhost:3000 in your web browser to play. You can log in as "Ecce" using the password "password".

Deploying to Heroku

Create an account on Heroku.com
Install the Heroku Toolbelt
From the Shintolin directory, create a new Heroku app: $ heroku create
Add the MongoLab add-on: $ heroku addons:add mongolab
Add the Heroku Scheduler add-on: $ heroku addons:add scheduler:standard
Open the Heroku Scheduler configuration screen: $ heroku addons:open scheduler
- Add an hourly task that runs at :00, pointing to: $ ./bin/tick_ap/_tick
- Add a daily task that runs at 00:00, pointing to: $ ./bin/tick_day/_tick
- Add three more daily tasks that run at 00:00, 08:00, and 16:00 - each pointing to: $ ./bin/tick_hunger/_tick
Turn on production mode: heroku config:add NODE_ENV=production
Use a safe session secret: heroku config:add SESSION_SECRET=<YOUR_SECRET_HERE>
Push your code to Heroku: git push heroku master
Start your free instance: heroku ps:scale web=1
Log in to your game: heroku open

License

This program is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more details.