herhde/botamusique

Bot to play youtube / soundcloud / radio / local music on Mumble (using pymumble).

botamusique

Botamusique is a Mumble music bot. Predicted functionalities will be those people would expect from any classic music player.

Features

1. Support multiple music sources:
   • Music in local folders (which can be uploaded through the web interface).
   • Youtube/Soundcloud URLs and playlists (everything supported by youtube-dl).
   • Radio stations from URL and http://www.radio-browser.info API (query from > 24k stations).
2. User-friendly web remote control interface. Powered by Flask. Which supports
   • Playlist management,
   • File management,
   • Upload files, etc.
3. Powerful command system. Commands and words the bot says are fully customizable. Support partial-match for commands.
4. Ducking. The bot would automatically lower its volume if people are talking.

Screenshots

---

Menu

1. Installation
2. Configuration
3. Web Interface
4. Starting the bot
5. Update
6. Known issues
7. Contributors

Installation

Dependencies

1. Install python3.
2. Install Opus Codec (which should be already installed if you installed Mumble or Murmur, or you may try to install opus-tools with your package manager).
3. Install ffmpeg. If ffmpeg isn't in your package manager, you may need to find another source. I personally use this repository on my raspberry.

Install botamusique

Stable release (recommended):

curl -Lo botamusique.tar.gz http://packages.azlux.fr/botamusique/sources.tar.gz
tar -xzf botamusique.tar.gz
cd botamusique
python3 -m venv venv
venv/bin/pip install wheel
venv/bin/pip install -r pymumble/requirements.txt
venv/bin/pip install -r requirements.txt

Testing version (from master):

git clone --recurse-submodules https://github.com/azlux/botamusique.git
cd botamusique
python3 -m venv venv
venv/bin/pip install wheel
venv/bin/pip install -r pymumble/requirements.txt
venv/bin/pip install -r requirements.txt

Configuration

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.

Basic settings

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.

[server]
host = 127.0.0.1
port = 64738

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.

[bot]
music_folder = music_folder/
tmp_folder = /tmp/

Sections explained

• server: configuration about the server. This will be overridden by the ./mumbleBot.py parameters.
• bot: basic configuration of the bot, eg. name, comment, folder, default volume, etc.
• webinterface: basic configuration about the interface.
• commands: you can customize the command you want for each action (eg. put help = helpme , the bot will respond to !helpme)
• radio: a list of default radio (eg. play a jazz radio with the command !radio jazz)
• strings: you can customize all words the bot can say.
• debug: option to activate ffmpeg or pymumble debug. (Can be very verbose)

(Optional) Generate a certificate

Otherwise, you wouldn't able to register the bot into your Murmur server. Please do the following: openssl req -x509 -nodes -days 3650 -newkey rsa:2048 -keyout botamusique.pem -out botamusique.pem -subj "/CN=botamusique"

Web interface

Disabled by default for performance and security reasons. You need to enable it in configuration.ini.

[webinterface]
enabled = True

Default binding address is

listening_addr = 127.0.0.1
listening_port = 8181

You can access the web interface through http://127.0.0.1:8181 if you keep it unchanged.

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.

Starting the bot

If you have set up everything in your configuration.ini, you can venv/bin/python mumbleBot.py --config configuration.ini

Or you can venv/bin/python mumbleBot.py -s HOST -u BOTNAME -P PASSWORD -p PORT -c CHANNEL -C /path/to/botamusique.pem

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.

For the detailed manual of using botamusique, please see the wiki.

Update

If you enable audo_check_update, the bot will check for updates every time it starts. If you are using the recommended install, you can send !update to the bot (command by default).

If you are using git, you need to update manually:

git pull --all
git submodule update
venv/bin/pip install --upgrade -r requirements.txt

Known Issues

1. During installation, you may encounter the following error:

ImportError: libtiff.so.5: cannot open shared object file: No such file or directory

You need to install a missing library: apt install libtiff5

2. In the beginning, you may encounter the following error even if you have installed all requirements:

Exception: Could not find opus library. Make sure it is installed.

You need to install the opus codec (not embedded in all system): apt install libopus0

Contributors

If you want to participate, You're welcome to fork and submit pull requests (fixes and new features).

The following people joined the collaborators for a faster development, big thanks to them:

• @TerryGeng
• @mertkutay

Feel free to ask me if you want to help actively without using pull requests.