brussell98/Mirai

# Mirai Bot Core

<a href="https://discord.gg/rkWPSdu"><img src="https://discordapp.com/api/guilds/135496553786769408/embed.png" alt="Discord server" /></a> [![David](https://img.shields.io/david/brussell98/Mirai.svg?maxAge=2592000)](https://david-dm.org/brussell98/Mirai) [![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg)](https://raw.githubusercontent.com/brussell98/Mirai/master/LICENSE) [![Code Climate](https://codeclimate.com/github/brussell98/Mirai/badges/gpa.svg)](https://codeclimate.com/github/brussell98/Mirai)
[![npm](https://img.shields.io/npm/v/mirai-bot-core.svg)](https://www.npmjs.com/package/mirai-bot-core)

A powerful Discord bot core using [Eris](https://github.com/abalabahaha/eris/).

#### [Documentation](http://brussell98.github.io/Mirai/index.html) | [Eris Docs](https://abal.moe/Eris/docs/index.html) | [Mirai Bot Website](http://mirai.brussell.me) | [Support me on Patreon](http://patreon.com/brussell98) | [Discord Server](https://discord.gg/rkWPSdu) | [Mirai Bot Combined Todo List](https://trello.com/b/Uw5wZLzJ)

mirai-bot-core supports advanced application monitoring with **[sentry.io](http://sentry.io)** using raven. For more information [head over to the docs](http://brussell98.github.io/Mirai/Logger.html).

## Installing

```
yarn add mirai-bot-core
```

```js
const Mirai = require('mirai-bot-core');
const bot = new Mirai(config);
```

## Abstract Classes

Abstract classes are provided to ensure you have the required methods. They can be accessed like so:

```js
const AbstractCommand = require('mirai-bot-core/lib/Base/AbstractCommand');

class PingCommand extends AbstractCommand {
    constructor() {
        super();
    }
}
```