coffea
Version:
event based and extensible nodejs irc client library with multi-network support
208 lines (175 loc) • 8.85 kB
Markdown
# coffea
[](https://www.npmjs.com/package/coffea) [](https://travis-ci.org/caffeinery/coffea) [](https://david-dm.org/caffeinery/coffea) [](https://readthedocs.org/projects/coffea/?badge=latest) [](https://codeclimate.com/github/caffeinery/coffea) [](https://coveralls.io/r/caffeinery/coffea)
_event based and extensible nodejs irc client library with multi-network support_
For support, report an issue on github, join our IRC channel at [](https://webchat.freenode.net/?channels=%23caffeinery&uio=d4) or if you prefer that, write an email to our mailing list: caffeinery@googlegroups.com
If you want to support coffea development, please consider donating (it helps me keeping the project active and alive!): [](https://gratipay.com/omnidan/)
## API
Documentation is available at [coffea.caffeinery.org](https://coffea.caffeinery.org/en/latest/).
## Installation
To install coffea, run: `npm install --save coffea` in your project directory.
## Examples
### Normal Connection (Single network)
```javascript
var client = require('coffea')('chat.freenode.net');
/* full config
var client = require('coffea')({
host: 'chat.freenode.net',
port: 6667, // default value: 6667
ssl: false, // set to true if you want to use ssl
ssl_allow_invalid: false, // set to true if the server has a custom ssl certificate
prefix: '!', // used to parse commands and emit on('command') events, default: !
channels: ['#foo', '#bar'], // autojoin channels, default: []
nick: 'test', // default value: 'coffea' with random number
username: 'test', // default value: username = nick
realname: 'test', // default value: realname = nick
pass: 'sup3rS3cur3P4ssw0rd', // by default no password will be sent
nickserv: {
username: 'test',
password: 'l33tp455w0rD'
},
throttling: 250 // default value: 250ms, 1 message every 250ms, disable by setting to false
});
*/
client.on('motd', function (event) {
client.join(['#foo', '#bar', '#baz'], event.network);
});
client.on('message', function (event) {
console.log('[' + event.channel.getName() + '] ' + event.user.getNick() + ': ' + event.message);
//[#foo] nick: message
event.reply(event.message); // I'm a parrot
});
client.on('command', function (event) {
if (event.cmd === 'ping') { // respond to `!ping SOMETHING` with `SOMETHING`, or `pong`, if SOMETHING is not specified
event.reply(event.args.length > 0 ? event.args.join(' ') : 'pong');
}
});
```
### Multiple networks
```javascript
var client = require('coffea')(['chat.freenode.net', 'irc.oftc.net']);
/* full config
var client = require('coffea')([
{
host: 'chat.freenode.net',
name: 'freenode', // this is not required but recommended when dealing with multiple networks, by default a numeric id will be assigned
port: 6667, // default value: 6667
ssl: false, // set to true if you want to use ssl
ssl_allow_invalid: false, // set to true if the server has a custom ssl certificate
prefix: '!', // used to parse commands and emit on('command') events, default: !
channels: ['#foo', '#bar'], // autojoin channels, default: []
nick: 'test', // default value: 'coffea' with random number
username: 'test', // default value: username = nick
realname: 'test', // default value: realname = nick
pass: 'sup3rS3cur3P4ssw0rd', // by default no password will be sent
nickserv: {
username: 'test',
password: 'l33tp455w0rD'
},
throttling: 250 // default value: 250ms, 1 message every 250ms, disable by setting to false
},
{
host: 'irc.oftc.net',
name: 'oftc', // this is not required but recommended when dealing with multiple networks, by default a numeric id will be assigned
port: 6667, // default value: 6667
ssl: false, // set to true if you want to use ssl
ssl_allow_invalid: false, // set to true if the server has a custom ssl certificate
prefix: '!', // used to parse commands and emit on('command') events, default: !
channels: ['#foo', '#bar'], // autojoin channels, default: []
nick: 'test', // default value: 'coffea' with random number
username: 'test', // default value: username = nick
realname: 'test', // default value: realname = nick
pass: 'sup3rS3cur3P4ssw0rd', // by default no password will be sent
nickserv: {
username: 'test',
password: 'l33tp455w0rD'
},
throttling: 250 // default value: 250ms, 1 message every 250ms, disable by setting to false
}
]);
*/
// note how we are passing the network here, by default it'll just send to all networks
// by using network you can join specific channels on specific networks
client.on('motd', function (event) {
client.join(['#foo', '#bar', '#baz'], event.network);
});
client.on('message', function (event) {
console.log('[' + event.channel.getName() + '] ' + event.user.getNick() + ': ' + event.message);
//[#foo] nick: message
event.reply(event.message); // I'm a parrot
});
client.on('command', function (event) {
if (event.cmd === 'ping') { // respond to `!ping SOMETHING` with `SOMETHING`, or `pong`, if SOMETHING is not specified
event.reply(event.args.length > 0 ? event.args.join(' ') : 'pong');
}
});
```
### Using SSL (and other goodies)
```javascript
var client = require('coffea')({
host: 'chat.freenode.net',
ssl: true, // we want to use ssl
channels: ['#foo', '#bar', '#baz'], // autojoin channels
// prefix: '!', // used to parse commands and emit on('command') events, default: !
// ssl_allow_invalid: true, // allow invalid/self-signed/expired SSL certs - default value: false
// port: 6697, // will default to 6697 on ssl
// nick: 'test', // default value: 'coffea' with random number
// username: 'test', // default value: username = nick
// realname: 'test', // default value: realname = nick
// pass: 'sup3rS3cur3P4ssw0rd', // by default no password will be sent
// nickserv: {
// username: 'test',
// password: 'l33tp455w0rD'
// },
// throttling: 250 // default value: 250ms, 1 message every 250ms, disable by setting to false
});
client.on('message', function (event) {
console.log('[' + event.channel.getName() + '] ' + event.user.getNick() + ': ' + event.message);
//[#foo] nick: message
event.reply(event.message); // I'm a parrot
});
client.on('command', function (event) {
if (event.cmd === 'ping') { // respond to `!ping SOMETHING` with `SOMETHING`, or `pong`, if SOMETHING is not specified
event.reply(event.args.length > 0 ? event.args.join(' ') : 'pong');
}
});
```
### Debugging
Make sure to listen to `error` events to see possible errors/warnings:
```javascript
client.on('error', function (err, event) {
console.log(event.name, err.stack);
});
```
You can also add the `err` parameter to any event listener (change from `function (event)` to `function (err, event)`:
```javascript
client.on('whois', function (err, event) {
if (err) console.log("WHOIS ERROR:", err.stack);
console.log("whois:", event);
});
```
### Configuration file
Using a configuration file for your bot is super easy with coffea! First, create `config.json` and paste your current configuration. (Make sure to change `key: 'something'` to `"key": "something"` as we're dealing with JSON now, e.g. `host: 'chat.freenode.net'` -> `"host": "chat.freenode.net"`)
Then, simply do:
```javascript
var client = require('coffea')(require('./config.json'));
```
#### `config.json` with full config
```javascript
{
"host": "chat.freenode.net",
"port": 6667,
"ssl": false,
"ssl_allow_invalid": false,
"prefix": "!",
"channels": ["#foo", "#bar"],
"nick": "test",
"username": "test",
"realname": "test",
"pass": "sup3rS3cur3P4ssw0rd",
"nickserv": {
"username": "test",
"password": "l33tp455w0rD"
},
"throttling": 250
}
```