README.md

   1 # botamusique
   2
   3 **Info:**
   4
   5 > This is a fork of the official repository (located [here](https://github.com/azlux/botamusique)).
   6 We are working on various features for our own version of the bot. However, we will
   7 regularly merge upstream changes and will also create pull requests to merge back our
   8 features to the upstream repo at some point.
   9
  10 The remainder of this readme is from the original repo.
  11 Note that the ToDo list at the end of the Readme is **outdated** and **not applicable** for this repository.
  12
  13 ---
  14
  15 [Version Française ici](README.fr.md)
  16
  17 ======
  18
  19 Botamusique is a mumble bot which goal is to allow users to listen music together with its audio output.
  20 Predicted functionnalities will be the one you could expect from any classic music player.
  21
  22 1. Where to start
  23
  24 You need to create a folder for all your music. Organize your music by subfolder.
  25 The main folder need to be declare into the config (with a '/' at the end)
  26
  27 #### Installation
  28 1. You need python 3 with opuslib and protobuf (look at the requirement of pymumble)
  29 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.
  30
  31 commands (don't forget the sudo mode):
  32 ```
  33 apt-get install python3-pip
  34 pip3 install opuslib
  35 pip3 install protobuf
  36 pip3 install flask
  37 apt-get install ffmpeg
  38 git clone --recurse-submodules https://github.com/azlux/botamusique.git
  39 cd ./botamusique
  40 chmod +x ./mumbleBot.py
  41 ```
  42
  43 #### Starting the bot
  44 ./mumbleBot.py -s HOST -u BOTNAME -P PASSWORD -p PORT -c CHANNEL
  45
  46 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.
  47
  48
  49 2.TODO list
  50
  51 ### TODOLIST
  52
  53 #### Features
  54 - [ ] Next song
  55 - [ ] Previous song
  56 - [x] Randomizer
  57 - [ ] Looking for songs previously downloaded in a folder by users.
  58
  59 #### Commands with the interface
  60 - [x] list
  61 - [x] play
  62 - [x] playfolder
  63 - [x] random
  64
  65 #### Commands by message to the bot
  66 - [x] volume
  67 - [ ] skip
  68 - [x] stop
  69 - [x] joinme
  70 - [x] away
  71
  72 #### Web Interface
  73 - [x] Primary functions
  74 - [ ] CSS
  75