From a90bd837af62ecdd15311c3e7e95df84825cf62b Mon Sep 17 00:00:00 2001 From: Schuyler Cebulskie Date: Mon, 6 Feb 2017 02:06:01 -0500 Subject: [PATCH] Add sodium to optional packages list --- README.md | 1 + docs/general/welcome.md | 1 + 2 files changed, 2 insertions(+) diff --git a/README.md b/README.md index 574d1366e61d..98ce59637f42 100644 --- a/README.md +++ b/README.md @@ -41,6 +41,7 @@ For production bots, using node-opus should be considered a necessity, especiall ### Optional packages - [bufferutil](https://www.npmjs.com/package/bufferutil) to greatly speed up the `ws` WebSocket connection (`npm install bufferutil --save`) - [erlpack](https://github.com/hammerandchisel/erlpack) for significantly faster WebSocket data (de)serialisation (`npm install hammerandchisel/erlpack --save`) +- [sodium](https://www.npmjs.com/package/sodium) for faster voice packet encryption/decryption (`npm install sodium --save`) - [uws](https://www.npmjs.com/package/uws) for a much faster WebSocket connection (`npm install uws --save`) **Note:** This package does not handle disconnects entirely correctly, which causes automatic reconnection to Discord to not function. If you use this package, it may be wise to destroy + recreate the client entirely or restart the process upon disconnect. diff --git a/docs/general/welcome.md b/docs/general/welcome.md index fa78d57412f7..c9fa38ba34e3 100644 --- a/docs/general/welcome.md +++ b/docs/general/welcome.md @@ -45,6 +45,7 @@ For production bots, using node-opus should be considered a necessity, especiall ### Optional packages - [bufferutil](https://www.npmjs.com/package/bufferutil) to greatly speed up the `ws` WebSocket connection (`npm install bufferutil --save`) - [erlpack](https://github.com/hammerandchisel/erlpack) for significantly faster WebSocket data (de)serialisation (`npm install hammerandchisel/erlpack --save`) +- [sodium](https://www.npmjs.com/package/sodium) for faster voice packet encryption/decryption (`npm install sodium --save`) - [uws](https://www.npmjs.com/package/uws) for a much faster WebSocket connection (`npm install uws --save`) **Note:** This package does not handle disconnects entirely correctly, which causes automatic reconnection to Discord to not function. If you use this package, it may be wise to destroy + recreate the client entirely or restart the process upon disconnect.