Small plug.dj client for building bots and applications in Node.js, with a Promise-based API.
JavaScript
Clone or download
Latest commit ec05c86 Jul 21, 2018

README.md

miniplug

Small plug.dj client for building bots and applications in Node.js, with a Promise-based API.

Installation - Usage - API - Status - Contributing - License: MIT

Installation (install size)

Note: Node v4 or higher is required. Run node -v in your console to check that your Node.js version is up-to-date.

npm install --save miniplug

Usage

const miniplug = require('miniplug')

const mp = miniplug()

// Add an example chat command "!id"
mp.on('chat', (message) => {
  if (/^!id/.test(message.message)) {
    message.reply(`Your user ID is ${message.uid}.`)
  }
})

// Connect to plug.dj
mp.connect({
  email: 'admin@plug.dj',
  password: 'hunter2'
}).catch((err) => {
  console.error('Could not connect to plug.dj:')
  console.error(err)
  process.exit(1)
})

// Join a room
mp.join('tastycat').then(() => {
  const room = mp.room()
  mp.chat(`Hello ${room.name}! :wave:`)
})

API

Full API documentation is available in docs/API.md.

For questions, visit the #coding channel in the plug.dj discord!

join the plug.dj discord

Status

Travis npm version David npm downloads

Contributing

Issues/PRs are appreciated!

To build the library, run:

npm run build

The built version will be placed in index.js.

To run tests, do:

npm test

There's not many tests just yet, but it's good to check anyway! This command will also check your code style using Standard.

Changed files will also be tested and linted automatically when you git commit.

License

MIT