Skip to content
This repository has been archived by the owner on Jan 23, 2018. It is now read-only.

Zarthus/irc-games-bot

Repository files navigation

IRC Games Bot

Build Status License Dependency Status Security

GamesBot is a modular IRC bot written on the Cinch IRC framework. GamesBot strives to host a large variety of enjoyable irc games together with your friends. It offers many helper functions to easily design new games, and is easily set up and installed.

Installation

To install you must first install the appropriate gems.

The easiest way to do this is by running bundle install from the root of the directory.

Once the command has completed, copy conf/config.example.yaml to conf/config.yaml and start editing the file with your favourite text editor. Most of the options will be straightforward if you have experience with IRC. If an option confuses you, refer to the docs.

Run rake db:test to see if you have are able to connect to your database. If all is well, you can run rake db:migrate to migrate the database.

Running tests

Once installed and configured, execute bundle exec rspec to run the tests

Environments

Different configuration files can be loaded by executing the file and passing the env argument.

For example:

./bot.rb --env dev

Would attempt to load conf/config.dev.yaml rather than conf/config.yaml

Make additional copies of your configuration if you plan to use different environments.

Running the bot

That's all that is necessary to set up the bot. You can now run it using ./bot.rb or ruby bot.rb.

Documentation

Please refer to the documentation for more elaboration on certain functions.

If you need extra support, see docs/support.

License

The bot is licensed under the MIT license. Refer to the LICENSE

About

The IRC bot hosting games on irc.esper.net#ircgames

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published