Skip to content

Commit 180dd60

Browse files
jNulljalmeidxJiralite
authored
feat(voice): Add info about DAVE protocol dependencies and support (#11145)
* Add info about DAVE protocol dependencies and support Changes remade from discordjs/guide#1630 due to project moving from that repo to this one. * remove explicit warning regarding optional dependency being optional Co-authored-by: Almeida <[email protected]> * style: format --------- Co-authored-by: Almeida <[email protected]> Co-authored-by: Jiralite <[email protected]>
1 parent dd79525 commit 180dd60

File tree

1 file changed

+19
-1
lines changed

1 file changed

+19
-1
lines changed

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

Lines changed: 19 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,15 @@ 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
71+
`@snazzah/davey` installed to avoid compatibility issues.
72+
</Callout>
73+
6174
<Callout>
6275
If you are facing issues when installing these dependencies, make sure you ticked the box to install optional build
6376
tools when installing Node.js or try manually installing build tools and python: ```sh winget install "Visual Studio
@@ -91,6 +104,9 @@ Encryption Libraries
91104
FFmpeg
92105
- version: 4.2.4-1ubuntu0.1
93106
- libopus: yes
107+
108+
DAVE Protocol
109+
- @snazzah/davey: 0.1.6
94110
--------------------------------------------------
95111
*/
96112
```
@@ -104,3 +120,5 @@ FFmpeg
104120
- **FFmpeg**
105121
- If you want to play audio from many different file types, you will need to have FFmpeg installed.
106122
- If `libopus` is enabled, you will be able to benefit from increased performance if real-time volume alteration is disabled.
123+
- **DAVE Protocol**
124+
- Required for enabling end-to-end encryption in voice channels.

0 commit comments

Comments
 (0)