icarusbot

ICARUS BOT

This is a very simple IRC bot that I built from scratch because I wanted to learn about RFC 2812 and RFC 1459.

Creating a bot:

• Copy config.dist.json to config.json
• Fill out all the stuff in config.json
• Write a bot consumer

  var bot = require('icarusbot')
  var plugin-foo = require('icarubot-plugin-foo')(bot)`
  var plugin-bar = require('icarubot-plugin-bar')(bot)`

• Run your bot node whatever-you-name-your-bot.js

Creating a plugin:

The bot currently emits various events that you can listen to, most notably the msg event.

Here is a simple plugin:

module.exports = function(bot) {
  bot.on('msg',function(msg) {
    console.log(msg) // {sender: 'a_nick', chan: '##foo', msg: 'foo bar baz'}
 
    // bot.msg() supports writing messages in a sane way.
    if (msg.msg === 'wow') {
      bot.msg(['#channel1', '#channel2'], 'mom')
    }
  })
}

Current plugins (PR to add yours!):

icarusbot-lysergix:

• Adds a handler for a !face message that posts a random face from lysergix-api