X-Git-Url: https://git.kaliko.me/?a=blobdiff_plain;f=doc%2Fexamples%2Fall_settings.cfg;h=62587d38d69fd6c5f60e5da162db282918cc06bc;hb=8f164c9ff754dc496eb7f9e8cf23be6062ee15d5;hp=77abb7a89a4d8393fd11225bc359f6434e505dca;hpb=611f98994247324793027cae02d77e5a8efd0f42;p=mpd-sima.git diff --git a/doc/examples/all_settings.cfg b/doc/examples/all_settings.cfg index 77abb7a..62587d3 100644 --- a/doc/examples/all_settings.cfg +++ b/doc/examples/all_settings.cfg @@ -1,180 +1,318 @@ ######################################################################## # -# 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 ################################ # [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 # ####################################################################### +########################## DAEMON SECTION ################################ +# +[daemon] +## DAEMON +# type: boolean +# description: whether to daemonize process or not +# default: False +daemon=false + +## PIDFILE +# type: string (path to the pid file) +# description: where to store process ID +# default: unset, process ID not saved to file +#pidfile= +# +####################################################################### + ######################## LOGGING FACILITY ############################# # [log] -# message are logged to console -# +## LOGFILE +# type: string (file path) +# description: file to log to. Usually used when process is daemonized. +# 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: +# 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 # -# 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). +# 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 plugin, ie. AwesomePlugin → awesomeplugin. # -plugins = PlaceHolder +# Two plugins sources are available, internal and contrib +# +internal = Lastfm, Random, Crop +#contrib = ## 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 +## QUEUE_LENGTH # type: integer +# default: 2 +# description: Queue length threshold triggering tracks addition +queue_length = 2 + +## MUSICBRAINZID +# type: boolean +# default: True +# 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 # -# How many played tracks to keep in the playlist. -# Allow to maintain a fixed length playlist. -# set to 0 to keep all played tracks. +####################################################################### + +######################### PLUGINS ##################################### # -consume = 0 -## +[genre] +## Offline genre queing + +## QUEUE_MODE +# type: string +# description: Configure queue mode, a single track or an album +# Possible values: +# track : Will queue single track artists (default). +# album : Will queue whole album from artists. +queue_mode = track ## SINGLE_ALBUM # type: boolean -# scope: "track" and "top" queue modes -# -# Prevent from queueing a track from the same album (for instance with OST). +# scope: "track" queue mode only +# 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 +# description: how many tracks the plugin will try to get +track_to_add = 1 + +## ALBUM_TO_ADD +# type: integer +# scope: "album" queue mode +# description: how many albums the plugin will try to get +album_to_add = 1 -# These settings deal with MPD_sima core behaviour. -## Queue Mode -## -# The default is to queue random tracks from similar artists. -# +[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= + ## QUEUE_MODE # type: string -# +# description: Configure queue mode, a single track or an album # Possible values: -# track : Will queue tracks from similar artists (default). -# top : Will queue top tracks from similar artists. -# album : Will queue whole album from similar artists. +# track : Will queue single track artists (default). +# album : Will queue whole album from 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 -## +## SINGLE_ALBUM +# type: boolean +# scope: "track" queue mode only +# description: Prevent from queueing a track from the same album (for instance +# with OST). +single_album = false -## DYNAMIC +## TRACK_TO_ADD # 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 -## +# scope: "track" and "top" queue modes +# description: how many tracks the plugin will try to get +track_to_add = 1 -## 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 -## +## ALBUM_TO_ADD +# type: integer +# scope: "album" queue mode +# description: how many albums the plugin will try to get +album_to_add = 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 :) +[crop] +## CONSUME +# type: integer +# default: 10 +# description: How many played tracks to keep in the playlist. +# Allow to maintain a fixed length playlist. +# Set a negative value to disable cropping (or remove plugin from sima/internal) +#consume = 10 -## QUEUE_LENGTH +[random] +## FLAVOUR +# type: string +# default: sensible +# 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: # 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 -# -# Queue length triggering tracks addition -queue_length = 1 -## +# description: how many tracks the plugin will try to get +# default: 1 +#track_to_add = 1 + + +[lastfm] +## QUEUE_MODE +# type: string +# description: Does it queue a single track, top track or an album. +# Possible values: +# track : Will queue single tracks from similar artists (default). +# top : Will queue top tracks from similar artists. +# album : Will queue whole album from similar artists. +queue_mode = track + +## 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 +max_art = 20 + +## DEPTH +# type: integer in [1, +∞] +# default: 1 +# description: TBD +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). +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 -## + +## 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