discord.js-router/README.md

This is a Base Bot Router for Discord.js this allows for the Handling of Plugins, and a Trigger Easily.

# discord.js-router

![Build Status](https://img.shields.io/travis/Bioblaze/discord.js-router.svg)
![dependencies](https://img.shields.io/david/Bioblaze/discord.js-router.svg)
![dev dependencies](https://img.shields.io/david/dev/Bioblaze/discord.js-router.svg)

[![Downloads](https://img.shields.io/npm/dm/discord.js-router.svg)](https://www.npmjs.com/package/discord.js-router)
[![Downloads](https://img.shields.io/npm/dt/discord.js-router.svg)](https://www.npmjs.com/package/discord.js-router)
[![npm version](https://img.shields.io/npm/v/discord.js-router.svg)](https://www.npmjs.com/package/discord.js-router)
[![License](https://img.shields.io/npm/l/discord.js-router.svg)](https://github.com/Bioblaze/discord.js-router/blob/master/LICENSE)

[![Code Climate](https://codeclimate.com/github/Bioblaze/discord.js-router/badges/gpa.svg)](https://codeclimate.com/github/Bioblaze/discord.js-router)
[![Discord Chat](https://img.shields.io/discord/165374225320771586.svg)](https://discord.gg/T8uVhzU)
[![PayPal](https://img.shields.io/badge/paypal-donate-yellow.svg)](https://paypal.me/BioblazePayne)  

Discord is a trademark or registered trademark of Hammer & Chisel, Inc. in the U.S. and/or other countries. "discord.js-router" is not operated by, sponsored by, or affiliated with Hammer & Chisel Inc. in any way.

## Install
```bash
$ npm install discord.js-router
```

## Information

Documentation on Object Class Structure & Functions can be found at the Official [Github Pages](https://bioblaze.github.io/discord.js-router/)
Tutorials, Guides, and More can be Found at the Official [Github Wiki](https://github.com/Bioblaze/discord.js-router/wiki)

If any information is Lacking please Post a Question in the [Github Issues](https://github.com/Bioblaze/discord.js-router/issues) Section.

Example Code can be Found [master/example](https://github.com/Bioblaze/discord.js-router/tree/master/example)

Example Project: <In Development>

## Usage of the Discord.js Router

### Configure

#### Config Options

##### Base
```javascript
{
  plugins_dir: String, // Required
  token: String, //Required unless you Launch it as a Shard of Discord.js
  trigger: String, //Required this is what makes your bot respond to people "pw!"
  reactions: Boolean, // Optional this will allow you to get reaction events sent too your Plugins.
  guilds: Boolean, // Optional this will allow you to get Guild Join/Part events sent to your Plugins.
  members: Boolean, // Optional this will allow you to get Member Join/Part events for Guilds sent to your Plugins.
  owners: Array of String // Required Array of Owner IDs in String format.
}
```

##### Example
```javascript

var discord = require('discord.js-router');

discord.Start({
  plugins_dir: "plugins", // This Directory must Exist
  token: "YourBotTokenGoesHere", // Replace with String for the Discord Token.
  trigger: "dev!",
  owners: ["165372475562000385"]
});

```

## Issue

If any Issues Please Submit them on the Github!

## Example

### /index.js
```javascript

var options = {
  plugins_dir: "plugins",
  token: null, // Replace with String for the Discord Token.
  trigger: "dev!",
  owners: ["165372475562000385"]
};

var discord = require('discord.js-router');

discord.Start(options);

process.on('uncaughtException', function(err) {
	console.log(`uncaughtException: ${err}`);
});
process.on('unhandledRejection', function(err) {
  console.log(`unhandledRejection: ${err}`)
});

```

### /plugins/test.js

```javascript

var discord = require('discord.js-router');

discord.on('cmd', function(cmd, args, data) {
  if (cmd == "test") {
    data.channel.send("This works");
  } else if (cmd == "reload") {
    discord.ReloadPlugins();
    data.channel.send("Plugins are Reloaded!");
  }
});

```