/cinch-tyrant

Cinch plugins for War Metal Tyrant

Primary LanguageRubyApache License 2.0Apache-2.0

Cinch-Tyrant

Description

This is a Cinch plugin to enable your IRC bot to provide information about War Metal Tyrant by Synapse Games.

Dependencies

  • Cinch (IRC framework)
  • tyrant (Communication with Tyrant servers)

Testing Dependencies

Install

  • Install the above dependencies: gem install cinch and gem install tyrant.
  • Build cinch-tyrant: gem build cinch-tyrant.gemspec
  • Install cinch-tyrant: gem install cinch-tyrant
  • Rename the example files bot.example.rb, bot-config.example.rb, and settings.example.rb by removing the .example portion: rename .example.rb .rb *.example.rb
  • Edit all settings in settings.rb, and add any Players necessary.
  • Edit all settings in bot-config.rb, add any Factions necessary, and add any desired plugins to BOT_PLUGINS.
  • You should not need to edit bot.rb after renaming it unless you have special needs with Cinch.
  • Run it! ruby bot.rb

Development

Send a pull request. All pull requests must pass the tests (rspec). New features should be accompanied with appropriate tests. Filling in missing tests for existing features will also be appreciated.