https://github.com/troygoode/shintolin
A persistent multiplayer browser game, set in the stone age.
https://github.com/troygoode/shintolin
Last synced: about 1 month ago
JSON representation
A persistent multiplayer browser game, set in the stone age.
- Host: GitHub
- URL: https://github.com/troygoode/shintolin
- Owner: troygoode
- License: agpl-3.0
- Created: 2013-01-13T21:15:07.000Z (over 12 years ago)
- Default Branch: master
- Last Pushed: 2022-12-10T17:34:09.000Z (over 2 years ago)
- Last Synced: 2025-04-15T02:07:40.240Z (about 1 month ago)
- Language: CoffeeScript
- Homepage: http://www.shintolin.com
- Size: 3.2 MB
- Stars: 4
- Watchers: 0
- Forks: 3
- Open Issues: 17
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Security: SECURITY.md
Awesome Lists containing this project
README
# Shintolin
A node.js port of [Isaac Lewis' Ruby version of Shintolin](https://github.com/IsaacLewis/Shintolin) - a persistent multiplayer browser game, set in the stone age.
## Running Locally (Docker Compose)
* Download the code via [git](http://git-scm.com/): `git clone https://github.com/troygoode/shintolin`
* Install [docker](https://www.docker.com/)
```bash
# 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](http://heroku.com/)
* Install the [Heroku Toolbelt](https://toolbelt.heroku.com/)
* From the Shintolin directory, create a new Heroku app: `$ heroku create`
* Add the [MongoLab add-on](https://addons.heroku.com/mongolab): `$ heroku addons:add mongolab`
* Add the [Heroku Scheduler add-on](https://addons.heroku.com/scheduler): `$ 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=`
* 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/).