diff --git a/README.md b/README.md index 1a3e4472d..c5f336cba 100644 --- a/README.md +++ b/README.md @@ -16,12 +16,14 @@ discord.js is a powerful node.js module that allows you to interact with the [Di ## Installation **Node.js 6.0.0 or newer is required.** -With voice support: `npm install --save discord.js --production` -Without voice support: `npm install --save discord.js --production --no-optional` +Without voice support: `npm install discord.js --save --production` +With voice support ([node-opus](https://www.npmjs.com/package/node-opus)): `npm install discord.js node-opus --save --production` +With voice support ([opusscript](https://www.npmjs.com/package/opusscript)): `npm install discord.js opusscript --save --production` +If both audio packages are installed, discord.js will automatically choose node-opus. -By default, discord.js uses [opusscript](https://www.npmjs.com/package/opusscript) when playing audio over voice connections. -If you're looking to play over multiple voice connections, it might be better to install [node-opus](https://www.npmjs.com/package/node-opus). -discord.js will automatically prefer node-opus over opusscript. +The preferred audio engine is node-opus, as it performs significantly better than opusscript. +Using opusscript is only recommended for development on Windows, since getting node-opus to build there can be a bit of a challenge. +For production bots, using node-opus should be considered a necessity, especially if they're going to be running on multiple servers. ## Example Usage ```js diff --git a/docs/custom/documents/welcome.md b/docs/custom/documents/welcome.md index 74483b166..f51e3c512 100644 --- a/docs/custom/documents/welcome.md +++ b/docs/custom/documents/welcome.md @@ -20,12 +20,14 @@ stable and performant than previous versions. ## Installation **Node.js 6.0.0 or newer is required.** -With voice support: `npm install --save discord.js --production` -Without voice support: `npm install --save discord.js --production --no-optional` +Without voice support: `npm install discord.js --save --production` +With voice support ([node-opus](https://www.npmjs.com/package/node-opus)): `npm install discord.js node-opus --save --production` +With voice support ([opusscript](https://www.npmjs.com/package/opusscript)): `npm install discord.js opusscript --save --production` +If both audio packages are installed, discord.js will automatically prefer node-opus. -By default, discord.js uses [opusscript](https://www.npmjs.com/package/opusscript) when playing audio over voice connections. -If you're looking to play over multiple voice connections, it might be better to install [node-opus](https://www.npmjs.com/package/node-opus). -discord.js will automatically prefer node-opus over opusscript. +The preferred audio engine is node-opus, as it performs significantly better than opusscript. +Using opusscript is only recommended for development on Windows, since getting node-opus to build there can be a bit of a challenge. +For production bots, using node-opus should be considered a necessity, especially if they're going to be running on multiple servers. ## Guides * [LuckyEvie's general guide](https://eslachance.gitbooks.io/discord-js-bot-guide/content/) diff --git a/package.json b/package.json index 9d5e24950..3fb7ed856 100644 --- a/package.json +++ b/package.json @@ -28,7 +28,10 @@ "dependencies": { "superagent": "^2.2.0", "tweetnacl": "^0.14.3", - "ws": "^1.1.1", + "ws": "^1.1.1" + }, + "peerDependencies": { + "node-opus": "^0.2.1", "opusscript": "^0.0.1" }, "devDependencies": { @@ -36,9 +39,6 @@ "jsdoc-parse": "^1.2.0", "eslint": "^3.4.0" }, - "optionalDependencies": { - "node-opus": "^0.2.1" - }, "engines": { "node": ">=6.0.0" }