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 apt-get install ffmpeg
  28 git clone --recurse-submodules https://github.com/azlux/botamusique.git
  29 cd ./botamusique
  30 pip3 install -r requirements.txt
  31 chmod +x ./mumbleBot.py
  32 ```
  33
  34 #### Starting the bot
  35 ./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
  40 2.TODO list
  41
  42 ### TODOLIST
  43
  44 #### Features
  45 - [x] Next song
  46 - [x] Randomizer
  47 - [ ]Graphical interface
  48
  49 #### Commands with the interface (disabled)
  50 - [x] list
  51 - [x] play
  52 - [x] playfolder
  53 - [x] random
  54
  55 #### Commands by message to the bot
  56 - [x] volume
  57 - [x] next
  58 - [x] stop
  59 - [x] joinme
  60 - [x] away
  61 - [x] help
  62
  63 #### Web Interface (disabled for now)
  64 - [x] Primary functions
  65 - [ ] CSS
  66