discord.lib.client
v0.0.1-1
Published
A powerful library for interacting with the Discord API
Downloads
9
Readme
About
discord.lib.client is a powerful Node.js module that allows you to easily interact with the Discord API.
- Object-oriented
- Predictable abstractions
- Performant
- 100% coverage of the Discord API
Installation
Node.js 10.0.0 or newer is required.
Ignore any warnings about unmet peer dependencies, as they're all optional.
Without voice support: npm install discord.lib.client
With voice support (node-opus): npm install node-opus
With voice support (opusscript): npm install opusscript
Audio engines
The preferred audio engine is node-opus, as it performs significantly better than opusscript. When both are available, discord.js will automatically choose node-opus. Using opusscript is only recommended for development environments where node-opus is tough to get working. For production bots, using node-opus should be considered a necessity, especially if they're going to be running on multiple servers.
Optional packages
- zlib-sync for faster WebSocket data inflation (
npm install zlib-sync
) - zucc for significantly faster WebSocket data inflation (
npm install zucc
) - erlpack for significantly faster WebSocket data (de)serialisation (
npm install discordapp/erlpack
) - One of the following packages can be installed for faster voice packet encryption and decryption:
- sodium (
npm install sodium
) - libsodium.js (
npm install libsodium-wrappers
)
- sodium (
- uws for a much faster WebSocket connection (
npm install @discordjs/uws
) - bufferutil for a much faster WebSocket connection when not using uws (
npm install bufferutil
)
Example usage
const Discord = require('discord.lib.client');
const client = new Discord.Client();
client.on('ready', () => {
console.log(`Logged in as ${client.user.tag}!`);
});
client.on('message', msg => {
if (msg.content === 'ping') {
msg.reply('pong');
}
});
client.login('token');
Links
Extensions
Contributing
Before creating an issue, please ensure that it hasn't already been reported/suggested, and double-check the
documentation.
See the contribution guide if you'd like to submit a PR.
Help
If you don't understand something in the documentation, you could email [email protected]