Shintolin

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

Running Locally (Docker Compose)

• Download the code via git: git clone https://github.com/troygoode/shintolin
• Install docker

# on host
docker-compose up shintolin3-mongo # start mongo in background
docker-compose run shintolin3-mongo bash # bash into mongo server

# TODO: describe how to bootstrap new database

# within mongo container
DIR=/host/... # tab complete the path to the Heroku mongo backup
mongorestore --db heroku_8xb5fctf $DIR
exit

# back on host
npm install
npm start

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

Shintolin: a persistent multiplayer browser game, set in the stone age. Copyright (C) 2013 Troy Goode

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.

You should have received a copy of the GNU Affero General Public License along with this program. If not, see http://www.gnu.org/licenses/.