Small plug.dj client for building bots and applications in Node.js, with a Promise-based API.
Note: Node v4 or higher is required. Run
node -vin your console to check that your Node.js version is up-to-date.
npm install --save miniplug
const miniplug =const mp =// Add an example chat command "!id"mp// Connect to plug.djmp// Join a roommp
Full API documentation is available in docs/API.md.
For questions, visit the #coding channel in the plug.dj discord!
Issues/PRs are appreciated!
To build the library, run:
npm run build
The built version will be placed in
To run tests, do:
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