Skip to content

Commit 40095c1

Browse files
jNulljJiralite
authored andcommitted
Add info about DAVE protocol dependencies and support
Changes remade from discordjs/guide#1630 due to project moving from that repo to this one.
1 parent dd79525 commit 40095c1

File tree

1 file changed

+18
-1
lines changed

1 file changed

+18
-1
lines changed

apps/guide/content/docs/voice/index.mdx

Lines changed: 18 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,11 @@ title: Installation
88

99
### Barebones
1010

11-
To add voice functionality to your discord.js bot, you will need the `@discordjs/voice` package, as well as one of the encryption packages listed below. For example:
11+
To add voice functionality to your discord.js bot, you will need the `@discordjs/voice` package. If your system does not support aes-256-gcm you also need one of the encryption packages listed below. For example:
12+
13+
<Callout>
14+
You can verify aes-256-gcm support by running `require('node:crypto').getCiphers().includes('aes-256-gcm')`.
15+
</Callout>
1216

1317
```sh tab="npm"
1418
npm install @discordjs/voice
@@ -58,6 +62,14 @@ After this, you'll be able to play Ogg and WebM Opus files without any other dep
5862
- [`@noble/ciphers`](https://www.npmjs.com/package/@noble/ciphers)
5963
- [`libsodium-wrappers`](https://www.npmjs.com/package/libsodium-wrappers)
6064

65+
#### DAVE Protocol Support
66+
67+
- [`@snazzah/davey`](https://www.npmjs.com/package/@snazzah/davey) - to enable end-to-end encryption with the DAVE protocol.
68+
69+
<Callout>
70+
Some Discord clients already require the DAVE protocol for end-to-end encryption in voice chat. Ensure you have `@snazzah/davey` installed to avoid compatibility issues, as `@snazzah/davey` is only set as a dev-dependency for `@discordjs/voice` and may not install in production environments without explicit installation.
71+
</Callout>
72+
6173
<Callout>
6274
If you are facing issues when installing these dependencies, make sure you ticked the box to install optional build
6375
tools when installing Node.js or try manually installing build tools and python: ```sh winget install "Visual Studio
@@ -91,6 +103,9 @@ Encryption Libraries
91103
FFmpeg
92104
- version: 4.2.4-1ubuntu0.1
93105
- libopus: yes
106+
107+
DAVE Protocol
108+
- @snazzah/davey: 0.1.6
94109
--------------------------------------------------
95110
*/
96111
```
@@ -104,3 +119,5 @@ FFmpeg
104119
- **FFmpeg**
105120
- If you want to play audio from many different file types, you will need to have FFmpeg installed.
106121
- If `libopus` is enabled, you will be able to benefit from increased performance if real-time volume alteration is disabled.
122+
- **DAVE Protocol**
123+
- Required for enabling end-to-end encryption in voice channels.

0 commit comments

Comments
 (0)