⚠️This version is not up to date as it needs a rework to support v9 (see #5). An experimental version is available in the v13 branch.

Table of contents

About
Installation
- Audio engines
- Optional packages
Example Usage
Links
- Extensions
Contributing
Help

About

discord.js 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 14.0.0 or newer is required.
Ignore any warnings about unmet peer dependencies, as they're all optional.

Without voice support: npm install discord.js
With voice support (@discordjs/opus): npm install discord.js @discordjs/opus
With voice support (opusscript): npm install discord.js opusscript

Audio engines

The preferred audio engine is @discordjs/opus, as it performs significantly better than opusscript. When both are available, discord.js will automatically choose @discordjs/opus. Using opusscript is only recommended for development environments where @discordjs/opus is tough to get working. For production bots, using @discordjs/opus should be considered a necessity, especially if they're going to be running on multiple servers.

Optional packages

zlib-sync for WebSocket data compression and inflation (npm install zlib-sync)
erlpack for significantly faster WebSocket data (de)serialisation (npm install discord/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)
bufferutil for a much faster WebSocket connection (npm install bufferutil)
utf-8-validate in combination with bufferutil for much faster WebSocket processing (npm install utf-8-validate)

Example usage

const Discord = require('discord.js');
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.channel.send('pong');
  }
});

client.login('token');

Links

Website (source)
Documentation
Guide (source) - this is still for stable
See also the Update Guide, including updated and removed items in the library.
Discord.js Discord server
Discord API Discord server
GitHub
NPM
Related libraries

Extensions

RPC (source)

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 are experiencing problems, or you just need a gentle nudge in the right direction, please don't hesitate to join our official Discord.js Server.

License

GiorgioBrux/discord.js

About

Resources

License

Code of conduct

Stars

Watchers

Forks

Releases

Packages 0

Languages

Packages