Welcome!

Welcome to the discord.js v10 documentation. v10 is just a more consistent and stable iteration over v9, and contains loads of new and improved features, optimisations, and bug fixes.

About

discord.js is a powerful node.js module that allows you to interact with the Discord API very easily. It takes a much more object-oriented approach than most other JS Discord libraries, making your bot's code significantly tidier and easier to comprehend. Usability and performance are key focuses of discord.js, and it also has nearly 100% coverage of the Discord API.

Installation

Node.js 6.0.0 or newer is required.

Without voice support: npm install discord.js --save
With voice support (node-opus): npm install discord.js node-opus --save
With voice support (opusscript): npm install discord.js opusscript --save

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.

Web distributions

Web builds of discord.js that are fully capable of running in browsers are available here. These are built by Webpack 2. The API is identical, but rather than using require('discord.js'), the entire Discord object is available as a global (on the window object). The ShardingManager and any voice-related functionality is unavailable in these builds.

Guides

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.

3.9 KiB Raw Blame History