discord.js

mirror of https://github.com/discordjs/discord.js.git synced 2024-07-08 02:21:18 +12:00

History

Jiralite 15021990e8 build: Bump discord-api-types to 0.37.90 (#10354 ) build: bump discord-api-types Co-authored-by: kodiakhq[bot] <49736102+kodiakhq[bot]@users.noreply.github.com>		2024-06-18 18:37:16 +00:00
..
__mocks__	build: fix the messy dependency graph	2023-11-09 00:13:01 +01:00
__tests__	build: multi-config build and dep update	2023-11-14 01:26:22 +01:00
docs	chore: refactor workspace	2023-05-03 02:14:22 +02:00
scripts	build: fix the messy dependency graph	2023-11-09 00:13:01 +01:00
src	build: multi-config build and dep update	2023-11-14 01:26:22 +01:00
.cliff-jumperrc.json	chore: No identifier base in development versions (#9848 )	2023-10-03 19:24:13 +00:00
.gitignore	chore: refactor workspace	2023-05-03 02:14:22 +02:00
.lintstagedrc.js	build: multi-config build and dep update	2023-11-14 01:26:22 +01:00
.prettierignore	build: ignores/swap/concurrency	2023-08-24 21:58:34 +02:00
.prettierrc.js	build: multi-config build and dep update	2023-11-14 01:26:22 +01:00
api-extractor.json	feat(website): add support for source file links (#9048 )	2023-01-12 13:49:11 +01:00
babel.config.js	chore: monorepo setup (#7175 )	2022-01-07 17:18:25 +01:00
CHANGELOG.md	chore: fix duplicated voice changelog	2024-05-04 20:50:15 +03:00
cliff.toml	build: git-cliff config	2023-04-02 01:55:39 +02:00
jest.config.js	fix(codecov): use cobertura (#8235 )	2022-07-05 12:32:05 +02:00
LICENSE	feat: docgen package (#8029 )	2022-06-07 10:51:33 +02:00
package.json	build: Bump discord-api-types to 0.37.90 (#10354 )	2024-06-18 18:37:16 +00:00
README.md	docs(create-discord-bot): support bun in create-discord-bot (#9798 )	2023-08-28 09:36:26 +02:00
tsconfig.docs.json	build: fix the messy dependency graph	2023-11-09 00:13:01 +01:00
tsconfig.eslint.json	build: fix the messy dependency graph	2023-11-09 00:13:01 +01:00
tsconfig.json	build: fix the messy dependency graph	2023-11-09 00:13:01 +01:00
tsup.config.ts	chore: switch tsup config to typescript (#9057 )	2023-01-13 09:44:56 +00:00

README.md

About

@discordjs/voice is a TypeScript implementation of the Discord Voice API for Node.js.

Features:

Send and receive* audio in Discord voice-based channels
A strong focus on reliability and predictable behaviour
Horizontal scalability and libraries other than discord.js are supported with custom adapters
A robust audio processing system that can handle a wide range of audio sources

*Audio receive is not documented by Discord so stable support is not guaranteed

Installation

Node.js 16.11.0 or newer is required.

npm install @discordjs/voice
yarn add @discordjs/voice
pnpm add @discordjs/voice
bun add @discordjs/voice

Dependencies

This library has several optional dependencies to support a variety of different platforms. Install one dependency from each of the categories shown below. The dependencies are listed in order of preference for performance. If you can't install one of the options, try installing another.

Encryption Libraries (npm install):

sodium-native: ^3.3.0
sodium: ^3.0.2
tweetnacl: ^1.0.3
libsodium-wrappers: ^0.7.9

Opus Libraries (npm install):

@discordjs/opus: ^0.4.0
opusscript: ^0.0.7

FFmpeg:

FFmpeg (installed and added to environment)
ffmpeg-static: ^4.2.7 (npm install)

Examples

The voice-examples repository contains examples on how to use this package. Feel free to check them out if you need a nudge in the right direction.

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.