README.md

   1 # botaradio
   2
   3 Botaradio is a fork of botamusique, a [Mumble](https://www.mumble.info/) music bot.
   4 Its functionalities are those people would expect from any classic music player,
   5 Botaradio is itself focused on functionalities expected in a broadcast radio
   6 context.
   7
   8 References to Botamusique are still present all around the source code, and
   9 this document, they pretty much apply.
  10
  11
  12 ## Features
  13
  14 1. **Support multiple music sources:**
  15     - Music in local folders (which can be uploaded through the web interface).
  16     - Youtube/Soundcloud URLs and playlists (everything supported by youtube-dl).
  17     - Radio stations from URL and http://www.radio-browser.info API (query from > 24k stations).
  18 2. **User-friendly web remote control interface.** Powered by Flask. Which supports
  19     - Playlist management,
  20     - File management,
  21     - Upload files, etc.
  22 3. **Powerful command system.** Commands and words the bot says are fully customizable. Support partial-match for commands.
  23 4. **Ducking.** The bot would automatically lower its volume if people are talking.
  24
  25
  26 ## Screenshots
  27
  28 ![botamusique in Mumble channel](https://user-images.githubusercontent.com/2306637/75210917-68fbf680-57bd-11ea-9cf8-c0871edff13f.jpg)
  29
  30 ![botamusique web interface](https://user-images.githubusercontent.com/2306637/75210648-9b592400-57bc-11ea-851a-c56907acf702.jpg)
  31
  32
  33 -----
  34 ## Menu
  35 1. [Installation](#installation)
  36 1. [Configuration](#configuration)
  37 1. [Web Interface](#web-interface)
  38 1. [Starting the bot](#starting-the-bot)
  39 1. [Update](#update)
  40 1. [Known issues](#known-issues)
  41 1. [Contributors](#contributors)
  42
  43 ### Installation
  44
  45 #### Dependencies
  46 1. Install python3.
  47 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).
  48 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.
  49
  50 #### Install botamusique
  51 Stable release (**recommended**):
  52 ```
  53 curl -Lo botamusique.tar.gz http://packages.azlux.fr/botamusique/sources.tar.gz
  54 tar -xzf botamusique.tar.gz
  55 cd botamusique
  56 python3 -m venv venv
  57 venv/bin/pip install wheel
  58 venv/bin/pip install -r pymumble/requirements.txt
  59 venv/bin/pip install -r requirements.txt
  60 ```
  61
  62 Testing version (from master):
  63 ```
  64 git clone --recurse-submodules https://github.com/azlux/botamusique.git
  65 cd botamusique
  66 python3 -m venv venv
  67 venv/bin/pip install wheel
  68 venv/bin/pip install -r pymumble/requirements.txt
  69 venv/bin/pip install -r requirements.txt
  70 ```
  71
  72
  73 ### Configuration
  74 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.
  75
  76 #### Basic settings
  77 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.
  78 ```
  79 [server]
  80 host = 127.0.0.1
  81 port = 64738
  82 ````
  83
  84 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.
  85 ```
  86 [bot]
  87 music_folder = music_folder/
  88 tmp_folder = /tmp/
  89 ```
  90
  91 #### Sections explained
  92 - `server`: configuration about the server. This will be overridden by the `./mumbleBot.py` parameters.
  93 - `bot`: basic configuration of the bot, eg. name, comment, folder, default volume, etc.
  94 - `webinterface`: basic configuration about the interface.
  95 - `commands`: you can customize the command you want for each action (eg. put `help = helpme` , the bot will respond to `!helpme`)
  96 - `radio`: a list of default radio (eg. play a jazz radio with the command `!radio jazz`)
  97 - `strings`: you can customize all words the bot can say.
  98 - `debug`: option to activate ffmpeg or pymumble debug. (Can be very verbose)
  99
 100 #### (Optional) Generate a certificate
 101 Otherwise, you wouldn't able to register the bot into your Murmur server.
 102 Please do the following:
 103 `openssl req -x509 -nodes -days 3650 -newkey rsa:2048 -keyout botamusique.pem -out botamusique.pem -subj "/CN=botamusique"`
 104
 105
 106 ### Web interface
 107 **Disabled by default** for performance and security reasons. You need to enable it in `configuration.ini`.
 108 ```
 109 [webinterface]
 110 enabled = True
 111 ```
 112
 113 Default binding address is
 114 ```
 115 listening_addr = 127.0.0.1
 116 listening_port = 8181
 117 ```
 118
 119 You can access the web interface through http://127.0.0.1:8181 if you keep it unchanged.
 120
 121 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.
 122
 123
 124 ### Starting the bot
 125 If you have set up everything in your `configuration.ini`, you can
 126 `venv/bin/python mumbleBot.py --config configuration.ini`
 127
 128 Or you can
 129 `venv/bin/python mumbleBot.py -s HOST -u BOTNAME -P PASSWORD -p PORT -c CHANNEL -C /path/to/botamusique.pem`
 130
 131 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).
 132
 133 **For the detailed manual of using botamusique, please see the [wiki](https://github.com/azlux/botamusique/wiki).**
 134
 135
 136 ### Update
 137 If you enable `audo_check_update`, the bot will check for updates every time it starts.
 138 If you are using the recommended install, you can send `!update` to the bot (command by default).
 139
 140 If you are using git, you need to update manually:
 141 ```
 142 git pull --all
 143 git submodule update
 144 venv/bin/pip install --upgrade -r requirements.txt
 145 ```
 146
 147
 148 ### Known Issues
 149
 150 1. During installation, you may encounter the following error:
 151 ```
 152 ImportError: libtiff.so.5: cannot open shared object file: No such file or directory
 153 ```
 154 You need to install a missing library: `apt install libtiff5`
 155
 156 2. In the beginning, you may encounter the following error even if you have installed all requirements:
 157 ```
 158 Exception: Could not find opus library. Make sure it is installed.
 159 ```
 160 You need to install the opus codec (not embedded in all system): `apt install libopus0`
 161
 162
 163 ### Contributors (botamusique)
 164 If you want to participate, You're welcome to fork and submit pull requests (fixes and new features).
 165
 166 The following people joined the collaborators for a faster development, big thanks to them:
 167 - @TerryGeng
 168 - @mertkutay
 169
 170 Feel free to ask me if you want to help actively without using pull requests.