README.md

   1 # botamusique
   2
   3 ======
   4
   5 Botamusique is a mumble bot which goal is to allow users to listen music together with its audio output.
   6 Predicted functionalities will be ones you could expect from any classic music player.
   7
   8 Bot the can play :
   9 - Radio url
  10 - Youtube/Soundcloud URL (everything supported by youtube-dl)
  11 - Local folder (disabled, I need to work on the web interface)
  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
  19 #### Installation
  20 1. You need python 3 with opuslib and protobuf (look at the requirement of pymumble)
  21 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.
  22
  23 Example installation commands for Debian and Ubuntu:
  24 ```
  25 # apt install python3-venv
  26 # apt install ffmpeg
  27 $ git clone --recurse-submodules https://github.com/azlux/botamusique.git
  28 $ cd botamusique
  29 $ python3 -m venv venv
  30 $ venv/bin/pip install wheel
  31 $ venv/bin/pip install -r requirements.txt
  32 ```
  33
  34 #### Starting the bot
  35 `$ venv/bin/python mumbleBot.py -s HOST -u BOTNAME -P PASSWORD -p PORT -c CHANNEL`
  36
  37 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)
  38
  39 #### Custom commands
  40 You can copy the file `configuration.default.ini` to `configuration.ini` and customize all variable.
  41 you have the section :
  42 - bot : basic configuration of the bot : comment, folder, volume at start ....
  43 - command : you can customize the command you want for each action (if you put `help = helpme` , the bot will response to `!helpme` )
  44 - radio : here you can have a list of default radio ( I can play a jazz radio with the command `!radio jazz`)
  45 - strings : you can customize all string the bot can say.
  46
  47
  48 2.TODO list
  49
  50 ### TODOLIST
  51
  52 Check the issue #3