diff --git a/README.md b/README.md index 2aede4c..ebcb545 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,7 @@ -# botamusique botamusique +
+botamusique +

botamusique

+
Botamusique is a [Mumble](https://www.mumble.info/) music bot. Predicted functionalities will be those people would expect from any classic music player. diff --git a/configuration.example.ini b/configuration.example.ini index cce22f3..64af744 100644 --- a/configuration.example.ini +++ b/configuration.example.ini @@ -98,10 +98,12 @@ port = 64738 #ducking_volume = 0.05 #ducking_threshold = 3000 -# 'when_nobody_in_channel': should the music stop playing when everybody left the channel -# it should be one of "pause" (pause current song), "pause_resume" (pause current song and resume once somebody reenters the channel) -# "stop" (also clears playlist) or "nothing" (keep playing music) -# If a user leaves and the bot is left alone, stop and clear the playlist +# 'when_nobody_in_channel': Specify what the bot should do if nobody is in the channel. +# Possible value of this options are: +# - "pause", +# - "pause_resume" (pause and resume once somebody re-enters the channel) +# - "stop" (also clears playlist) +# - "nothing" (do nothing) #when_nobody_in_channel = nothing # [webinterface] stores settings related to the web interface. diff --git a/media/README.md b/media/README.md index 79f692f..143699a 100644 --- a/media/README.md +++ b/media/README.md @@ -1,31 +1,7 @@ -Current implementation: -``` - +----------------------------------------------------------+ - | BaseItem <-| FileItem <-- URLItem <-- URLFromPlaylistItem| - | <-| RadioItem | - +----------------------------------------------------------+ - ^ - | - v - +--------------------+ - |PlayList | - |PlaylistItemWrapper | - +--------------------+ -``` - -Goal: ``` +----------------------------------------------------------+ | <-| URLItem <-- URLFromPlaylistItem | | BaseItem <-| FileItem | | <-| RadioItem | ++---------------------------------------------------------+ - ^ - | - v - +-----------+ - |PlayList | - | | - +-----------+ - ```