Game of Farms is an HTML5 game where the player have to manage a virtual farm through educational scenarios. It's written with the following Javascript stack:
- Cocos Creator for the WebGL/Canvas front-end
- NodeJS / HapiJS / MongoDB for the back-end
Some libraries dependencies:
- mongoose
- handlebars
- ...
Tools:
- Tiled
- TexturePacker
You can see how it works on https://game-of-farms.ekylibre.com
Pre-requisites:
- NodeJS 6.11.x
- NPM 3.10.10
- MongoDB 3.4.x
- Cocos Creator 1.6.1
First things you need to do to get ready:
- Clone the project
- cd to server/src/
- Install needed packages:
npm install - Edit the config files in server/src/config to setup your project (more info here)
- populate your db (you need to have granted access to google sheets & drive):
nodejs cli/workflow.js -c "mongodb://localhost:27017/gof" -px - start server:
NODE_ENV=[development|production] nodejs server.js - alternatively you could use pm2 to start the server with:
pm2 start gof.json --env=[development|production]
You need to have at least one configuration file named like your current environment (development.json for development environment...), for obvious security reasons you should not push it to github
{
"Server" : {
"connectionOptions" : {
"port" : 3000
}
},
"Database" : {
"connectionUrl" : "mongodb://yourip:yourport/yourdatabase",
"options" : {
"useMongoClient" : true
}
},
"Jwt" : {
"key": "your JWT key"
},
"Nodemailer" : {
"transport" : {
"service": "Gmail",
"auth": {
"user": "youremail@example.com",
"pass": "yourpassword"
}
}
}
}
Your Nodemailer config may be different, please check Nodemailer website on how to configure transport
To generate a new JWT secret key:
node -e "console.log(require('crypto').randomBytes(32).toString('hex'));"
You could copy/paste the sample.json as a starting point
Game of Farms is released under the GNU/AGPLv3 license.