X-Git-Url: https://git.kaliko.me/?a=blobdiff_plain;ds=sidebyside;f=data%2Fman%2Fmpd_sima.cfg.5.html;h=5efec5ddaf19666c93e67618c573002a28013ebc;hb=e247b0900d63f23d74e234d68462dadb9fc52044;hp=5956e6587b8ea11cb64781143f1fea86a3492373;hpb=ff3281d9e1a19b5e482beab74c64d61c754e7cc4;p=mpd-sima.git diff --git a/data/man/mpd_sima.cfg.5.html b/data/man/mpd_sima.cfg.5.html index 5956e65..5efec5d 100644 --- a/data/man/mpd_sima.cfg.5.html +++ b/data/man/mpd_sima.cfg.5.html @@ -2,7 +2,25 @@ following different policies. This manual document the configuration file for mpd-sima.
This manual page documents briefly mpd-sima configuration options available in user configuration file - (see the section called “FILES”).
Here is an example of album queue configuration.
[MPD] + (see the section called “FILES”).
Here is an example of autoqueue using file tags only.
[MPD] +host=example.org +port=6601 + +[sima] +# Setup internal plugins +internal = Tags, Crop +history_duration=48 # 2 days +queue_length=2 + +[tags] +# Look for files with tagged with genre "electonica" OR "IDM" OR "glitch" +genre = electonica, IDM, glitch + +[crop] +# keep 30 played tracks in playlist +consume=30 + +
Here is an example of album queue configuration using online recommendations system.
[MPD] host=example.org port=8000 @@ -27,7 +45,7 @@ consume=30 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
Set MPD host. Use IP or FQDN.
port=
6600
Set host port to access MPD to.
password=
s3cr3t
Set MPD password to use. Do not use this option if you don't have enabled password protected access - on your MPD server.
log section
Configure logging.
[log]
logfile=
File to log to, usually in dæmon mode.
Defaut + on your MPD server.log section
Configure logging.
[log]
logfile=
File to log to, usually in dæmon mode.
Default (empty or unset) is to log to stdin/stdout.verbosity=
info
Logging verbosity among
debug
,info
, @@ -41,8 +59,7 @@ consume=30The 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
only.
+You can add, combine here as many plugins you want.
The priority may be used to order them.history_duration=
8
How far to look back in history to avoid to play twice the same track/title (duration in @@ -62,7 +79,7 @@ consume=30 Set to some negative integer to keep all played tracks.
priority=
10
Plugin priority -
Random section
Random plugin's configuration:
[random]
flavour=
sensible
When no similar tracks are found, falling back to +
Random section
Random plugin's configuration:
[random]
track_to_add=
1
How many track(s) to add.
flavour=
sensible
When no similar tracks are found, falling back to random queuing. Different mode, aka random flavour, are available:
pure
, @@ -77,7 +94,7 @@ consume=30LastFm section
LastFM plugin's configuration.
[lastfm]
queue_mode=
track
Queue mode to use among
track
,top
and -album
(see the section called “QUEUE MODES” for info about queue modes).max_art=
10
Number of similar artist to retrieve from local +
album
(see the section called “QUEUE MODES” for info about queue modes).max_art=
10
Maximum number of similar artist to retrieve from local media library.
When set to something superior to zero, it tries to get as much similar artists from media library.depth=
1
How many artists to base on similar artists @@ -89,8 +106,12 @@ consume=30 (it often happens with OST).
Only relevant in "track" queue mode.track_to_add=
1
How many track(s) to add. Only relevant in
top
andtrack
- queue modes.album_to_add=
1
How many album(s) to add. Only relevant in -
album
queue modes.cache=
True
Whether or not to use on-disk persistent http + queue modes. This is actually an upper limit, + min(
max_art
, +track_to_add
) will be used.album_to_add=
1
How many album(s) to add. Only relevant in +
album
queue modes.track_to_add_from_album=
0
How many track(s) to add from each selected albums. Only relevant in +
album
queue modes. When set to 0 or lower the whole album is queued. +cache=
True
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:
@@ -98,31 +119,49 @@ consume=30 If set to "false", caching is still done but in memory.priority=
100
Plugin priority -
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
Queue a similar track chosen at random from a similar artist.
top
Queue a track from a similar artist, chosen among - "top tracks" according to last.fm data mining.
album
Queue a whole album chosen at random from a similar artist.
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.
Tags plugin's configuration. There is no default configuration for this plugin, it does not work out of the box.
+ This plugin permits offline autoqueuing based on files tags only. Supported tags are
+ 'comment'
, 'date'
, 'genre'
, 'label'
and
+ 'originaldate'
. It currently supports single track queuing only, no album mode for this plugin.
+
+ In addition to supported tags above you can use an MPD filter. Please refer to MPD protocol documentation for more. +
+ All entries in this section are ANDed as a single MPD filter to look for titles
+ in the library. Moreover, with tags, comma separated values are also ANDed.
+ For instance setting "genre=rock
" and
+ "date=1982,1983,1984,1985,1986,1987,1988,1989
"
+ will end up looking for track tagged with genre rock
+ and date within 1985 through 1990.
+ Using an MPD filter to replace date
you can achieve
+ the same with the following setting: "genre=rock
" and
+ "filter=(date =~ '198[2-9]')
" (provided your MPD server
+ was compiled with libpcre).
+
[tags]
filter=
You can use here any valid MPD filter as defined in MPD protocol documentation.
comment=
date=
genre=
label=
priority=
80
+ Plugin priority +
track_to_add=
1
How many track(s) to add.
Different queue modes are available with some plugins (check for
+ queue_mode
presence in plugin config).
+
mpd-sima tries preferably to chose among unplayed artists or + at least not recently played artist.
track
Queue a similar track chosen at random from a similar artist.
top
Queue a track from a similar artist, chosen among + "top tracks" according to last.fm data mining.
album
Queue a whole album chosen at random from a similar artist.
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.
${XDG_CONFIG_HOME}/mpd_sima/mpd_sima.cfg
Configuration file.
${XDG_DATA_HOME}/mpd_sima/sima.db
SQLite DB file.
${XDG_DATA_HOME}/mpd_sima/WEB_SERVICE/
Persistent http cache.
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))
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.
The maintainer would be more than happy to ear from you, don't hesitate to send feedback, https://kaliko.me/contact/.
XMPP users are welcome to join the dedicated chat room at kaliko.me@conf.azylum.org.