mirror of
https://github.com/discordjs/discord.js.git
synced 2024-08-21 01:24:41 +12:00
145 lines
5 KiB
Markdown
145 lines
5 KiB
Markdown
<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/djs"><img src="https://img.shields.io/discord/222078108977594368?color=5865F2&logo=discord&logoColor=white" 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>
|
|
<a href="https://github.com/discordjs/discord.js/actions"><img src="https://github.com/discordjs/discord.js/actions/workflows/test.yml/badge.svg" alt="Tests status" /></a>
|
|
<a href="https://codecov.io/gh/discordjs/discord.js" ><img src="https://codecov.io/gh/discordjs/discord.js/branch/main/graph/badge.svg?precision=2" alt="Code coverage" /></a>
|
|
</p>
|
|
<p>
|
|
<a href="https://vercel.com/?utm_source=discordjs&utm_campaign=oss"><img src="https://raw.githubusercontent.com/discordjs/discord.js/main/.github/powered-by-vercel.svg" alt="Vercel" /></a>
|
|
</p>
|
|
</div>
|
|
|
|
## About
|
|
|
|
discord.js is a powerful [Node.js](https://nodejs.org) module that allows you to easily interact with the
|
|
[Discord API](https://discord.com/developers/docs/intro).
|
|
|
|
- Object-oriented
|
|
- Predictable abstractions
|
|
- Performant
|
|
- 100% coverage of the Discord API
|
|
|
|
## Installation
|
|
|
|
**Node.js 16.9.0 or newer is required.**
|
|
|
|
```sh
|
|
npm install discord.js
|
|
yarn add discord.js
|
|
pnpm add discord.js
|
|
```
|
|
|
|
### Optional packages
|
|
|
|
- [zlib-sync](https://www.npmjs.com/package/zlib-sync) for WebSocket data compression and inflation (`npm install zlib-sync`)
|
|
- [erlpack](https://github.com/discord/erlpack) for significantly faster WebSocket data (de)serialisation (`npm install discord/erlpack`)
|
|
- [bufferutil](https://www.npmjs.com/package/bufferutil) for a much faster WebSocket connection (`npm install bufferutil`)
|
|
- [utf-8-validate](https://www.npmjs.com/package/utf-8-validate) in combination with `bufferutil` for much faster WebSocket processing (`npm install utf-8-validate`)
|
|
- [@discordjs/voice](https://www.npmjs.com/package/@discordjs/voice) for interacting with the Discord Voice API (`npm install @discordjs/voice`)
|
|
|
|
## Example usage
|
|
|
|
Install discord.js:
|
|
|
|
```sh
|
|
npm install discord.js
|
|
yarn add discord.js
|
|
pnpm add discord.js
|
|
```
|
|
|
|
Register a slash command against the Discord API:
|
|
|
|
```js
|
|
const { REST, Routes } = require('discord.js');
|
|
|
|
const commands = [
|
|
{
|
|
name: 'ping',
|
|
description: 'Replies with Pong!',
|
|
},
|
|
];
|
|
|
|
const rest = new REST({ version: '10' }).setToken(TOKEN);
|
|
|
|
(async () => {
|
|
try {
|
|
console.log('Started refreshing application (/) commands.');
|
|
|
|
await rest.put(Routes.applicationCommands(CLIENT_ID), { body: commands });
|
|
|
|
console.log('Successfully reloaded application (/) commands.');
|
|
} catch (error) {
|
|
console.error(error);
|
|
}
|
|
})();
|
|
```
|
|
|
|
Afterwards we can create a quite simple example bot:
|
|
|
|
```js
|
|
const { Client, GatewayIntentBits } = require('discord.js');
|
|
const client = new Client({ intents: [GatewayIntentBits.Guilds] });
|
|
|
|
client.on('ready', () => {
|
|
console.log(`Logged in as ${client.user.tag}!`);
|
|
});
|
|
|
|
client.on('interactionCreate', async (interaction) => {
|
|
if (!interaction.isChatInputCommand()) return;
|
|
|
|
if (interaction.commandName === 'ping') {
|
|
await interaction.reply('Pong!');
|
|
}
|
|
});
|
|
|
|
client.login(TOKEN);
|
|
```
|
|
|
|
## Links
|
|
|
|
- [Website][website] ([source][website-source])
|
|
- [Documentation][documentation]
|
|
- [Guide][guide] ([source][guide-source])
|
|
See also the [Update Guide][guide-update], including updated and removed items in the library.
|
|
- [discord.js Discord server][discord]
|
|
- [Discord API Discord server][discord-api]
|
|
- [GitHub][source]
|
|
- [npm][npm]
|
|
- [Related libraries][related-libs]
|
|
|
|
### Extensions
|
|
|
|
- [RPC][rpc] ([source][rpc-source])
|
|
|
|
## Contributing
|
|
|
|
Before creating an issue, please ensure that it hasn't already been reported/suggested, and double-check the
|
|
[documentation][documentation].
|
|
See [the contribution guide][contributing] 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][discord].
|
|
|
|
[website]: https://discord.js.org/
|
|
[website-source]: https://github.com/discordjs/discord.js/tree/main/apps/website
|
|
[documentation]: https://discord.js.org/#/docs
|
|
[guide]: https://discordjs.guide/
|
|
[guide-source]: https://github.com/discordjs/guide
|
|
[guide-update]: https://discordjs.guide/additional-info/changes-in-v14.html
|
|
[discord]: https://discord.gg/djs
|
|
[discord-api]: https://discord.gg/discord-api
|
|
[source]: https://github.com/discordjs/discord.js/tree/main/packages/discord.js
|
|
[npm]: https://www.npmjs.com/package/discord.js
|
|
[related-libs]: https://discord.com/developers/docs/topics/community-resources#libraries
|
|
[rpc]: https://www.npmjs.com/package/discord-rpc
|
|
[rpc-source]: https://github.com/discordjs/RPC
|
|
[contributing]: https://github.com/discordjs/discord.js/blob/main/.github/CONTRIBUTING.md
|