plugdj-nodebot/README.md

A bot for PlugDj which help to manage the room even when no mods are presents.

plugdj-nodebot
==============

[![NPM](https://nodei.co/npm/plugdj-nodebot.png?downloads=true&downloadRank=true&stars=true)](https://nodei.co/npm/plugdj-nodebot/)

A [Plug.dj](https://plug.dj/) bot which allow you to do multiple moderations actions faster. It also moderate the room when no admins are here. It is open-source so you can edit it like you want.

## How to use it ?
### Using NPM:
  ```
  npm install plugdj-nodebot
  cd node_modules/plugdj-nodebot
  node nodebot
  ```
### Using Github:
* The bot needs [Node.js](http://nodejs.org/) to work.
* The bot uses [PlugAPI](https://github.com/plugCubed/plugAPI) so you'll need it before running the bot.
* After that, you need to download the bot. The entire bot is in the nodebot.js
* Now, open the nodebot.js file and add the name of your room (only the name __without the /__ ), the email of the bot account and it password.
* The bot should now be connected to your room and will detect commands starting by __!__

_IMPORTANT_: Make sure you've edited the nodebot.js to add the bot's account informations and the room name
```
    var ROOM = "foo"; // Room name here (https://plug.dj/foo will be foo) Line 5
AND
    "email": "email@domain.tld", // Line 1O
    "password": "password" // Line 11
    // If you have a HTTP 401 error, your user/pass is incorrect
```

___Note___: Make sure you change the role of the bot to Manager and you've restarted it after.

## List of commands
* __!ban__ (username[,time,reason]): Ban an user. __Time__ should only be __h__ for an hour (60minutes), __d__ for a day (24hours) or __f__ forever (Long long time). __Reason__ should only be __spam/troll/abuse/offensive/badsong/badtheme/negative__. Default time is Forever and default reason is Spam/Troll. (___Manager to Host___).
* __!commands__: Show a link to this readme.
* __!link__: Send the link of the current song in the chat (___Current DJ or Resident DJ to Host___).
* __!skip__: Forceskip the song if your rank is highest than Resident DJ or if you're DJ (___Current DJ or Bouncer to Host___). If you're not, it start a vote to skip (___None to Resident DJ___).
* __!unban__ (username): Unban an user. (___Manager to Host___).

_New commands are coming soon, let me know if you want another command._

## License
__This bot is under GNU GENERAL PUBLIC LICENSE, more informations [here](https://github.com/Moutard3/plugdj-nodebot/blob/master/LICENSE)__