irc-stream

A duplex streaming IRC bot built on top of `irc`

npm install irc-stream
1 downloads in the last day
19 downloads in the last week
33 downloads in the last month

irc-stream Build Status Dependency Status

irc-stream is a minimalistic, streaming bot wrapper for the irc module.

irc-stream will relay any combination of the following:

  • channel messages addressed to the desired client name (default on)
  • pms (default off)

These messages are available as a readable stream, and can thus be piped into a writable stream. Messages can be written like for a writable stream, and messages sent will be sent in the channel/pm.

Usage

Ideally, use it with gu:

var ircStream = require('irc-stream')(ircServer, ircName, ircModuleOpts, ircStreamOpts);
var gu = require('gu')(scriptPath, scriptFiles);

ircStream.pipe(gu).pipe(ircStream);

The first three irc-stream arguments are simply passed through to the irc module.

Options

The fourth argument dictate how we listen on IRC:

{
  allErrors: Boolean, // ignore all error events to the `irc` client - default `true`
  noChan: Boolean,    // ignore channel directed messages - default `false`
  answerPms: Boolean, //  respond to private messages - default `true`
  announcerMode: Boolean // don't respond directly in channel - default `false`
  conversationMode: Boolean // always respond directly in channel - default `false`
  participationChance: Number // percentage probability to respond without being addressed - default `0`
}

NB: Can only do one of announcerMode and conversationMode.

Installation

$ npm install irc-stream --save

Running tests

Install development dependencies

$ npm install

Run the tests

$ npm test

License

MIT-Licensed. See LICENSE file for details.

npm loves you