Skip to content

Latest commit

 

History

History
24 lines (16 loc) · 989 Bytes

README.md

File metadata and controls

24 lines (16 loc) · 989 Bytes

alakajam-irc

An IRC bot for alakajam.com.

Supported commands

See the commands documentation.

Quick start

Requires Node 8. The bot can be started by running:

npm install
npm start

This will connect using the default configuration in example.config.yaml. To use custom configuration (recommended), create an alternative config file called config.yaml. This file takes precedence over example.config.yaml and is not tracked by git.

REPL

The client created in index.js can be imported into the REPL and manipulated there. For example:

$ node
> const client = require('.');
> client.say('#alakajam', 'Abracadabra');

Configuration

Configuration options are explained in example.config.yaml.