X-Git-Url: http://git.kaliko.me/?a=blobdiff_plain;f=doc%2Fexamples%2Fall_settings.cfg;h=7b8e68511fc83c17590c28062a0eef34188ed75c;hb=e703692c1f6f2cbac143c19dac2fb5800be8b6ea;hp=9e2d87cff5557a1cf0653efb256c8453551d3838;hpb=add1bca205eb064366eb2a8cde436f47c0fc25a2;p=mpd-sima.git diff --git a/doc/examples/all_settings.cfg b/doc/examples/all_settings.cfg index 9e2d87c..7b8e685 100644 --- a/doc/examples/all_settings.cfg +++ b/doc/examples/all_settings.cfg @@ -1,19 +1,10 @@ ######################################################################## # -# If you need special settings, rename this file as sima.cfg within -# your $XDG_CONFIG_HOME (default is $HOME/.config/sima/) +# If you need special settings, rename this file as mpd_sima.cfg within +# your $XDG_CONFIG_HOME (default is $HOME/.config/mpd_sima/) # You can also call it with --config option. # -# Pay Attention: -# * Inline comment are not possible -# -# WRONG: -# host = localhost # My host -# -# OK: -# # My host -# host = localhost -# +# cf. man 5 mpd_sima.cfg ######################################################################## ########################## MPD SECTION ################################ @@ -48,7 +39,6 @@ port = 6600 # description: file to log to. Usually used in daemon mode. # default: unset, logging to stdin/stdout #logfile = -## ## VERBOSITY # type: string @@ -60,7 +50,6 @@ port = 6600 # * warning # * error verbosity = info -## # ####################################################################### @@ -76,16 +65,26 @@ verbosity = info # contrib = Scrobble, AwesomePlugin, # ExperimentalTest, AnotherTest # default: +# 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 must be in its own section. +# Optional plugin's configuration lays 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]" +# internal plugins will look for a section named after the lower-cased name +# of the plugin, ie. AwesomePlugin → awesomeplugin. # # Two plugins sources are available, internal and contrib # -internal = Crop, Lastfm, RandomFallBack -#contrib = PlaceHolder +internal = Lastfm, Random, Crop +#contrib = ## HISTORY_DURATION # type: integer (in hours) @@ -94,78 +93,100 @@ internal = Crop, Lastfm, RandomFallBack # track/title # history_duration = 8 -## -## USER_DB # NOT IMPLEMENTED # +## QUEUE_LENGTH +# type: integer +# default: 2 +# description: Queue length threshold triggering tracks addition +queue_length = 2 + +## MUSICBRAINZID # 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 -## +# default: True +# description: Use of MusicBrainzIdentifier tag +musicbrainzid = True -##################################################################### -# 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 :) +## REPEAT_DISABLE_QUEUE +# type: boolean +# default: True +# description: Prevent repeat play mode to disable queuing +repeat_disable_queue = True -## QUEUE_LENGTH -# type: integer -# default: 1 -# description: Queue length triggering tracks addition -queue_length = 1 -## +## SINGLE_DISABLE_QUEUE +# type: boolean +# default: True +# description: Prevent single play mode to disable queuing +single_disable_queue = True ######################### PLUGINS ##################################### -# -[placeholder] -key = Value + +[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= [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 # * 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 +flavour=sensible + +## TRACK_TO_ADD +# type: integer +# description: how many tracks the plugin will try to get +# default: 1 +#track_to_add = 1 + [lastfm] -## QUEUE_MODE # NOT COMPLETED # +## QUEUE_MODE # 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. # NOT IMPLEMENTED # +# top : Will queue top tracks from similar artists. # 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, +∞] @@ -173,11 +194,12 @@ dynamic = 10 # description: TBD depth = 1 -## SINGLE_ALBUM # NOT IMPLEMENTED # +## 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 = true +# description: Prevent from queueing a track from the same album (for instance +# with OST). +single_album = false ## TRACK_TO_ADD # type: integer @@ -191,10 +213,30 @@ 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/ +# 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 # ####################### END OF CONFIGURATION ########################## - # vim: syntax=cfg fileencoding=utf-8