2 .\" Title: mpd_sima.cfg
3 .\" Author: Jack Kaliko <kaliko@azylum.org>
4 .\" Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/>
6 .\" Manual: mpd-sima 0.12.0 User Manual
10 .TH "MPD_SIMA\&.CFG" "5" "06/11/2014" "mpd-sima" "mpd-sima 0.12.0 User Manual"
11 .\" -----------------------------------------------------------------
12 .\" * Define some portability stuff
13 .\" -----------------------------------------------------------------
14 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
15 .\" http://bugs.debian.org/507673
16 .\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
17 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
20 .\" -----------------------------------------------------------------
21 .\" * set default formatting
22 .\" -----------------------------------------------------------------
23 .\" disable hyphenation
25 .\" disable justification (adjust text to left margin only)
27 .\" -----------------------------------------------------------------
28 .\" * MAIN CONTENT STARTS HERE *
29 .\" -----------------------------------------------------------------
31 mpd_sima.cfg \- mpd\-sima will try to maintain some titles ahead in the queue following different policies\&. This manual document the configuration file for mpd\-sima\&.
34 This manual page documents briefly
36 configuration options available in user configuration file (see
37 the section called \(lqFILES\(rq)\&.
39 .SS "Album queue mode\&."
41 Here is an example of album queue configuration\&.
52 history_duration=48 # 2 days
60 # keep 30 played tracks in playlist
68 .SH "CONFIGURATION FILE"
70 The configuration file consists of sections, led by a
72 header and followed by
74 entries, with continuations in the style of RFC 822 (see section 3\&.1\&.1, \(lqLONG HEADER FIELDS\(rq);
76 is also accepted\&. Lines beginning with
80 are ignored and may be used to provide comments (\fINota Bene:\fR
81 inline comment are possible using
84 The default values are used in the options lists below\&.
87 This section is meant to configure MPD access, MPD host address / port and password if necessary\&.
93 \fBhost=\fR\fIlocalhost\fR
95 Set MPD host\&. Use IP or FQDN\&.
100 Set host port to access MPD to\&.
103 \fBpassword=\fR\fIs3cr3t\fR
105 Set MPD password to use\&. Do not use this option if you don\*(Aqt have enabled password protected access on your MPD server\&.
117 File to log to, usually in d\(aemon mode\&.
119 Defaut (empty or unset) is to log to stdin/stdout\&.
122 \fBverbosity=\fR\fIinfo\fR
124 Logging verbosity among
132 This section allows you to tweak core mpd_sima\&.cfg configuration\&.
138 \fBhistory_duration=\fR\fI8\fR
140 How far to look back in history to avoid to play twice the same track/title (duration in hours)\&.
143 \fBqueue_length=\fR\fI1\fR
145 This value triggers queue process if the queue length is less than specified queue_length\&.
148 \fBuser_db=\fR\fIfalse\fR
150 Temporarily removed feature
153 mpd\-sima\*(Aqs plugin management for internal source plugin and contrib (ie\&. external plugins)\&.
156 Plugins list is a comma separated string list\&.
159 Optional plugin\*(Aqs configuration lays in its own section\&.
161 For instance a "AwesomePlugin" declared here gets its configuration from the corresponding section "[awesomeplugin]"\&.
163 internal plugins will look for a section named after the lower\-cased name of the pluglin, ie\&. RandomFallBack\ \&\(-> randomfallback\&.
165 \fBinternal=\fR\fICrop, RandomFallBack, Lastfm\fR
170 are utilities plugins while
172 is the actual queue plugin\&.
175 Another queue plugin is available as a "techno preview", it relies on EchoNest web services, replace
187 crop plugin\*(Aqs configuration:
193 \fBconsume=\fR\fI0\fR
195 How many played tracks to keep in the queue\&. Allow to maintain a fixed length queue\&. Set to 0 to keep all played tracks\&.
197 .SS "RandomFallback section"
199 RandomFallback plugin\*(Aqs configuration:
201 \fB[randomfallback]\fR
205 \fBflavour=\fR\fIsensible\fR
207 When no similar tracks are found, falling back to random queuing\&. Different mode, aka random flavour, are available:
220 \fIpure\fR, pure random choice, even among recently played track\&.
231 \fIsensible\fR, use play history to filter chosen tracks\&.
242 \fIgenre\fR, Not implemented yet\&.
248 This section allows you to tweak LastFM plugin\*(Aqs configuration\&.
254 \fBqueue_mode=\fR\fItrack\fR
256 Queue mode to use among
262 the section called \(lqQUEUE MODES\(rq
263 for info about queue modes)\&.
266 \fBmax_art=\fR\fI10\fR
268 Number of similar artist to retrieve from local media library\&.
270 When set to something superior to zero, it tries to get as much similar artists from media library\&.
275 How many artists to base on similar artists search\&.
278 The first is the last played artist and so on back in the history\&. Highter depth allows to get wider suggestions, it might help to reduce looping over same artists\&.
281 \fBsingle_album=\fR\fIfalse\fR
283 Prevent from queueing a track from the same album (it often happens with OST)\&.
286 Only relevant in "track" queue mode\&.
289 \fBtrack_to_add=\fR\fI1\fR
291 How many track(s) to add\&. Only relevant in
298 \fBalbum_to_add=\fR\fI1\fR
300 How many album(s) to add\&. Only relevant in
305 \fBcache=\fR\fITrue\fR
307 Whether or not to use on\-disk persistent http cache\&.
309 When set to "true", sima will use a persistent cache for its http client\&. The cache is written along with the dbfile in:
311 $XDG_CONFIG_HOME/mpd_sima/http/WEB_SERVICE\&.
314 If set to "false", caching is still done but in memory\&.
318 mpd\-sima offers different queue modes\&. All of them pick up tracks from artists similar to the last track in the queue\&.
320 mpd\-sima tries preferably to chose among unplayed artists or at least not recently played artist\&. Concerning track and album queue modes titles are chosen purely at random among unplayed tracks\&.
324 Queue a similar track chosen at random from a similar artist\&.
329 Queue a track from a similar artist, chosen among "top tracks" according to last\&.fm data mining\&.
334 Queue a whole album chosen at random from a similar artist\&.
339 Due to the track point of view of database build upon tracks tags an album lookup for a specific artist will return albums as soon as this artist appears in a single track of the album\&.
342 For instance looking for album from "The Velvet Underground" will fetch "Last Days" and "Juno" OSTs because the band appears on the soundtrack of these two movies\&.
345 A solution is for you to set AlbumArtists tag to something different than the actual artist of the track\&. For compilations, OSTs etc\&. a strong convention is to use "Various Artists" for this tag\&.
347 mpd\-sima is currently looking for AlbumArtists tags and avoid album where this tag is set with "Various Artists"\&. If a single track within an album is found with AlbumArtists:"Various Artists" the complete album is skipped and won\*(Aqt be queued\&.
350 It is planned to allow users to set the values of AlbumArtists tag triggering this behaviour\&. cf\&. feature request #2085 on the tracker\&.
354 ${XDG_CONFIG_HOME}/mpd_sima/mpd_sima\&.cfg
356 Configuration file\&.
359 ${XDG_DATA_HOME}/mpd_sima/sima\&.db
364 ${XDG_DATA_HOME}/mpd_sima/WEB_SERVICE/
366 Persistant http cache\&.
372 ${HOME}/\&.local/share
374 \fBXDG_CONFIG_HOME\fR
378 You may override them using command line option
384 The maintainer would be more than happy to ear from you, don\*(Aqt hesitate to send feedback,
385 \m[blue]\fB\%http://kaliko.me/id/\fR\m[]\&.
388 users are welcome to join the dedicated chat room at
389 \m[blue]\fBkaliko\&.me@conf\&.azylum\&.org\fR\m[]\&.
395 /usr/share/doc/mpd\-sima/
398 \fBJack Kaliko\fR <\&kaliko@azylum\&.org\&>
400 Wrote this man page and is currently leading MPD_sima project\&.
404 Copyright \(co 2009-2014 Jack Kaliko
407 This manual page was written for the Debian system (and may be used by others)\&.
409 Permission is granted to copy, distribute and/or modify this document under the terms of the GNU General Public License, Version 3 published by the Free Software Foundation\&.
411 On Debian systems, the complete text of the GNU General Public License can be found in
412 /usr/share/common\-licenses/GPL\&.