1 ########################################################################
3 # If you need special settings, rename this file as mpd_sima.cfg within
4 # your $XDG_CONFIG_HOME (default is $HOME/.config/mpd_sima/)
5 # You can also call it with --config option.
7 # cf. man 5 mpd_sima.cfg
8 ########################################################################
10 ########################## MPD SECTION ################################
14 # type: string (IP or FQDN)
15 # description: MPD host
21 # description: MPD host port
27 # default: unset, not using authentication
28 # description: MPD host password, comment if you don't use
32 #######################################################################
34 ########################## DAEMON SECTION ################################
39 # description: whether to daemonize process or not
44 # type: string (path to the pid file)
45 # description: where to store process ID
46 # default: unset, process ID not saved to file
49 #######################################################################
51 ######################## LOGGING FACILITY #############################
55 # type: string (file path)
56 # description: file to log to. Usually used when process is daemonized.
57 # default: unset, logging to stdin/stdout
62 # description: log verbosity
65 # * debug, PAY ATTENTION: *DEBUG LEVEL MIGHT PRINT OUT YOUR PASSWORD*
71 #######################################################################
74 ######################## SIMA CORE ####################################
76 # These settings deal with MPD_sima core behaviour.
79 # type: comma separated string list
81 # contrib = Scrobble, AwesomePlugin,
82 # ExperimentalTest, AnotherTest
84 # internal = "Lastfm, Random, Crop"
87 # Possible values for internal
88 # Lastfm : Queue using last.fm web service for suggestions.
89 # Random : Queue a track at random (different flavour, cf. documentation)
90 # Crop : Remove old tracks from queue
92 # description: Plugins list declaration.
93 # Optional plugin's configuration lays in its own section.
94 # For instance a "AwesomePlugin" declared here
95 # gets its configuration from the corresponding section:
97 # internal plugins will look for a section named after the lower-cased name
98 # of the plugin, ie. AwesomePlugin → awesomeplugin.
100 # Two plugins sources are available, internal and contrib
102 internal = Lastfm, Random, Crop
106 # type: integer (in hours)
108 # description: How far to look back in history to avoid to play twice the same
116 # description: Queue length threshold triggering tracks addition
122 # description: Use of MusicBrainzIdentifier tag
125 ## REPEAT_DISABLE_QUEUE
128 # description: Prevent repeat play mode to disable queuing
129 repeat_disable_queue = True
131 ## SINGLE_DISABLE_QUEUE
134 # description: Prevent single play mode to disable queuing
135 single_disable_queue = True
137 #######################################################################
139 ######################### PLUGINS #####################################
142 ## Offline genre queing
146 # description: Configure queue mode, a single track or an album
148 # track : Will queue single track artists (default).
149 # album : Will queue whole album from artists.
154 # scope: "track" queue mode only
155 # description: Prevent from queueing a track from the same album (for instance
161 # scope: "track" and "top" queue modes
162 # description: how many tracks the plugin will try to get
167 # scope: "album" queue mode
168 # description: how many albums the plugin will try to get
173 ## Offline tags queing
174 # This plugin has no defaults set
176 # TAGS, any of the supported tags below
189 # description: Forge your own MPD filter (cf MPD protocol documentation)
194 # description: Configure queue mode, a single track or an album
196 # track : Will queue single track artists (default).
197 # album : Will queue whole album from artists.
202 # scope: "track" queue mode only
203 # description: Prevent from queueing a track from the same album (for instance
209 # scope: "track" and "top" queue modes
210 # description: how many tracks the plugin will try to get
215 # scope: "album" queue mode
216 # description: how many albums the plugin will try to get
223 # description: How many played tracks to keep in the playlist.
224 # Allow to maintain a fixed length playlist.
225 # Set a negative value to disable cropping (or remove plugin from sima/internal)
232 # description: Random queuing, different mode, aka random flavour, are available.
234 # * pure: complete random choice among all tracks available in the
235 # player media library
236 # * sensible: use play history to filter chosen tracks
237 # * genre: # NOT IMPLEMENTED #
238 # chose among the same genre as current track (using genre
239 # tag). If no genre tag is available "sensible" flavour
245 # description: how many tracks the plugin will try to get
253 # description: Does it queue a single track, top track or an album.
255 # track : Will queue single tracks from similar artists (default).
256 # top : Will queue top tracks from similar artists.
257 # album : Will queue whole album from similar artists.
262 # description: Number of similar artist to retrieve from local media library.
263 # When set to something superior to zero, MPD_sima tries to get as much similar
264 # artists from media library
268 # type: integer in [1, +∞]
275 # scope: "track" and "top" queue modes
276 # description: Prevent from queueing a track from the same album (for instance
282 # scope: "track" and "top" queue modes
283 # description: how many tracks the plugin will try to get
288 # scope: "album" queue mode
289 # description: how many albums the plugin will try to get
292 ## TRACK_TO_ADD_FROM_ALBUM
294 # scope: "album" queue mode
295 # description: how many tracks from one album the plugin will try to get
296 # defaults to 0 to queue the whole album
297 track_to_add_from_album = 0
301 # scope: "album" queue mode
302 # description: should the tracks of the album be shuffled
303 shuffle_album = false
307 # description: whether or not to use on-disk persistent http cache
308 # * When set to "true", sima will use a persistent cache for its http client.
309 # The cache is written along with the dbfile in:
310 # $XDG_CONFIG_HOME/mpd_sima/http/<web_service>
311 # Until #7 is closed LastFM is broken; cf. https://gitlab.com/kaliko/sima/issues/7
312 # * If set to "false", caching is still done but in memory.
316 #######################################################################
318 # vim: syntax=cfg fileencoding=utf-8