X-Git-Url: https://git.kaliko.me/?a=blobdiff_plain;f=data%2Fman%2Fmpd_sima.cfg.5.html;h=5efec5ddaf19666c93e67618c573002a28013ebc;hb=4f5c92c03e18c4052a031f2061731cab429a98fe;hp=b1d40d030d3d06e9cc44d69c173adc820f216f63;hpb=9d84f9266abb6a2b19a884701bb3ebf619fb11b9;p=mpd-sima.git diff --git a/data/man/mpd_sima.cfg.5.html b/data/man/mpd_sima.cfg.5.html index b1d40d0..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.

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]
+            (see the section called “FILES”).

EXAMPLES

File tags queue mode (offline mode).

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
+
+            

Album queue mode using last.fm recommendations (online mode).

Here is an example of album queue configuration using online recommendations system.

[MPD]
 host=example.org
 port=8000
 
@@ -41,8 +59,7 @@ consume=30
                             

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 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, @@ -91,10 +108,10 @@ consume=30 top and track queue modes. This is actually an upper limit, min(max_art, - track_to_add) will be used, and - max_art might be inferior lower - than value set in config.

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 + 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:
@@ -102,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.

FILES

${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 +

Tags section

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.

QUEUE MODES

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.

FILES

${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))

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)

+ mpd-sima(1))

FEEDBACK/BUGS

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.

SEE ALSO

mpc(1), mpd(1)

/usr/share/doc/mpd-sima/