X-Git-Url: https://git.kaliko.me/?a=blobdiff_plain;f=doc%2Fexamples%2Fall_settings.cfg;h=2551f34dd5573db344a214e7d3b432aab30605cf;hb=refs%2Fheads%2Fissue_28;hp=01c910062d5e188c5cbd793822786f78d2ea1d7f;hpb=70bf86ca3f65a550436cdc70326cb8601f24e5a6;p=mpd-sima.git

diff --git a/doc/examples/all_settings.cfg b/doc/examples/all_settings.cfg
index 01c9100..2551f34 100644
--- a/doc/examples/all_settings.cfg
+++ b/doc/examples/all_settings.cfg
@@ -65,19 +65,25 @@ verbosity = info
 #                contrib = Scrobble, AwesomePlugin,
 #                          ExperimentalTest, AnotherTest
 # default:
-#          internal = "Crop, Lastfm, RandomFallBack"
+#          internal = "Lastfm, Random, Crop"
 #          contrib =
+#
+# Possible values for internal
+#	Lastfm   : Queue using last.fm web service for suggestions.
+#	Random   : Queue a track at random (different flavour, cf. documentation)
+#	Crop     : Remove old tracks from queue
+#
 # description: Plugins list declaration.
 #     Optional plugin's configuration lays in its own section.
 #     For instance a "AwesomePlugin" declared here
 #     gets its configuration from the corresponding section:
 #     "[awesomeplugin]"
 #     internal plugins will look for a section named after the lower-cased name
-#     of the pluglin, ie. RandomFallBack → randomfallback.
+#     of the plugin, ie. AwesomePlugin → awesomeplugin.
 #
 #     Two plugins sources are available, internal and contrib
 #
-internal = Crop, Lastfm, RandomFallBack
+internal = Lastfm, Random, Crop
 #contrib =
 
 ## HISTORY_DURATION
@@ -88,18 +94,11 @@ internal = Crop, Lastfm, RandomFallBack
 #
 history_duration = 8
 
-## USER_DB # NOT IMPLEMENTED #
-# type: boolean
-# description: Load user database to find similar artists
-#     User DB is loaded from $XDG_CONFIG_HOME/mpd_sima/sima.db
-#     Use simadb_cli to edit/add entries.
-user_db = false
-
 ## QUEUE_LENGTH
 # type: integer
-# default: 1
-# description: Queue length triggering tracks addition
-queue_length = 1
+# default: 2
+# description: Queue length threshold triggering tracks addition
+queue_length = 2
 
 ## MUSICBRAINZID
 # type: boolean
@@ -107,23 +106,34 @@ queue_length = 1
 # 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 #####################################
 
 [crop]
 ## CONSUME
 # type: integer
-# default: unset, not cropping playlist
+# default: 10
 # description: How many played tracks to keep in the playlist.
 #  Allow to maintain a fixed length playlist.
-#  Leave commented to keep all tracks
+#  Set a negative value to disable cropping (or remove plugin from sima/internal)
 #consume = 10
 
-[randomfallback]
+[random]
 ## FLAVOUR
 # type: string
 # default: sensible
-# description: When no similar tracks are found, falling back to random
-#     queuing. Different mode, aka random flavour, are available.
+# description: Random queuing, different mode, aka random flavour, are available.
 #     random flavour :
 #       * pure:     complete random choice among all tracks available in the
 #                   player media library
@@ -132,7 +142,7 @@ musicbrainzid = True
 #                   chose among the same genre as current track (using genre
 #                   tag). If no genre tag is available "sensible" flavour
 #                   is used  instead
-#flavour=sensible
+flavour=sensible
 
 ## TRACK_TO_ADD
 # type: integer
@@ -141,8 +151,6 @@ musicbrainzid = True
 #track_to_add = 1
 
 
-# EchoNest or LastFM
-#[echonest]
 [lastfm]
 ## QUEUE_MODE
 # type: string
@@ -185,14 +193,26 @@ 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
 #  * When set to "true", sima will use a persistent cache for its http client.
 #    The cache is written along with the dbfile in:
 #                $XDG_CONFIG_HOME/mpd_sima/http/<web_service>
-#    Toggling http cache is only available for last.fm. EchoNest have rate limits,
-#    we must then pay attention to bandwidth and use of caching is required.
+#     Until #7 is closed LastFM is broken; cf. https://gitlab.com/kaliko/sima/issues/7
 #  * If set to "false", caching is still done but in memory.
 # default: True
 cache = True