iBot Framework

iBot is a mods module for a very lightweight, minimal, and extensible IRC client framework.

Dependencies

$ npm install mods
$ npm install mods-config

Usage

Installation

$ npm install ibot

Quick Start

Using iBot, it's very easy to create a minimal bot.

index.js

var mods = new(require('mods'))
mods.load('mods-config')
mods.load('ibot')

config.json

{
  "ibot": {
    "servers": {
      "example": {
        "host": "irc.example.com",
        "port": 6667,
        "ssl": false,
        "nick": "iBot",
        "user": "ibot"
      }
    }
  }
}

Essentials

You probably want iBot to do more than, well, nothing, so it's a good idea to install ibot-essentials.

$ npm install ibot-essentials

In this example, iBot shows data sent/received, responds to server PINGs, and automatically joins some channels on connect.

index.js

var mods = new(require('mods'))
mods.load('mods-config')
mods.load('ibot')
mods.load('ibot-essentials/mods/core')
mods.load('ibot-essentials/mods/output')
mods.load('ibot-essentials/mods/ping')
mods.load('ibot-essentials/mods/autojoin')

config.json

{
  "ibot": {
    "servers": {
      "example": {
        "host": "irc.example.com",
        "port": 6667,
        "ssl": false,
        "nick": "iBot",
        "user": "ibot"
      }
    }
  },
  "ibot_autojoin": {
    "channels": [
      "#ibot",
      "#programming",
      "#self-learning-for-dummies"
    ]
  }
}

Example Module

This is an example mods module that greets users who join a channel. There's room for improvement but it's not meant to be perfect; just to show what an iBot module looks like.

greet.js

exports.name = 'greet'
exports.ibot$recv = function(server, message)
{
	if(message.opcode === 'JOIN')
	{
		server.send('PRIVMSG ' + message.params[0] + ' :Welcome, ' + message.prefix.nick + '!!')
	}
}

Commands

This is an example module that hooks a command event from cmd and provides a simple ping command. Note that ibot-essentials/mods/cmd needs to be loaded into mods in order for commands to receive events.

cmd_ping.js

exports.name = 'cmd_ping'
exports.ibot_cmd$cmd_ping = function(server, privmsg, command)
{
	privmsg.reply('Pong!')
}

Why?

iBot doesn't have a module system, nor does it have a config system. It doesn't include any modules either. Versions of iBot before v0.7.0 did. So, why not?

The module and config systems in previous versions of iBot were completely rewritten as generic, self-contained systems which can be used in any project (not just iBot). This means that the most important part of iBot - the iBot framework itself - is very concise and lightweight, and can be used without any module system or config system if desired. Additionally, it means that the config system it does use can be swapped out with another config system entirely.