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 Bot the can play :
  23 - Radio url
  24 - Youtube/Soundcloud URL (everything supported by youtube-dl)
  25 - Local folder (disabled, I need to work on the web interface)
  26
  27 #### Web interface
  28 * 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.
  29
  30 You need to create a folder for all your music. Organize your music by subfolder.
  31 The main folder need to be declare into the config (with a '/' at the end)
  32
  33 #### Installation
  34 1. You need python 3 with opuslib and protobuf (look at the requirement of pymumble)
  35 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.
  36
  37 commands (don't forget the sudo mode):
  38 ```
  39 apt install python3-pip
  40 apt install ffmpeg
  41 apt install youtube-dl
  42 git clone --recurse-submodules https://github.com/azlux/botamusique.git
  43 cd ./botamusique
  44 pip3 install -r requirements.txt
  45 chmod +x ./mumbleBot.py
  46 ```
  47
  48 #### Starting the bot
  49 `./mumbleBot.py -s HOST -u BOTNAME -P PASSWORD -p PORT -c CHANNEL`
  50
  51 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)
  52
  53
  54 2.TODO list
  55
  56 ### TODOLIST
  57
  58 Check the issue #3