X-Git-Url: http://git.kaliko.me/?a=blobdiff_plain;f=doc%2Fexamples%2Fall_settings.cfg;h=047ee3c95023bfacd6222d0a29728dca63b1888d;hb=ce32823ab9d41112d989f4543432926eb38487e6;hp=77abb7a89a4d8393fd11225bc359f6434e505dca;hpb=611f98994247324793027cae02d77e5a8efd0f42;p=mpd-sima.git diff --git a/doc/examples/all_settings.cfg b/doc/examples/all_settings.cfg index 77abb7a..047ee3c 100644 --- a/doc/examples/all_settings.cfg +++ b/doc/examples/all_settings.cfg @@ -6,7 +6,7 @@ # # Pay Attention: # * Inline comment are not possible -# +# # WRONG: # host = localhost # My host # @@ -16,22 +16,25 @@ # ######################################################################## -# -####################################################################### - ########################## MPD SECTION ################################ # [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,140 +43,163 @@ port = 6600 ######################## LOGGING FACILITY ############################# # [log] -# message are logged to console -# +## LOGFILE +# type: string (file path) +# description: file to log to. Usually used in daemon mode. +# default: unset, logging to stdin/stdout +#logfile = +## + ## VERBOSITY # type: string -# -# pick verbosity in : debug, info, warning, error -# default if not specify is "info" -# *DEBUG LEVEL MIGHT PRINT OUT YOUR PASSWORD* +# description: log verbosity +# default: info +# Possible values: +# * debug, PAY ATTENTION: *DEBUG LEVEL MIGHT PRINT OUT YOUR PASSWORD* +# * info, default +# * warning +# * error verbosity = info ## -# -####################################################################### -######################### PLUGINS ##################################### -# -[placeholder] -key = Value -## # ####################################################################### ######################## SIMA CORE #################################### # +# These settings deal with MPD_sima core behaviour. [sima] ## PLUGINS # type: comma separated string list -# for ex.: -# plugins = Scrobble, AwesomePlugin, -# ExperimentalTest,AnotherTest +# 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 the corresponding section: +# "[awesomeplugin]" # -# 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). +# Two plugins sources are available, internal and contrib # -plugins = PlaceHolder +internal = Crop, 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 +# default: 8 +# description: How far to look back in history to avoid to play twice the same +# track/title # history_duration = 8 ## -## CONSUME +## 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 -# -# How many played tracks to keep in the playlist. -# Allow to maintain a fixed length playlist. -# set to 0 to keep all played tracks. -# -consume = 0 +# default: 1 +# description: Queue length triggering tracks addition +queue_length = 1 ## -## SINGLE_ALBUM -# type: boolean -# scope: "track" and "top" queue modes +######################### PLUGINS ##################################### # -# Prevent from queueing a track from the same album (for instance with OST). -single_album = false -## +[placeholder] +key = Value +[crop] +## CONSUME +# 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 + +[randomfallback] +## FLAVOUR +# 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: # 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 -# These settings deal with MPD_sima core behaviour. +## TRACK_TO_ADD +# type: integer +# description: how many tracks the plugin will try to get +# default: 1 +#track_to_add = 1 -## Queue Mode -## -# The default is to queue random tracks from similar artists. -# -## QUEUE_MODE + +# EchoNest or LastFM +#[echonest] +[lastfm] +## QUEUE_MODE # NOT COMPLETED # # type: string -# +# description: The default is to queue random tracks from similar artists. # Possible values: # track : Will queue tracks from similar artists (default). -# top : Will queue top tracks from similar artists. +# top : Will queue top tracks from similar artists. # NOT IMPLEMENTED # # album : Will queue whole album from similar artists. queue_mode = track -## SIMILARITY -# type: integer in [0 100] -# -# Similarity as a percentage of similarity for the artist the code is -# looking for. -similarity = 15 -## - -## DYNAMIC +## MAX_ART # type: integer -# -# 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 -## +# 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 +max_art = 10 -## USER_DB -# type: boolean -# -# 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 -## +## DEPTH +# type: integer in [1, +∞] +# default: 1 +# description: TBD +depth = 1 -##################################################################### -# 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 -## +## SINGLE_ALBUM +# type: boolean +# scope: "track" and "top" queue modes +# 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 -# -# Missing Description… +# description: how many tracks the plugin will try to get track_to_add = 1 -## ## ALBUM_TO_ADD # type: integer # scope: "album" queue mode -# -# Missing Description… +# description: how many albums the plugin will try to get album_to_add = 1 -## + +# +####################################################################### + # ####################### END OF CONFIGURATION ##########################