dan/discord.js

mirror of https://github.com/danbulant/discord.js synced 2026-05-27 14:02:02 +00:00

No description

Find a file

Kyra 0f63c50c06 fix: Util.basename being unreliable (#2679 ) * fix: Util.basename being unreliable new URL for WHATWG parsing was not chosen because it only works for URLs and threw in local pathes, path.basename is unreliable (according to the devs' note), and path.parse seems to work well. * docs: Update Util.basename's description		2018-08-10 11:23:22 +02:00
.github	use new multiple issue templates (#2600 )	2018-06-16 10:02:48 +02:00
docs	remove hard-coded domain in welcome logo	2018-07-27 08:19:51 +01:00
src	fix: Util.basename being unreliable (#2679 )	2018-08-10 11:23:22 +02:00
test	switch to node-fetch (#2587 )	2018-06-19 20:10:55 +02:00
travis	Add deploy exception for dependabot branches	2018-03-25 15:14:18 -04:00
typings@b1127ec10e	chore: update typings submodule	2018-07-15 08:42:40 +02:00
.eslintrc.json	build(devDeps): update eslint requirement to ^5.0.1 (#2629 )	2018-06-26 23:14:54 +02:00
.gitattributes	According to the spec just this should work	2017-04-19 17:55:00 +02:00
.gitignore	Fix CRLF to LF	2017-06-01 10:45:56 +02:00
.gitmodules	Update typings submodule URL	2018-01-18 19:48:43 -05:00
.npmignore	wew	2017-10-25 16:09:36 -05:00
.npmrc	Fix .npmrc to not create package-lock.json (#1936 )	2017-09-13 02:19:29 +02:00
.tern-project	Fix tern file	2017-08-06 18:15:34 -04:00
.travis.yml	Maybe fix Travis some more	2017-11-18 17:50:30 -05:00
jsdoc.json	Store and Model Refactor (#1618 )	2017-08-25 21:08:58 +01:00
LICENSE	Update copyright notice on license	2018-01-11 16:14:54 +00:00
package.json	deps: update prism peer dep to point to right account	2018-08-07 18:25:42 +01:00
README.md	docs: consistency	2018-04-29 13:28:12 -05:00
webpack.config.js	fix: webpack building and upgrading to webpack 4.5	2018-04-11 13:49:42 +02:00

README.md

About

discord.js is a powerful Node.js module that allows you to interact with the Discord API very easily.

Object-oriented
Predictable abstractions
Performant
100% coverage of the Discord API

Installation

Node.js 8.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 (node-opus): npm install discord.js node-opus
With voice support (opusscript): npm install discord.js 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 significantly faster WebSocket data inflation (npm install zlib-sync)
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)
uws for a much faster WebSocket connection (npm install uws)
bufferutil for a much faster WebSocket connection when not using uws (npm install bufferutil)

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.reply('pong');
  }
});

client.login('token');

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.