README.md

   1 # botamusique
   2 [Version Française ici](README.fr.md)
   3
   4 ======
   5
   6 Botamusique is a mumble bot which goal is to allow users to listen music together with its audio output.
   7 Predicted functionnalities will be the one you could expect from any classic music player.
   8
   9 1. Where to start
  10 You need to create a folder for all your music. Organize your music by subfolder.
  11 The main folder need to be declare into the config (with a '/' at the end)
  12
  13 #### Installation
  14 1. You need python 3 with opuslib and protobuf (look at the requirement of pymumble)
  15    (Hint pyenv is a good start to get the requirements, search pyenv-installer)
  16 2. The Bot use ffmpeg, so you know what you have to do if ffmpeg aren't in your package manager. I personally use [this repository](http://repozytorium.mati75.eu/) on my raspberry.
  17
  18 commands (don't forget the sudo mode):
  19 ```
  20 pip3 install opuslib
  21 pip3 install protobuf
  22 pip3 install flask
  23 apt-get install ffmpeg
  24 git clone --recurse-submodules https://github.com/azlux/MumbleRadioPlayer.git
  25 cd ./MumbleRadioPlayer
  26 chmod +x ./mumbleRadioPlayer.py
  27 ```
  28
  29 #### Starting the bot
  30 ./mumbleBot.py -s HOST -u BOTNAME -P PASSWORD -p PORT -c CHANNEL
  31
  32 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.
  33
  34
  35 2.TODO list
  36
  37 ### TODOLIST
  38
  39 #### Features
  40 - [ ] Next song
  41 - [ ] Previous song
  42 - [x] Randomizer
  43 - [ ] Looking for songs previously downloaded in a folder by users.
  44
  45 #### Commands with the interface
  46 - [x] list
  47 - [x] play
  48 - [x] playfolder
  49 - [x] random
  50
  51 #### Commands by message to the bot
  52 - [x] volume
  53 - [ ] skip
  54 - [x] stop
  55 - [x] joinme
  56 - [x] away
  57
  58 #### Web Interface
  59 - [x] Primary functions
  60 - [ ] CSS
  61
  62 The web interface listen the 8181 port !