Installation

"Voice" refers to Discord bots being able to send audio in voice channels. This is supported in discord.js via @discordjs/voice, a standalone library made by the developers of discord.js. While you can use it with any Node.js Discord API library, this guide will focus on using it with discord.js.

Barebones

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:

You can verify aes-256-gcm support by running require('node:crypto').getCiphers().includes('aes-256-gcm').

npm install @discordjs/voice

After this, you'll be able to play Ogg and WebM Opus files without any other dependencies. If you want to play audio from other sources, or want to improve performance, consider installing some of the extra dependencies listed below.

This guide assumes you have installed at least FFmpeg for all the examples to work. You can find more information about extra dependencies in the next section.

Extra Dependencies

Opus encoding

@discordjs/opus (best performance)
opusscript

FFmpeg – allows you to play a range of media (e.g. MP3s).

ffmpeg - install and add to your system environment
ffmpeg-static - to install FFmpeg via npm

Encryption libraries

You only need to install one of these libraries if your system does not support aes-256-gcm. You can verify this by running require('node:crypto').getCiphers().includes('aes-256-gcm')

DAVE Protocol Support for end-to-end encryption of voice audio

@snazzah/davey

At this time, @snazzah/davey is the only supported DAVE protocol library in this package, and comes pre-installed. In the future, we may support other libraries once they are created.

If you are facing issues when installing these dependencies, make sure you ticked the box to install optional build tools when installing Node.js or try manually installing build tools and python: sh winget install "Visual Studio Community 2022" --override "--add Microsoft.VisualStudio.Workload.NativeDesktop " -s msstore

Debugging Dependencies

The library includes a helper function that helps you to find out which dependencies you've successfully installed. This information is also very helpful if you ever need to submit an issue on the @discordjs/voice issue tracker.

const { generateDependencyReport } = require('@discordjs/voice');

console.log(generateDependencyReport());

/*
--------------------------------------------------
Core Dependencies
- @discordjs/voice: 0.3.1
- prism-media: 1.2.9

Opus Libraries
- @discordjs/opus: 0.5.3
- opusscript: not found

Encryption Libraries
- sodium: 3.0.2
- libsodium-wrappers: not found
- tweetnacl: not found

FFmpeg
- version: 4.2.4-1ubuntu0.1
- libopus: yes

DAVE Protocol
- @snazzah/davey: 0.1.6
--------------------------------------------------
*/

Core Dependencies
- These are dependencies that should definitely be available.
Opus Libraries
- If you want to play audio from many different file types, or alter volume in real-time, you will need to have one of these.
Encryption Libraries
- You should have at least one encryption library installed to use @discordjs/voice.
FFmpeg
- If you want to play audio from many different file types, you will need to have FFmpeg installed.
- If libopus is enabled, you will be able to benefit from increased performance if real-time volume alteration is disabled.
DAVE Protocol
- Required for enabling end-to-end encryption in voice channels.

Installation

On this page