From add1bca205eb064366eb2a8cde436f47c0fc25a2 Mon Sep 17 00:00:00 2001 From: kaliko Date: Sun, 8 Dec 2013 14:50:53 +0100 Subject: [PATCH] Update configuration example --- doc/examples/all_settings.cfg | 155 +++++++++++++++++++--------------- 1 file changed, 86 insertions(+), 69 deletions(-) diff --git a/doc/examples/all_settings.cfg b/doc/examples/all_settings.cfg index ca097ab..9e2d87c 100644 --- a/doc/examples/all_settings.cfg +++ b/doc/examples/all_settings.cfg @@ -20,15 +20,21 @@ # [MPD] ## HOST -# type: string +# type: string (IP or FQDN) +# description: MPD host +# default: localhost host = localhost + ## PORT # type: integer +# description: MPD host port +# default: 6600 port = 6600 + ## PASSWORD # type: string -# -# please comment if you don't use +# default: unset, not using authentication +# description: MPD host password, comment if you don't use #password = s3cr3t # @@ -40,52 +46,104 @@ port = 6600 ## LOGFILE # type: string (file path) # description: file to log to. Usually used in daemon mode. -# default: logging to stdin/stdout +# default: unset, logging to stdin/stdout #logfile = ## ## VERBOSITY # type: string # description: log verbosity +# default: info # Possible values: -# * debug, *DEBUG LEVEL MIGHT PRINT OUT YOUR PASSWORD* -# * info, default -# * warning -# * error -# +# * debug, PAY ATTENTION: *DEBUG LEVEL MIGHT PRINT OUT YOUR PASSWORD* +# * info, default +# * warning +# * error verbosity = info ## # ####################################################################### + +######################## SIMA CORE #################################### +# +# These settings deal with MPD_sima core behaviour. +[sima] +## PLUGINS +# type: comma separated string list +# for ex.: +# contrib = Scrobble, AwesomePlugin, +# ExperimentalTest, AnotherTest +# default: +# 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). +# +# Two plugins sources are available, internal and contrib +# +internal = Crop, Lastfm, RandomFallBack +#contrib = PlaceHolder + +## HISTORY_DURATION +# type: integer (in hours) +# default: 8 +# description: How far to look back in history to avoid to play twice the same +# track/title +# +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/sima/sima.db +# Use simadb_cli to edit/add entries. +user_db = false +## + +##################################################################### +# You do not need to set up options below. +# But well, you got bored of the way sima is behaving, then go ahead +# play with it :) + +## QUEUE_LENGTH +# type: integer +# default: 1 +# description: Queue length triggering tracks addition +queue_length = 1 +## + ######################### PLUGINS ##################################### # [placeholder] key = Value -#[crop] +[crop] # type: integer +# default: unset, not cropping playlist # description: How many played tracks to keep in the playlist. # Allow to maintain a fixed length playlist. # Leave commented to keep all tracks #consume = 10 -[crop] -consume = 10 - [RandomFallback] -# random falvour : -# * pure: complete ramdom 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 (tagged genre). If -# no genre tag is available "sensible" flavour is used instead -flavour=pure +# type: string +# default: sensible +# description: When no similar tracks are found, falling back to random +# queuing. Different mode, aka random flavour, are available. +# random flavour : +# * 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 +# tag). If no genre tag is available "sensible" flavour +# is used instead +#flavour=sensible [lastfm] - -depth = 1 - ## QUEUE_MODE # NOT COMPLETED # # type: string # description: The default is to queue random tracks from similar artists. @@ -109,6 +167,12 @@ similarity = 15 # similarity value. dynamic = 10 +## DEPTH +# type: integer in [1, +∞] +# default: 1 +# description: TBD +depth = 1 + ## SINGLE_ALBUM # NOT IMPLEMENTED # # type: boolean # scope: "track" and "top" queue modes @@ -130,53 +194,6 @@ album_to_add = 1 # ####################################################################### - -######################## SIMA CORE #################################### -# -# These settings deal with MPD_sima core behaviour. -[sima] -## PLUGINS -# type: comma separated string list -# for ex.: -# contrib = Scrobble, AwesomePlugin, -# ExperimentalTest,AnotherTest -# -# Plugins list declaration. -# Optional plugin's configuration must be in its own section. For instance an -# "AwesomePlugin" declared here gets its configuration from the -# "[AwesomePlugin]" or "[awesomeplugin]" section (case insensitive). -# -#internal = Crop, History, MpdOptions, Lastfm, RandomFallBack -contrib = PlaceHolder - -## HISTORY_DURATION -# type: integer (in hours) -# -# How far to look back in history to avoid to play twice the same track/title -# -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/sima/sima.db -# Use simadb_cli to edit/add entries. -user_db = false -## - -##################################################################### -# You do not need to set up options below. -# But well, you got bored of the way MPD_sima is behaving, then go ahead -# play with it :) - -## QUEUE_LENGTH -# type: integer -# -# Queue length triggering tracks addition -queue_length = 1 -## - # ####################### END OF CONFIGURATION ########################## -- 2.39.2