#plugAPI 
NOTE: Development work has stopped on this project. Issues and Pull Requests will not be answered. This is due to plug.dj shutting down. Farewell Letter
A generic NodeJS API for creating plug.dj bots.
Originally by Chris Vickery, now maintained by TAT and The plug³ Team.
NOTE: Currently not supporting facebook login.
Run the following:
npm install plugapi --productionYou can choose to instantiate plugAPI with either Sync or Async
Sync:
var PlugAPI = require('plugapi');
var bot = new PlugAPI({
email: '',
password: ''
});
bot.connect('roomslug'); // The part after https://plug.dj
bot.on('roomJoin', function(room) {
console.log("Joined " + room);
});Async 3.5.0 and Below:
var PlugAPI = require('plugapi');
new PlugAPI({
email: '',
password: ''
}, function(bot) {
bot.connect('roomslug'); // The part after https://plug.dj
bot.on('roomJoin', function(room) {
console.log("Joined " + room);
});
});Async 4.0.0:
var PlugAPI = require('plugapi');
new PlugAPI({
email: '',
password: ''
}, function(err, bot) {
if (!err) {
bot.connect('roomslug'); // The part after https://plug.dj
bot.on('roomJoin', function(room) {
console.log("Joined " + room);
});
} else {
console.log('Error initializing plugAPI: ' + err);
}
});Here are some bots that are using this API.
| Botname | Room |
|---|---|
| AuntJackie | Mix-N-Mash |
| BeavisBot | I <3 the 80's and 90's |
| -DnB- | Drum & Bass |
| FlavorBar | Flavorz |
| FoxBot | Approaching Nirvana |
| TFLBot | The F**k Off Lounge | TFL |
| QBot | EDM Qluster |
| Holly Refbots | Connect The Songs (Read Info!) |
Have a bot that uses the API? Let us know!
You can listen on essentially any event that plug emits.
// basic chat handler to show incoming chats formatted nicely
bot.on('chat', function(data) {
if (data.type == 'emote')
console.log(data.from + data.message);
else
console.log(data.from + "> " + data.message);
});Here's an example for automatic reconnecting on errors / close events!
var reconnect = function() { bot.connect(ROOM); };
bot.on('close', reconnect);
bot.on('error', reconnect);Please Refer to the Wiki for both the Events and Actions.
- Clone repository to empty folder.
- Cd to the folder containing the repository.
- Run
npm installto set up the environment. - Edit your changes in the code, and make sure it follows our Style Guidelines.
- Run
npm testto make sure all tests pass. - After it's bug free, you may submit it as a Pull Request to this repo.
Since Plug.dj cuts off chat messages at 250 characters, you can choose to have your bot split up chat messages into multiple lines:
var bot = new PlugAPI(auth);
bot.multiLine = true; // Set to true to enable multi line chat. Default is false
bot.multiLineLimit = 5; // Set to the maximum number of lines the bot should split messages up into. Any text beyond this number will just be omitted. Default is 5.We have a Slack channel we use to communicate. Please email [email protected] if you'd like to be added