Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
A simple IRC bot implemented on top of IRC-js, with support for plug-ins.
CoffeeScript
branch: master

Fetching latest commit…

Cannot retrieve the latest commit at this time

Failed to load latest commit information.
examples
lib
node_modules
src
.gitattributes
.gitignore
README.md
UNLICENSE
package.json

README.md

irc-js-bot

A simple IRC bot implemented on top of IRC-js, with support for plug-ins.

Installation

npm install irc-js-bot

In the wild

The main support bot in the #css and #html channels on Freenode IRC uses irc-js-bot. He listens to the name rivvles and his triggers are ` and ]. He also has his own channel, #rivvles, which can be used to discuss irc-js-bot as well.

Running a bot

See the examples.

Configuration

See the examples. Better docs later. Maybe.

Features

Factoid syntax

<trigger><factoid-name>, e.g. !hello world

Command syntax

<trigger><command-name>[/<flags>][ <arguments>], e.g. !search/n foo bar baz.

Intents

!foo @ johndoe
!foo > johndoe
!foo % johndoe

@ addresses johndoe in the channel or query of origin; > sends the message by query; % sends the message by notice.

Comments

!foo # this is just a comment
!foo @ johndoe # this is just a comment

Plug-ins

API

A plug-in is a Node.js module. Assign a function to the module.exports object; the function is called with this set to the bot instance. A plug-in has full access to the bot instance, no hand-holding.

Register a special command by calling this.register_special_command with a configuration object as its sole argument; see any of the bundled official plug-ins for examples.

You can also register an incoming message callback by calling this.register_message_callback with a function as its sole argument. See the irc-js-bot-admin official plug-in for an example. You can use this to audit incoming messages. Return false to silently stop processing immediately. This is used in the admin plug-in to ignore users that are on the ignore list.

Official (bundled) plug-ins

irc-js-bot comes bundled with several official plug-ins for your convenience. For now, please see the source files for details. Their names start with 'irc-js-bot-'. Each command supports the ? flag for viewing detailed instructions.

Other plug-ins

There's a list of known plug-ins on the wiki.

License

UNLICENSE yo.

Something went wrong with that request. Please try again.