Skip to content

Latest commit

 

History

History
18 lines (13 loc) · 1.12 KB

README.md

File metadata and controls

18 lines (13 loc) · 1.12 KB

chatbot-rb

A plugin-based bot framework in Ruby for Wikia's Special:Chat extension.

Installation

To run a bot using this framework, Ruby 2.0+ is expected. I develop on the latest stable version (2.1.1 at the time of writing), and generally will not accommodate any problems that are only affect older versions of Ruby.

This framework requires HTTParty and mediawiki-gateway. You can install them both with [sudo] gem install httparty mediawiki-gateway.

Running

Please follow the format outlined in main.sample.rb and config.sample.yml to setup a working bot. The Wikia account used to connect to chat will not need bot rights, but if you're using a logging plugin or otherwise editing it will be useful.

Plugins

The plugin system for this bot is heavily inspired by that of Cinch, albeit very watered down and less useful. See the example plugins for ideas on how to make your own.