Add Genre plugin

[mpd-sima.git] / doc / examples / all_settings.cfg

diff --git a/doc/examples/all_settings.cfg b/doc/examples/all_settings.cfg
index b0df17f95adf4e4ea50e2ac3b401b6ada07d8c3a..4ffcf1fd421fa9521f013dd8ac0abe1b6690e1f4 100644 (file)
--- a/doc/examples/all_settings.cfg
+++ b/doc/examples/all_settings.cfg
@@ -106,8 +106,98 @@ queue_length = 2
 # description: Use of MusicBrainzIdentifier tag
 musicbrainzid = True
 
+## REPEAT_DISABLE_QUEUE
+# type: boolean
+# default: True
+# description: Prevent repeat play mode to disable queuing
+repeat_disable_queue = True
+
+## SINGLE_DISABLE_QUEUE
+# type: boolean
+# default: True
+# description: Prevent single play mode to disable queuing
+single_disable_queue  = True
+
 ######################### PLUGINS #####################################
 
+[genre]
+## Offline genre queing
+
+## QUEUE_MODE
+# type: string
+# description: Configure queue mode, a single track or an album
+# Possible values:
+#      track : Will queue single track artists (default).
+#      album : Will queue whole album from artists.
+queue_mode = track
+
+## SINGLE_ALBUM
+# type: boolean
+# scope: "track" queue mode only
+# description: Prevent from queueing a track from the same album (for instance
+#  with OST).
+single_album = false
+
+## TRACK_TO_ADD
+# type: integer
+# scope: "track" and "top" queue modes
+# description: how many tracks the plugin will try to get
+track_to_add = 1
+
+## ALBUM_TO_ADD
+# type: integer
+# scope: "album" queue mode
+# description: how many albums the plugin will try to get
+album_to_add = 1
+
+
+[tags]
+## Offline tags queing
+# This plugin has no defaults set
+
+# TAGS, any of the supported tags below
+# type: string
+# default: not set
+# description:
+comment=
+date=
+genre=
+label=
+originaldate=
+
+## FILTER
+# type: string
+# default: not set
+# description: Forge your own MPD filter (cf MPD protocol documentation)
+filter=
+
+## QUEUE_MODE
+# type: string
+# description: Configure queue mode, a single track or an album
+# Possible values:
+#      track : Will queue single track artists (default).
+#      album : Will queue whole album from artists.
+queue_mode = track
+
+## SINGLE_ALBUM
+# type: boolean
+# scope: "track" queue mode only
+# description: Prevent from queueing a track from the same album (for instance
+#  with OST).
+single_album = false
+
+## TRACK_TO_ADD
+# type: integer
+# scope: "track" and "top" queue modes
+# description: how many tracks the plugin will try to get
+track_to_add = 1
+
+## ALBUM_TO_ADD
+# type: integer
+# scope: "album" queue mode
+# description: how many albums the plugin will try to get
+album_to_add = 1
+
 [crop]
 ## CONSUME
 # type: integer
@@ -142,9 +232,9 @@ flavour=sensible
 [lastfm]
 ## QUEUE_MODE
 # type: string
-# description: The default is to queue random tracks from similar artists.
+# description: Does it queue a single track, top track or an album.
 # Possible values:
-#      track : Will queue tracks from similar artists (default).
+#      track : Will queue single tracks from similar artists (default).
 #      top   : Will queue top tracks from similar artists.
 #      album : Will queue whole album from similar artists.
 queue_mode = track
@@ -181,6 +271,19 @@ track_to_add = 1
 # description: how many albums the plugin will try to get
 album_to_add = 1
 
+## TRACK_TO_ADD_FROM_ALBUM
+# type: integer
+# scope: "album" queue mode
+# description: how many tracks from one album the plugin will try to get
+#              defaults to 0 to queue the whole album
+track_to_add_from_album = 0
+
+## SHUFFLE_ALBUM
+# type: boolean
+# scope: "album" queue mode
+# description: should the tracks of the album be shuffled
+shuffle_album = false
+
 ## CACHE
 # type: boolean
 # description: whether or not to use on-disk persistent http cache