An idling game of epic proportions
JavaScript TypeScript Shell
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
docs
scripts
src Update server.js Jul 11, 2018
test
.editorconfig add dotfiles Jun 23, 2016
.eslintignore
.eslintrc
.gitignore create dist dir Sep 7, 2016
.travis.yml
CHANGELOG.md
LICENSE Update LICENSE Nov 6, 2016
README.md Update README.md Feb 12, 2017
install-assets.js
package-lock.json update docs Jun 20, 2018
package.json Update package.json Feb 2, 2018
tsconfig.json

README.md

IdleLands Build Status bitHound Overall Score

An idling game of epic proportions.

Pre-requisites

  • node 6.x
  • git
  • mongodb
  • redis (if you want to test multi-server capabilities)

Install

  • git clone
  • npm install
  • Create an .env file in the repo root with the key MONGODB_URI set to a URI leading to a local or remote mongodb install (eg: MONGODB_URI=mongodb://localhost:27017/play and if you're using redis, REDIS_URL should be set to where your Redis is setup (eg: REDIS_URL=redis://localhost:6379))

Running

  • npm run start:dev to start the server
  • npm run test:client -- --players <playercount> to test with that many players (up to ~1200)

Making Yourself A Mod

  • mongo
  • db.players.update({ name: "Your Character Name" }, { $set: { isMod: true } })

Possible Errors

  • Errors TypeError: Parameter "url" must be a string, not undefined or ReferenceError: (something about a missing proxy) typically means you have an old version of node (node --version to check)
  • If npm run test (before you PR!) doesn't work, you haven't run npm install
  • Any other errors or problems, feel free to just ask us in either the game chat or irc channel (##idlebot on irc.freenode.net). We're a pretty friendly bunch and more than happy to help get you started.

Tips

  • fork this repo, then clone to your local machine. PRs from your local repo
  • --silent is useful to stop "npm err!"s from filling up your screen
  • node --inspect=9222 whatever.js (e.g. in your package.json) gives you a Chrome url so you can debug/profile/etc to your heart's content. Adding the line debugger; will break at that point in the js code

Other IdleLands Repositories

  • Play The front end code (angular2, phaser.io, bootstrap)
  • Global The global player information site (angular2, phaser.io, bootstrap)
  • Maps Maps (json+png tilemap. Plus npcs, features etc on the maps)
  • Custom-Assets The strings for the game (monsters, vegetables, conversation etc)

Contributing

  • Make sure your code passes npm run test before making a PR.
  • Any help is help. No matter how small you might think it is, it's ALL very welcome! Thank you!