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
  11 You need to create a folder for all your music. Organize your music by subfolder.
  12 The main folder need to be declare into the config (with a '/' at the end)
  13
  14 #### Installation
  15 1. You need python 3 with opuslib and protobuf (look at the requirement of pymumble)
  16    (Hint pyenv is a good start to get the requirements, search pyenv-installer)
  17 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.
  18
  19 commands (don't forget the sudo mode):
  20 ```
  21 pip3 install opuslib
  22 pip3 install protobuf
  23 pip3 install flask
  24 apt-get install ffmpeg
  25 git clone --recurse-submodules https://github.com/azlux/MumbleRadioPlayer.git
  26 cd ./MumbleRadioPlayer
  27 chmod +x ./mumbleRadioPlayer.py
  28 ```
  29
  30 #### Starting the bot
  31 ./mumbleBot.py -s HOST -u BOTNAME -P PASSWORD -p PORT -c CHANNEL
  32
  33 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.
  34
  35
  36 2.TODO list
  37
  38 ### TODOLIST
  39
  40 #### Features
  41 - [ ] Next song
  42 - [ ] Previous song
  43 - [x] Randomizer
  44 - [ ] Looking for songs previously downloaded in a folder by users.
  45
  46 #### Commands with the interface
  47 - [x] list
  48 - [x] play
  49 - [x] playfolder
  50 - [x] random
  51
  52 #### Commands by message to the bot
  53 - [x] volume
  54 - [ ] skip
  55 - [x] stop
  56 - [x] joinme
  57 - [x] away
  58
  59 #### Web Interface
  60 - [x] Primary functions
  61 - [ ] CSS
  62