README.md

   1 # botamusique
   2
   3 Botamusique is a mumble bot which goal is to allow users to listen music together with its audio output.
   4 Predicted functionalities will be ones you could expect from any classic music player.
   5
   6 Bot the can play :
   7 - Radio url
   8 - Youtube/Soundcloud URL (everything supported by youtube-dl)
   9 - Local folder (disabled, I need to work on the web interface)
  10
  11 -----
  12
  13 ### Web interface
  14 * Disable * I need to work on it. Since I use this bot for radio, youtube/soundcloud and folder music, the web interace isn't ready.
  15
  16 You need to create a folder for all your music. Organize your music by subfolder.
  17 The main folder needs to be declared in the config (with a '/' at the end)
  18 You can enable the web interface into the configuration.ini file.
  19
  20 ### Installation
  21 1. You need python 3 with opuslib and protobuf (look at the requirement of pymumble)
  22 2. The Bot uses ffmpeg, so you know what you have to do if ffmpeg isn't in your package manager. I personally use [this repository](http://repozytorium.mati75.eu/) on my raspberry.
  23
  24 Example installation commands for Debian and Ubuntu:
  25 ```
  26 # apt install python3-venv
  27 # apt install ffmpeg
  28 $ git clone --recurse-submodules https://github.com/azlux/botamusique.git
  29 $ cd botamusique
  30 $ python3 -m venv venv
  31 $ venv/bin/pip install wheel
  32 $ venv/bin/pip install -r requirements.txt
  33 ```
  34
  35 ### Starting the bot
  36 `$ venv/bin/python mumbleBot.py -s HOST -u BOTNAME -P PASSWORD -p PORT -c CHANNEL`
  37
  38 The bot listen to the 8181 port so you should redirect to this one in you NAT configuration to let others peoples access the web interface. (DISABLED)
  39
  40 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)
  41
  42 ### Custom commands
  43 You can copy the file `configuration.default.ini` to `configuration.ini` and customize all variable. Everything can be change but don't remove the default file.
  44
  45 you have the section :
  46 - server : configuration about the server and bot name. This is overrided by the `./mumbleBot.py` parameters.
  47 - bot : basic configuration of the bot : comment, folder, volume at start ....
  48 - webinterface : basic configuration about the interface (disabled by default)
  49 - command : you can customize the command you want for each action (if you put `help = helpme` , the bot will response to `!helpme` )
  50 - radio : here you can have a list of default radio ( I can play a jazz radio with the command `!radio jazz`)
  51 - strings : you can customize all string the bot can say.
  52 - debug : option to active ffmpeg or pymumble debug. (Can be very verbose)
  53
  54
  55 ### TODOLIST
  56
  57 Check the issue #3