modum-core v1.0.0

modum-core

The core for the modum chat bot platform. This provides the core bot class which is used to stitch together the adapters and extensions.

Disclaimer

This project is still under heavy development and is not fit for usage.

Philosophy

This platform was created to provide a consistent bot across multiple chat platforms, such as IRC, Slack, etc. Large bots are often closed-source and with this platform, we aim to provide and open source alternative.

Installation

$ npm install --save modum-core

Usage

import {Bot} from 'modum-core';
import IrcAdapter from 'modum-irc-adapter';
import ModumConsolePlugin from 'modum-console-plugin';
import RafflePlugin from 'modum-raffle-plugin';

let bot = new Bot();
bot
    .setAdapter(new IrcAdapter({
        username: 'modum-test',
        channels: ['#freenode']
    }))
    .registerPlugin(new ModumConsolePlugin())
    .registerPlugin(new RafflePlugin())
    .activate();

TODO

• Add test coverage (the setup is already there)

Contribute

If you want to contribute, we invite you to do so by submitting a pull request to this repository.

License

MIT © Maarten Flippo