containers/mumbledj
Archived
1
0
Fork 0
Code Issues Pull requests Releases Wiki Activity

Updated README with more detailed descriptions of commandline options

Browse source
This commit is contained in:
Matthieu Grieger 2015-05-14 10:54:14 -07:00
parent 189153f888
commit 9e16b73b53
1 changed files with 12 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

14
README.md
View file

@ -15,9 +15,19 @@ MumbleDJ
* [Thanks](#thanks) * [Thanks](#thanks)
## USAGE ## USAGE
`$ mumbledj -server=localhost -port=64738 -username=MumbleDJ -password="" -channel=root -cert="" -key="" -insecure` `$ mumbledj -server=localhost -port=64738 -username=MumbleDJ -password="hunter2"`
All parameters are optional, the example above shows the default values for each field. All commandline parameters are optional. Below are descriptions of all the available options:
* `-server`: The address of the Mumble server. Defaults to localhost.
* `-port`: The port number of the Mumble server. Defaults to 64738.
* `-username`: The username for the bot. Defaults to MumbleDJ.
* `-password`: The password for the Mumble server, if exists. Defaults to no password.
* `-channel`: The channel the bot enters after connecting to the Mumble server. Defaults to root.
* `-cert`: Path to user PEM certificate. Defaults to no cert.
* `-key`: Path to user PEM key. Defaults to no key.
* `-insecure`: If included, the bot will not check the certs for the server. Try using this commandline flag if you are having connection issues.
* `-accesstokens`: List of access tokens for the bot separated by spaces. Defaults to no access tokens.
## FEATURES ## FEATURES
* Plays audio from both YouTube videos and YouTube playlists! * Plays audio from both YouTube videos and YouTube playlists!