Improved RandomFallBack and update documentation

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

diff --git a/doc/examples/all_settings.cfg b/doc/examples/all_settings.cfg
index 7eb0f24defa9ddbcf1ead42984a6b9479e9bc6a9..047ee3c95023bfacd6222d0a29728dca63b1888d 100644 (file)
--- a/doc/examples/all_settings.cfg
+++ b/doc/examples/all_settings.cfg
@@ -79,8 +79,8 @@ verbosity = info
 # description: Plugins list declaration.
 #     Optional plugin's configuration must be in its own section.
 #     For instance a "AwesomePlugin" declared here
-#     gets its configuration from an "[AwesomePlugin]"
-#     or "[awesomeplugin]" section (case insensitive).
+#     gets its configuration from the corresponding section:
+#     "[awesomeplugin]"
 #
 #     Two plugins sources are available, internal and contrib
 #
@@ -122,6 +122,7 @@ queue_length = 1
 key = Value
 
 [crop]
+## CONSUME
 # type: integer
 # default: unset, not cropping playlist
 # description: How many played tracks to keep in the playlist.
@@ -129,7 +130,8 @@ key = Value
 #  Leave commented to keep all tracks
 #consume = 10
 
-[RandomFallback]
+[randomfallback]
+## FLAVOUR
 # type: string
 # default: sensible
 # description: When no similar tracks are found, falling back to random
@@ -138,11 +140,21 @@ key = Value
 #       * pure:     complete random choice among all tracks available in the
 #                   player media library
 #       * sensible: use play history to filter chosen tracks
-#       * genre:    chose among the same genre as current track (using genre
+#       * genre:    # NOT IMPLEMENTED #
+#                   chose among the same genre as current track (using genre
 #                   tag). If no genre tag is available "sensible" flavour
 #                   is used  instead
 #flavour=sensible
 
+## TRACK_TO_ADD
+# type: integer
+# description: how many tracks the plugin will try to get
+# default: 1
+#track_to_add = 1
+
+
+# EchoNest or LastFM
+#[echonest]
 [lastfm]
 ## QUEUE_MODE # NOT COMPLETED #
 # type: string
@@ -153,19 +165,12 @@ key = Value
 #      album : Will queue whole album from similar artists.
 queue_mode = track
 
-## SIMILARITY
-# type: integer in [0 100]
-# description: Similarity as a percentage of similarity between artists
-# (this is a last.fm metric)
-similarity = 15
-
-## DYNAMIC
+## MAX_ART
 # type: integer
 # description: Number of similar artist to retrieve from local media library.
 #  When set to something superior to zero, MPD_sima tries to get as much similar
-#  artists from media library provided artists similarity is superior to
-#  similarity value.
-dynamic = 10
+#  artists from media library
+max_art = 10
 
 ## DEPTH
 # type: integer in [1, +∞]
@@ -176,7 +181,8 @@ depth = 1
 ## SINGLE_ALBUM
 # type: boolean
 # scope: "track" and "top" queue modes
-# description: Prevent from queueing a track from the same album (for instance with OST).
+# description: Prevent from queueing a track from the same album (for instance
+#  with OST).
 single_album = false
 
 ## TRACK_TO_ADD