-# botamusique
+# botaradio
+
+Botaradio is a fork of botamusique, a [Mumble](https://www.mumble.info/) music bot.
+Its functionalities are those people would expect from any classic music player,
+Botaradio is itself focused on functionalities expected in a broadcast radio
+context.
+
+References to Botamusique are still present all around the source code, and
+this document, they pretty much apply.
-Botamusique is a [Mumble](https://www.mumble.info/) 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 from http://www.radio-browser.info API (query from > 24k stations).
-2. **User-friendly web remote control interface.** Powered by flask. Which supports
+ - 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](#installation)
1. [Configuration](#configuration)
1. [Web Interface](#web-interface)
1. [Starting the bot](#starting-the-bot)
-1. [Update](#udpate)
+1. [Update](#update)
1. [Known issues](#known-issues)
1. [Contributors](#contributors)
#### Dependencies
1. Install python3.
-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 you package manager).
+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).
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.
#### Install botamusique
-Stable release (**recommended**, with build-in auto-update support):
+Stable release (**recommended**):
```
-curl -Lo botamusique.tar.gz https://azlux.fr/botamusique/sources.tar.gz
+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 -r requirements.txt
```
-For the version of the master branch (no build-in auto-update support):
+Testing version (from master):
```
git clone --recurse-submodules https://github.com/azlux/botamusique.git
cd botamusique
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 settints
-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.
+#### 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
- `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.
+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`.
```
enabled = True
```
-Note: Listening to address `127.0.0.1` will only accept requests from localhost. If you would to accept requests from public internet, you need to set it to `0.0.0.0`, and set up username and password to impose access control.
+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`
-The bot listens the 8181 port so you should properly set the forwarding rules in you NAT configuration to let other peoples access the web interface. (DISABLED)
+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).
+
+**For the detailed manual of using botamusique, please see the [wiki](https://github.com/azlux/botamusique/wiki).**
-If you want information about autoStart and auto-Restart the bot, [you can have help on the wiki.](https://github.com/azlux/botamusique/wiki/AutoStart---AutoRestart)
### Update
If you enable `audo_check_update`, the bot will check for updates every time it starts.
git submodule update
venv/bin/pip install --upgrade -r requirements.txt
```
+
+
### Known Issues
1. During installation, you may encounter the following error:
```
You need to install the opus codec (not embedded in all system): `apt install libopus0`
-### Contributors
+
+### Contributors (botamusique)
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:
projects / botaradio.git / blobdiff