table of contents
MPD_SIMA.CFG(5) | mpd-sima 0.14.4 User Manual | MPD_SIMA.CFG(5) |
NAME¶
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.DESCRIPTION¶
This manual page documents briefly mpd-sima configuration options available in user configuration file (see the section called “FILES”).EXAMPLES¶
Album queue mode.¶
Here is an example of album queue configuration.[MPD] host=example.org port=8000 [sima] history_duration=48 # 2 days queue_length=5 [lastfm] queue_mode=album album_to_add=2 [crop] # keep 30 played tracks in playlist consume=30
CONFIGURATION FILE¶
The configuration file consists of sections, led by a [section] header and followed by name: value entries, with continuations in the style of RFC 822 (see section 3.1.1, “LONG HEADER FIELDS”); name=value is also accepted. Lines beginning with '#' or ';' are ignored and may be used to provide comments (Nota Bene: inline comment are possible using '#').The default values are used in the options lists below.
MPD section¶
This section is meant to configure MPD access, MPD host address / port and password if necessary.[MPD]
host=localhost
port=6600
password=s3cr3t
log section¶
Configure logging.[log]
logfile=
Defaut (empty or unset) is to log to stdin/stdout.
verbosity=info
Process daemonization¶
Configure process daemon.[daemon]
daemon=false
pidfile=
sima section¶
Core mpd_sima.cfg configuration.[sima]
contrib=
internal=Lastfm, Random, Crop
Plugins list is a comma separated string list.
Optional plugin's configuration lays in its own section.
For instance a "AwesomePlugin" declared here gets its configuration
from the corresponding section "[awesomeplugin]".
The default list of plugins to load at startup: Lastfm,Random,Crop.
Crop is an utility plugin, it does not queue any tracks (cf. below).
Random will queue a track at random if other plugins did not return any tracks.
You can add here as many plugins you want, currently shipping Lastfm and EchoNest only.
The priority may be used to order them.
history_duration=8
The history_duration is also used to give priority to not recently played artists.
queue_length=2
musicbrainzid=true
Consider using these metadata as it enhances a lot artist/album/tracks identification. Use Picard to tag your file: https://picard.musicbrainz.org/.
Crop section¶
crop plugin's configuration:[crop]
consume=10
priority=10
Random section¶
Random plugin's configuration:[random]
flavour=sensible
priority=50
LastFm section¶
LastFM plugin's configuration.[lastfm]
queue_mode=track
max_art=10
When set to something superior to zero, it tries to get as much similar artists from media library.
depth=1
The first is the last played artist and so on back in the history. Highter depth generates wider suggestions, it might help to reduce looping over same artists.
single_album=false
Only relevant in "track" queue mode.
track_to_add=1
album_to_add=1
cache=True
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/WEB_SERVICE.
If set to "false", caching is still done but in memory.
priority=100
EchoNest section¶
EchoNest plugin's configuration.Options for EchoNest are exactly the same as LastFm (same default as well), except for cache plugin which is always needed to limit number of requests to the service.
[echonest]
queue_mode=track
max_art=10
depth=1
single_album=false
track_to_add=1
album_to_add=1
priority=100
QUEUE MODES¶
mpd-sima offers different queue modes. All of them pick up tracks from artists similar to the last track in the queue.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.
track
top
album
Nota Bene:
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.
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.
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.
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't be queued.
FILES¶
${XDG_CONFIG_HOME}/mpd_sima/mpd_sima.cfg${XDG_DATA_HOME}/mpd_sima/sima.db
${XDG_DATA_HOME}/mpd_sima/WEB_SERVICE/
Usually XDG_DATA_HOME is set to ${HOME}/.local/share and
XDG_CONFIG_HOME to ${HOME}/.config.
You may override them using command line option --var-dir and
--config (cf. mpd-sima(1))
FEEDBACK/BUGS¶
The maintainer would be more than happy to ear from you, don't hesitate to send feedback, http://kaliko.me/id/.XMPP users are welcome to join the dedicated chat room at kaliko.me@conf.azylum.org.
SEE ALSO¶
mpc(1), mpd(1)/usr/share/doc/mpd-sima/
AUTHOR¶
Jack Kaliko <kaliko@azylum.org>COPYRIGHT¶
Copyright © 2009-2017 Jack KalikoThis manual page was written for the Debian system (and may be used by others).
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.
On Debian systems, the complete text of the GNU General Public License can be found in /usr/share/common-licenses/GPL.
02/12/2017 | mpd-sima |