Pony Town
A game of ponies building a town
Prerequisites
- Node.js (version 9)
- gulp
npm install -g gulp
- MongoDB database
- node-canvas
- ImageMagick (optional, required for generating preview gifs in animation tool)
Installation
Setting up OAuth keys
Get OAuth keys for authentication platform of your choice (github, google, twitter, facebook, vkontakte, patreon)
Configuration
Add config.json
file in root directory with following content. You can use config-template.json
as a starting point for your own config.
Running
Production environment
Giving/removing roles
To setup superadmin role use following command
Admin panel is accessible at <base_url>/admin/
(requires admin or superadmin role to access)
Starting as multiple processes
For these to work on the same URL, paths to game servers and admin server need to be bound to correct ports, using http proxy.
It is recommended to run processes with larger memory pool for large user bases (especially admin and game processes), example:
Beta environment (with dev tools and in-development features)
Running in development
Customization
package.json
- settings for title and description of the websiteassets/images
- logos and team avatarsfavicons
- iconssrc/ts/common/constants.ts
- global settingssrc/ts/server/maps/*
- maps configuration and setupsrc/ts/server/start.ts
- world setupsrc/ts/client/credits
- credits and contributorssrc/style/partials/_variables.scss
- page style configuration
Custom map introduction
src/ts/server/start.ts:35
- adding custom map to the worldsrc/ts/server/map/customMap.ts
- commented introduction to customizing maps