docs: replace all occurances of node-opus with @discordjs/opus (#3698)

* docs: replace all occurances of node-opus with @discordjs/opus

* chore: leave in node-opus in case not everyone switched
This commit is contained in:
Crawl
2020-01-16 14:10:48 +01:00
committed by GitHub
parent d096e40f6f
commit 6a0fe467e5
6 changed files with 19 additions and 18 deletions

View File

@@ -6,13 +6,13 @@ In discord.js, you can use voice by connecting to a `VoiceChannel` to obtain a `
To get started, make sure you have:
* FFmpeg - `npm install ffmpeg-static`
* an opus encoder, choose one from below:
* `npm install node-opus` (better performance)
* `npm install @discordjs/opus` (better performance)
* `npm install opusscript`
* a good network connection
The preferred opus 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.
The preferred opus engine is @discordjs/opus, as it performs significantly better than opusscript. When both are available, discord.js will automatically choose @discordjs/opus.
Using opusscript is only recommended for development environments where @discordjs/opus is tough to get working.
For production bots, using @discordjs/opus should be considered a necessity, especially if they're going to be running on multiple servers.
## Joining a voice channel
The example below reacts to a message and joins the sender's voice channel, catching any errors. This is important