3 Botamusique is a [Mumble](https://www.mumble.info/) music bot.
4 Predicted functionalities will be those people would expect from any classic music player.
9 1. **Support multiple music sources:**
10 - Music in local folders (which can be uploaded through the web interface).
11 - Youtube/Soundcloud URLs and playlists (everything supported by youtube-dl).
12 - Radio stations from URL and http://www.radio-browser.info API (query from > 24k stations).
13 2. **User-friendly web remote control interface.** Powered by Flask. Which supports
14 - Playlist management,
17 3. **Powerful command system.** Commands and words the bot says are fully customizable. Support partial-match for commands.
18 4. **Ducking.** The bot would automatically lower its volume if people are talking.
23 ![botamusique in Mumble channel](https://user-images.githubusercontent.com/2306637/75210917-68fbf680-57bd-11ea-9cf8-c0871edff13f.jpg)
25 ![botamusique web interface](https://user-images.githubusercontent.com/2306637/75210648-9b592400-57bc-11ea-851a-c56907acf702.jpg)
30 1. [Installation](#installation)
31 1. [Configuration](#configuration)
32 1. [Web Interface](#web-interface)
33 1. [Starting the bot](#starting-the-bot)
35 1. [Known issues](#known-issues)
36 1. [Contributors](#contributors)
42 1. Install [Opus Codec](https://www.opus-codec.org/) (which should be already installed if you installed Mumble or Murmur, or you may try to install `opus-tools` with your package manager).
43 1. Install ffmpeg. If ffmpeg isn't in your package manager, you may need to find another source. I personally use [this repository](http://repozytorium.mati75.eu/) on my raspberry.
45 #### Install botamusique
46 Stable release (**recommended**):
48 curl -Lo botamusique.tar.gz http://packages.azlux.fr/botamusique/sources.tar.gz
49 tar -xzf botamusique.tar.gz
52 venv/bin/pip install wheel
53 venv/bin/pip install -r pymumble/requirements.txt
54 venv/bin/pip install -r requirements.txt
57 Testing version (from master):
59 git clone --recurse-submodules https://github.com/azlux/botamusique.git
62 venv/bin/pip install wheel
63 venv/bin/pip install -r pymumble/requirements.txt
64 venv/bin/pip install -r requirements.txt
69 Please copy `configuration.example.ini` into `configuration.ini`, follow the instructions in the file and uncomment options you would like to modify. Please DO NOT MODIFY `configuration.default.ini`, since options undefined in `configuration.ini` will fall back into `configuration.default.ini`. This file will be constantly overridden in each update.
72 1. Usually, the first thing is to set the Murmur server you'd like the bot to connect to. You may also specify which channel the bot stays, and tokens used by the bot.
79 2. You need to specify a folder that stores your music file. The bot will look for music and upload files into that folder. You also need to specify a temporary folder to store music files download from URLs.
82 music_folder = music_folder/
86 #### Sections explained
87 - `server`: configuration about the server. This will be overridden by the `./mumbleBot.py` parameters.
88 - `bot`: basic configuration of the bot, eg. name, comment, folder, default volume, etc.
89 - `webinterface`: basic configuration about the interface.
90 - `commands`: you can customize the command you want for each action (eg. put `help = helpme` , the bot will respond to `!helpme`)
91 - `radio`: a list of default radio (eg. play a jazz radio with the command `!radio jazz`)
92 - `strings`: you can customize all words the bot can say.
93 - `debug`: option to activate ffmpeg or pymumble debug. (Can be very verbose)
95 #### (Optional) Generate a certificate
96 Otherwise, you wouldn't able to register the bot into your Murmur server.
97 Please do the following:
98 `openssl req -x509 -nodes -days 3650 -newkey rsa:2048 -keyout botamusique.pem -out botamusique.pem -subj "/CN=botamusique"`
102 **Disabled by default** for performance and security reasons. You need to enable it in `configuration.ini`.
108 Default binding address is
110 listening_addr = 127.0.0.1
111 listening_port = 8181
114 You can access the web interface through http://127.0.0.1:8181 if you keep it unchanged.
116 Note: Listening to address `127.0.0.1` will only accept requests from localhost. If you would like to accept requests from the public internet, you need to set it to `0.0.0.0`, and set up username and password to impose access control. In addition, if the bot is behind a router, you should also properly set forwarding rules in you NAT configuration to forward requests to your router to the bot.
120 If you have set up everything in your `configuration.ini`, you can
121 `venv/bin/python mumbleBot.py --config configuration.ini`
124 `venv/bin/python mumbleBot.py -s HOST -u BOTNAME -P PASSWORD -p PORT -c CHANNEL -C /path/to/botamusique.pem`
126 If you want information about auto-starting and auto-restarting of the bot, you can check out the wiki page [Run botamusique as a daemon In the background](https://github.com/azlux/botamusique/wiki/Run-botamusique-as-a-daemon-In-the-background).
128 **For the detailed manual of using botamusique, please see the [wiki](https://github.com/azlux/botamusique/wiki).**
132 If you enable `audo_check_update`, the bot will check for updates every time it starts.
133 If you are using the recommended install, you can send `!update` to the bot (command by default).
135 If you are using git, you need to update manually:
139 venv/bin/pip install --upgrade -r requirements.txt
145 1. During installation, you may encounter the following error:
147 ImportError: libtiff.so.5: cannot open shared object file: No such file or directory
149 You need to install a missing library: `apt install libtiff5`
151 2. In the beginning, you may encounter the following error even if you have installed all requirements:
153 Exception: Could not find opus library. Make sure it is installed.
155 You need to install the opus codec (not embedded in all system): `apt install libopus0`
159 If you want to participate, You're welcome to fork and submit pull requests (fixes and new features).
161 The following people joined the collaborators for a faster development, big thanks to them:
165 Feel free to ask me if you want to help actively without using pull requests.