kevans91 / IdleLands

An idling game set in the realm of IRC. It has a modular backend that can be added to any existing frontend (if the frontend uses node).

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Idle Lands

An incremental game (read: idling) where you do nothing while your character fights to be the best in the realm.

It can be run with a backend of IRC, or a console, or really just about anything you plug into it. I'm sure it'd be pretty cool if you hooked it up to a MeteorJS backend (I did this for the web view)! Currently, I use it as a module for my IRC bot, Kurea -- nothing special.

Developing

Want to help develop Idle Lands? Great! Testing is super easy, as you can do it right in your console (or, go the more painful route and test it in IRC)!

Here are the prerequisites:

  • MongoDB, Git, and npm
  • coffee-script (npm install -g coffee-script)
  • grunt (npm install -g grunt-cli)

Then do:

git clone https://github.com/seiyria/IdleLands.git
npm install
npm start

##Important## While writing code, make sure it passes coffeelint -- the easy shortcut for this is grunt dev.

##Another Note## Feel free to join us in irc.esper.net ##idlebot and chat with the devs and designers!

Adding Content

Want to add content such as Classes, Personalities, Spells, or anything like that? Check out the wiki for all of the existing documentation on events and functions available.

#Debugging#

While running LocalTest.coffee, you may press [ENTER] to enter an interactive session. This will pause the execution and allow you to execute code. By calling getWrapper(), you will be able to access the IdleGameWrapper object. You can get a direct hold on the current game instance with inst() and a reference to the API object with api().

###Examples### ####Change a player's gold####

inst().playerManager.getPlayerByName('Danret').addGold(100)

####Force a battle to start####

api().game.doGlobalEvent('battle')     # PvP battle
api().game.doEvent('Danret', 'battle') # monster battle
> A battle is raging...

####Cause any event to happen####

api().game.doEvent('Danret', 'enchant')
api().game.doEvent('Danret', 'blessItem')

About

An idling game set in the realm of IRC. It has a modular backend that can be added to any existing frontend (if the frontend uses node).

License:MIT License