fatbot

An easy to use coffeescript IRC bot framework

npm install fatbot
10 downloads in the last week
20 downloads in the last month
    ______      __  ____        __ 
   / ____/___ _/ /_/ __ )____  / /_
  / /_  / __ `/ __/ __  / __ \/ __/
 / __/ / /_/ / /_/ /_/ / /_/ / /_  
/_/    \__,_/\__/_____/\____/\__/

FatBot is an easy to use and extensible coffescript IRC bot framework.

Quick start

Create a file mybot.coffee

Install fatbot via npm

npm install fatbot

Here is an example of a simple bot :

fatbot = require 'fatbot'

bot = new fatbot.Bot
  server:   'freenode',
  nick:   'mybot',
  channels: ['#mycoolchan']

# Listen to Bot events

bot.on 'user:join', (r) ->
  r.reply "Welcome to #{r.channel}, #{r.nick} !"

# Extending bot prototype

fatbot.Bot::hear = (regex,callback) ->
  @on 'user:talk', (r) ->
    if r.text.match regex
      callback(r)

# Using newly created extensions

bot.hear /hello/, (r) ->
  r.reply "Hello #{r.nick} !"

bot.hear /bye/, (r) ->
  r.reply "Good bye #{r.nick}"

bot.connect()

Then launch your bot :

coffee mybot

In this example, you are :

  • Connecting mybot to a built-in server shortcut called freenode and join a channel called #mycoolchan
  • Perform action on events with Fatbot::on
  • Extending the prototype for event listening automation : Fatbot::hear
  • Using the extension Fatbot::hear
  • Launching the bot with Fatbot::connnect method

Build from sources

To build from sources, clone this repo :

git clone https://github.com/RayFranco/fatbot.git

Then from the repo root folder, install the dependencies :

npm install

You can now create your bot or try one frome the example in the folder ./bots/

Use cake task bot:start to start a bot :

cake -b simple bot:start

Above, we are launching the example bot called simple.coffee

Sweeten your Bot

If you'd like to add a couple functionnalities to your bot, you better getting organized. Here is the way we suggest.

If the function Bot::on take two parameters as described by the EventEmitter class, Fatbot also takes an object literal syntax like this:

bot.on
  event: 'user:talk'
  trigger: (r) ->
    console.log "#{r.nick} is talking..."

The best part in this syntax, is that now you can bundle these objects into arrays, and send it to the Bot::on function. This way, you can now store all your extensions logic in separate files easily. Let's take a look at an example:

# ./sugars/hello.coffee
callback = (r) -> r.reply "Hello #{r.reply}!"
ontalk =
  event: 'user:talk'
  trigger: callback
onprivate =
  event: 'user:private'
  trigger: callback

module.exports = [ontalk, onprivate]
# ./bot.coffee
hello = require './sugars/hello'

#...

bot.on hello

bot.connect()

This is an easy way to bundle sugars into a file and keep it simple and readable. Try it out!

Extending the Bot

To extend the bot, we are simply extending the fatbot.Bot. This might me a little risky, if you'd tries to overwrite Bot methods (like constructor, connect, say or any other methods). You should be aware of what methods you are adding to the Bot.

In the future, I'd like to add these helpers in a different namespace (sugars).

For more informations, see the Classes section of coffeescript to understand how to extend the prototype, especially with the :: operator.

Events

You can easily add behaviors to the bot by listening to events :

bot.on 'user:join', (r) ->
  r.reply "Welcome to #{r.channel}, #{r.nick}!"

r is the Response object.

These are the events thrown by the bot. Check the Response object section for more informations

Event name Description Response
client:error Error sent by the client err (isnt Response object)
self:connected Bot is connected to server server
self:talk Bot is talking nick, text, client, reply(txt)
self:join Bot is joining a channel channel, nick, text, client
user:talk User is talking in channel nick, channel, text, client, reply(txt)
user:private User send pm to the bot nick, text, client
user:join User join a channel channel, nick, text, client, reply(txt)

Change log

2013-03-17 v0.3.3

  • Fix CB when using coffee-script v.1.6.x compiler

2012-12-26 v0.3.2

  • You can now add event listeners with objects literal
  • You can now add event listeners bundled in arrays
  • README.md upadated with new examples

2012-12-26 v0.3.1

  • Bot completely rewritten (again)
  • Temporary removing sugars in favor of prototype extensions
  • Refinery lost in translation ;)
  • Simpler code to do such simple things

2012-12-24 v0.2.0

  • Bot completely rewritten in coffeescript on top of node and node-irc
  • Fatbot is now a standalone framework
  • Plugins are now called sugars
  • Added sugars factories called refinery helpers
  • Merge of node branch into master
  • Fist beta working version of the coffeescript version
npm loves you