2017-04-20 04:14:37 +12:00
< div align = "center" >
< br / >
< p >
< a href = "https://discord.js.org" > < img src = "https://discord.js.org/static/logo.svg" width = "546" alt = "discord.js" / > < / a >
< / p >
< br / >
< p >
< a href = "https://discord.gg/bRCvFy9" > < img src = "https://discordapp.com/api/guilds/222078108977594368/embed.png" alt = "Discord server" / > < / a >
< a href = "https://www.npmjs.com/package/discord.js" > < img src = "https://img.shields.io/npm/v/discord.js.svg?maxAge=3600" alt = "NPM version" / > < / a >
< a href = "https://www.npmjs.com/package/discord.js" > < img src = "https://img.shields.io/npm/dt/discord.js.svg?maxAge=3600" alt = "NPM downloads" / > < / a >
2019-11-10 08:52:06 +13:00
< a href = "https://github.com/discordjs/discord.js/actions" > < img src = "https://github.com/discordjs/discord.js/workflows/Testing/badge.svg" alt = "Build status" / > < / a >
2018-01-19 08:46:35 +13:00
< a href = "https://david-dm.org/discordjs/discord.js" > < img src = "https://img.shields.io/david/discordjs/discord.js.svg?maxAge=3600" alt = "Dependencies" / > < / a >
2017-10-29 06:02:12 +13:00
< a href = "https://www.patreon.com/discordjs" > < img src = "https://img.shields.io/badge/donate-patreon-F96854.svg" alt = "Patreon" / > < / a >
2017-04-20 04:14:37 +12:00
< / p >
< p >
2018-01-19 13:59:21 +13:00
< a href = "https://nodei.co/npm/discord.js/" > < img src = "https://nodei.co/npm/discord.js.png?downloads=true&stars=true" alt = "npm installnfo" / > < / a >
2017-04-20 04:14:37 +12:00
< / p >
< / div >
2019-11-04 23:29:19 +13:00
## Table of contents
- [About ](#about )
- [Installation ](#installation )
- [Audio engines ](#audio-engines )
- [Optional packages ](#optional-packages )
- [Example Usage ](#example-usage )
- [Links ](#links )
- [Extensions ](#extensions )
- [Contributing ](#contributing )
- [Help ](#help )
2017-04-20 04:14:37 +12:00
## About
2019-02-10 12:53:47 +13:00
discord.js is a powerful [Node.js ](https://nodejs.org ) module that allows you to easily interact with the
[Discord API ](https://discordapp.com/developers/docs/intro ).
2017-04-20 04:14:37 +12:00
- Object-oriented
- Predictable abstractions
- Performant
- 100% coverage of the Discord API
## Installation
2019-12-07 00:59:57 +13:00
**Node.js 10.2.0 or newer is required.**
2017-04-20 04:14:37 +12:00
Ignore any warnings about unmet peer dependencies, as they're all optional.
2019-04-21 23:47:09 +12:00
Without voice support: `npm install discordjs/discord.js`
With voice support ([node-opus](https://www.npmjs.com/package/node-opus)): `npm install discordjs/discord.js node-opus`
With voice support ([opusscript](https://www.npmjs.com/package/opusscript)): `npm install discordjs/discord.js opusscript`
2017-04-20 04:14:37 +12:00
### 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
2019-05-08 01:30:34 +12:00
- [zlib-sync ](https://www.npmjs.com/package/zlib-sync ) for faster WebSocket data inflation (`npm install zlib-sync`)
- [zucc ](https://www.npmjs.com/package/zucc ) for significantly faster WebSocket data inflation (`npm install zucc`)
2018-01-19 13:59:21 +13:00
- [erlpack ](https://github.com/discordapp/erlpack ) for significantly faster WebSocket data (de)serialisation (`npm install discordapp/erlpack`)
2017-04-24 18:24:45 +12:00
- One of the following packages can be installed for faster voice packet encryption and decryption:
2018-01-19 13:59:21 +13:00
- [sodium ](https://www.npmjs.com/package/sodium ) (`npm install sodium`)
- [libsodium.js ](https://www.npmjs.com/package/libsodium-wrappers ) (`npm install libsodium-wrappers`)
2018-08-25 02:51:33 +12:00
- [uws ](https://www.npmjs.com/package/@discordjs/uws ) for a much faster WebSocket connection (`npm install @discordjs/uws `)
2018-01-19 13:59:21 +13:00
- [bufferutil ](https://www.npmjs.com/package/bufferutil ) for a much faster WebSocket connection when *not* using uws (`npm install bufferutil`)
2017-04-20 04:14:37 +12:00
## Example usage
```js
const Discord = require('discord.js');
const client = new Discord.Client();
client.on('ready', () => {
2018-01-19 13:59:21 +13:00
console.log(`Logged in as ${client.user.tag}!`);
2017-04-20 04:14:37 +12:00
});
2018-01-19 13:59:21 +13:00
client.on('message', msg => {
if (msg.content === 'ping') {
msg.reply('pong');
2017-04-20 04:14:37 +12:00
}
});
2018-01-19 13:59:21 +13:00
client.login('token');
2017-04-20 04:14:37 +12:00
```
## Links
2018-01-19 08:46:35 +13:00
* [Website ](https://discord.js.org/ ) ([source](https://github.com/discordjs/website))
2019-04-21 23:47:09 +12:00
* [Documentation ](https://discord.js.org/#/docs/main/master/general/welcome )
* [Guide ](https://discordjs.guide/ ) ([source](https://github.com/discordjs/guide)) - this is still for stable
See also the WIP [Update Guide ](https://github.com/discordjs/guide/blob/v12-changes/guide/additional-info/changes-in-v12.md ) also including updated and removed items in the library.
2017-10-29 06:02:12 +13:00
* [Discord.js Discord server ](https://discord.gg/bRCvFy9 )
* [Discord API Discord server ](https://discord.gg/discord-api )
2018-01-19 08:46:35 +13:00
* [GitHub ](https://github.com/discordjs/discord.js )
2017-04-20 04:14:37 +12:00
* [NPM ](https://www.npmjs.com/package/discord.js )
2017-10-29 06:02:12 +13:00
* [Related libraries ](https://discordapi.com/unofficial/libs.html )
### Extensions
2018-01-19 13:59:21 +13:00
* [RPC ](https://www.npmjs.com/package/discord-rpc ) ([source](https://github.com/discordjs/RPC))
2017-04-20 04:14:37 +12:00
## Contributing
Before creating an issue, please ensure that it hasn't already been reported/suggested, and double-check the
[documentation ](https://discord.js.org/#/docs ).
2018-01-19 08:46:35 +13:00
See [the contribution guide ](https://github.com/discordjs/discord.js/blob/master/.github/CONTRIBUTING.md ) if you'd like to submit a PR.
2017-04-20 04:14:37 +12:00
## 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 ](https://discord.gg/bRCvFy9 ).