From 39f7b8dcabae8e5077a1dafbbf0b4eba2768c2ae Mon Sep 17 00:00:00 2001 From: Matthieu Grieger Date: Thu, 1 Jan 2015 07:56:15 -0800 Subject: [PATCH] Add note about CELT --- README.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 5119bee..0b48925 100644 --- a/README.md +++ b/README.md @@ -33,9 +33,10 @@ Reloads `mumbledj.gcfg` to retrieve updated configuration settings. Safely cleans the bot environment and disconnects from the server. Please use this command to stop the bot instead of force closing, as the kill command deletes any remaining songs in the `~/.mumbledj/songs` directory. ## INSTALLATION -Installation for v2 of MumbleDJ is much easier than it was before, due to the reduced dependency list and a `Makefile` which automates some of the process. +Installation for v2 of MumbleDJ is much easier than it was before, due to the reduced dependency list and a `Makefile` which automates some of the process. **NOTE:** This bot was designed for use on Linux machines. If you wish to run the bot on another OS, it will require tweaking and is not something I will be able to help with. +**NOTE #2:** Your Mumble server MUST be using the Opus audio codec, not CELT. Audio will not play if your server uses CELT. **SETUP GUIDE** **1)** Install and correctly configure [`Go`](https://golang.org/) (1.3 or higher). Specifically, make sure to follow [this guide](https://golang.org/doc/code.html) and set the `GOPATH` environment variable properly.