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

Add features section to README

Browse source
This commit is contained in:
Matthieu Grieger 2015-02-17 21:06:17 -08:00
parent 72983e8e6f
commit 879af4798f
1 changed files with 9 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

9
README.md
View file

@ -3,6 +3,7 @@ MumbleDJ
**A Mumble bot that plays music fetched from YouTube videos.**
* [Usage](#usage)
* [Features](#features)
* [Commands](#commands)
* [Installation](#installation)
* [Setup Guide](#setup-guide)
@ -15,6 +16,14 @@ MumbleDJ
`$ mumbledj -server=localhost -port=64738 -username=MumbleDJ -password="" -channel=root -cert="" -key=""`
All parameters are optional, the example above shows the default values for each field.
## FEATURES
* Plays audio from both YouTube videos and YouTube playlists!
* Displays thumbnail, title, duration, submitter, and playlist title (if exists) when a new song is played.
* Incredible customization options. Nearly everything is able to be tweaked in `~/.mumbledj/mumbledj.gcfg`.
* A large array of [commands](#commands) that perform a wide variety of functions.
* Built-in vote-skipping.
* Built-in caching system (disabled by default).
## COMMANDS
These are all of the chat commands currently supported by MumbleDJ. All command names and command prefixes may be changed in `~/.mumbledj/config/mumbledj.gcfg`.