# modum-core

> The core bot class for the modum-bot platform.

Latest version **1.0.0** (published 2016-04-18) · MIT license · 0 weekly downloads

## Install

```sh
npm install modum-core
pnpm add modum-core
yarn add modum-core
bun add modum-core
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.0 |
| Published | 2016-04-18 |
| First published | 2016-04-18 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Maarten Flippo |
| Maintainers | muukrls |

## Links

- npm: https://www.npmjs.com/package/modum-core
- Repository: https://github.com/modum-bot/modum-core
- Homepage: https://github.com/modum-bot/modum-core#readme
- Issues: https://github.com/modum-bot/modum-core/issues
- npm.io page: https://npm.io/package/modum-core

## Dependencies (1)

- [lodash](https://npm.io/package/lodash.md) ^4.9.0

## Recent versions

- 1.0.0 (latest) — 2016-04-18

## README

# modum-core
[![NPM version][npm-image]][npm-url] [![Build Status][travis-image]][travis-url] [![Dependency Status][daviddm-image]][daviddm-url]

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
```sh
$ npm install --save modum-core
```

## Usage
```js
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](http://web-ux.com)


[npm-image]: https://badge.fury.io/js/modum-core.svg
[npm-url]: https://npmjs.org/package/modum-core
[travis-image]: https://travis-ci.org/modum-bot/modum-core.svg?branch=master
[travis-url]: https://travis-ci.org/modum-bot/modum-core
[daviddm-image]: https://david-dm.org/modum-bot/modum-core.svg?theme=shields.io
[daviddm-url]: https://david-dm.org/modum-bot/modum-core

---
_Source: https://npm.io/package/modum-core · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._