irwick

irwick aims to allow ruby developers the freedom to create features for irc bots via plugins without having to worry about server connections, channel management and message sending.

The irwick and irc_tools projects aim to make creating, reading and sending messages simple. Hopefully more helper classes will be added over time.

Installation

• Clone project
• Add plugins
• gem build irwick.gemspec
• Install where needed

Configuration

Change the config to suit your needs.

Minimum config required:

{
  "nick_name": "my_nick",
  "user_name": "my_name",
  "real_name": "My Real Name",
  "host_name": 8,
  "server_name": "*",
  "pass": "*",
  "owner": "ownernick",
  "command_key": "p455w0rdZ",
  "remote_servers": [
    {
      "server_ref": "freenode",
      "server_address": "holmes.freenode.net",
      "port": 6667,
      "plugins": [
        "ToolsPlugin",
        "ControlPlugin",
        "ConsoleLoggerPlugin"
      ],
      "channels": [
        "#irwick",
        "#irwick_testing"
      ]
    }
  ]
}

Add more servers and channels as required.

Add your own plugin

Create a plugin in lib/irwick/plugins

# my_plugin.rb
class MyPlugin < IrcPlugin
  def initialize(options = {})
    @options = options
  end
end

Write methods for each message type your plugin wants to respond to: Check plugins folder for examples

# my_plugin.rb
class MyPlugin < IrcPlugin
  def initialize(options = {})
    @options = options
  end

  def on_privmsg_messages(message)
  end
end

Return an individual IrcMessage or an array: Check IRC tools for helper classes available or add your own!

def on_join_messages(message)
  IrcTools::PrivmsgMessage.new(:recipient => message.channel, :message => 'Welcome')
end

def on_privmsg_messages(message)
  [
    IrcTools::PrivmsgMessage.new(:recipient => message.recipient, :message => 'Read this!'),
    IrcTools::PrivmsgMessage.new(:recipient => message.recipient, :message => 'Read this too!')
  ]
end

Finally, ensure your plugin is registered with your bot in the config, for the correct server:

{
  "nick_name": "my_nick",
  "user_name": "my_name",
  "real_name": "My Real Name",
  "host_name": 8,
  "server_name": "*",
  "pass": "*",
  "owner": "ownernick",
  "command_key": "p455w0rdZ",
  "remote_servers": [
    {
      "server_ref": "freenode",
      "server_address": "holmes.freenode.net",
      "port": 6667,
      "plugins": [
        "ToolsPlugin",
        "ControlPlugin",
        "ConsoleLoggerPlugin",
        "MyPlugin"
      ],
      "channels": [
        "#irwick",
        "#irwick_testing"
      ]
    }
  ]
}

Usage

bundle exec bin/irwick --config /route/to/config.json

Providing no config flag will fall back to the default path config/irwick_config.json

Tests

bundle exec rake test

License

irwick is relased under the MIT License.