Update README.md

This commit is contained in:
azlux 2018-06-25 18:11:52 +02:00 committed by GitHub
parent fcaee1f504
commit 3412cf0df4
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -1,7 +1,5 @@
# botamusique
======
Botamusique is a mumble bot which goal is to allow users to listen music together with its audio output.
Predicted functionalities will be ones you could expect from any classic music player.
@ -10,13 +8,15 @@ Bot the can play :
- Youtube/Soundcloud URL (everything supported by youtube-dl)
- Local folder (disabled, I need to work on the web interface)
#### Web interface
-----
### Web interface
* 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.
You need to create a folder for all your music. Organize your music by subfolder.
The main folder needs to be declared in the config (with a '/' at the end)
#### Installation
### Installation
1. You need python 3 with opuslib and protobuf (look at the requirement of pymumble)
2. The Bot uses ffmpeg, so you know what you have to do if ffmpeg isn't in your package manager. I personally use [this repository](http://repozytorium.mati75.eu/) on my raspberry.
@ -31,22 +31,26 @@ $ venv/bin/pip install wheel
$ venv/bin/pip install -r requirements.txt
```
#### Starting the bot
### Starting the bot
`$ venv/bin/python mumbleBot.py -s HOST -u BOTNAME -P PASSWORD -p PORT -c CHANNEL`
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)
#### Custom commands
You can copy the file `configuration.default.ini` to `configuration.ini` and customize all variable.
If you want information about autoStart and auto-Restart the bot, [you can have help on the wiki.](https://github.com/azlux/botamusique/wiki/AutoStart---AutoRestart)
### Custom commands
You can copy the file `configuration.default.ini` to `configuration.ini` and customize all variable. Everything can be change but don't remove the default file.
you have the section :
- server : configuration about the server and bot name. This is overrided by the `./mumbleBot.py` parameters.
- bot : basic configuration of the bot : comment, folder, volume at start ....
- webinterface : basic configuration about the interface (disabled by default)
- command : you can customize the command you want for each action (if you put `help = helpme` , the bot will response to `!helpme` )
- radio : here you can have a list of default radio ( I can play a jazz radio with the command `!radio jazz`)
- strings : you can customize all string the bot can say.
- debug : option to active ffmpeg or pymumble debug. (Can be very verbose)
2.TODO list
### TODOLIST
Check the issue #3