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 Bot the can play :
  10 - Radio url
  11 - Youtube/Soundcloud URL (everything supported by youtube-dl)
  12 - Local folder (disabled, I need to work on the web interface)
  13
  14 #### Web interface
  15 * 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.
  16
  17 You need to create a folder for all your music. Organize your music by subfolder.
  18 The main folder need to be declare into the config (with a '/' at the end)
  19
  20 #### Installation
  21 1. You need python 3 with opuslib and protobuf (look at the requirement of pymumble)
  22 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.
  23
  24 commands (don't forget the sudo mode):
  25 ```
  26 apt-get install python3-pip
  27 pip3 install opuslib
  28 pip3 install protobuf
  29 pip3 install flask
  30 apt-get install ffmpeg
  31 git clone --recurse-submodules https://github.com/azlux/botamusique.git
  32 cd ./botamusique
  33 chmod +x ./mumbleBot.py
  34 ```
  35
  36 #### Starting the bot
  37 ./mumbleBot.py -s HOST -u BOTNAME -P PASSWORD -p PORT -c CHANNEL
  38
  39 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)
  40
  41
  42 2.TODO list
  43
  44 ### TODOLIST
  45
  46 #### Features
  47 - [x] Next song
  48 - [x] Randomizer
  49 - [ ]Graphical interface
  50
  51 #### Commands with the interface (disabled)
  52 - [x] list
  53 - [x] play
  54 - [x] playfolder
  55 - [x] random
  56
  57 #### Commands by message to the bot
  58 - [x] volume
  59 - [x] next
  60 - [x] stop
  61 - [x] joinme
  62 - [x] away
  63 - [x] help
  64
  65 #### Web Interface (disabled for now)
  66 - [x] Primary functions
  67 - [ ] CSS
  68