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

Removed features section, added a warning

Browse source
This commit is contained in:
Matthieu Grieger 2014-10-23 14:45:16 -07:00
parent 193394caf1
commit d583756097
1 changed files with 1 additions and 16 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

17
README.md
View file

@ -2,22 +2,7 @@ MumbleDJ
========
A Mumble bot that plays music fetched from YouTube videos. There are ways to play music with a bot on Mumble already, but I wasn't really satisfied with them. Many of them require the Windows client to be opened along with other applications which is not ideal. My goal with this project is to make a Linux-friendly Mumble bot that can run on a webserver instead of a personal computer.
## Planned Features
These are features that I would like to complete before I consider the project "finished."
* Play YouTube audio through Mumble to be heard by others. (**Done**)
* Commands for adding/queueing YouTube audio by linking to the URL. (**Done**)
* Current song updates in the chat. (**Done**)
* Command to raise/lower volume. (**Done**)
* Commands to allow users to move the bot from one channel to another. (**Done**)
* Admin commands to completely shut down the bot and perform other admin actions. (**Done**)
* Automatically turn on/off music when a certain number of users are inside the channel.
## Hopeful Features
These are features that would be cool to have, but might not ever make it into the bot.
* Ability to control music using voice commands instead of text commands.
* Ability to enable text-to-speech for the bot to announce the name of the next track over voice chat.
* A search command where the bot searches for a song and then plays it. Basically the add/queue command but without the URL.
* Statistics tracking.
**NOTE:** I am still dealing with some instability issues with regards to the audio playback. If MumbleDJ does not start playing your song within around 30 seconds, just restart the bot. I'm working on a fix.
## Setup
Since the setup process is a bit extensive, the setup guide can be found in [SETUP.md](https://github.com/matthieugrieger/mumbledj/blob/master/SETUP.md).