'\" t
.\" Title: mpd_sima.cfg
-.\" Author: Jack Kaliko <kaliko@azylum.org>
-.\" Generator: DocBook XSL Stylesheets v1.79.1 <http://docbook.sf.net/>
-.\" Date: 03/19/2019
-.\" Manual: mpd-sima 0.15.0 User Manual
+.\" Author: kaliko <kaliko@azylum.org>
+.\" Generator: DocBook XSL Stylesheets v1.79.2 <http://docbook.sf.net/>
+.\" Date: 11/16/2021
+.\" Manual: mpd-sima 0.18.0 User Manual
.\" Source: mpd-sima
.\" Language: English
.\"
-.TH "MPD_SIMA\&.CFG" "5" "03/19/2019" "mpd-sima" "mpd-sima 0.15.0 User Manual"
+.TH "MPD_SIMA\&.CFG" "5" "11/16/2021" "mpd-sima" "mpd-sima 0.18.0 User Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
configuration options available in user configuration file (see
the section called \(lqFILES\(rq)\&.
.SH "EXAMPLES"
-.SS "Album queue mode\&."
+.SS "File tags queue mode (offline mode)\&."
.PP
-Here is an example of album queue configuration\&.
+Here is an example of autoqueue using file tags only\&.
+.sp
+.if n \{\
+.RS 4
+.\}
+.nf
+[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
+
+
+.fi
+.if n \{\
+.RE
+.\}
+.SS "Album queue mode using last\&.fm recommendations (online mode)\&."
+.PP
+Here is an example of album queue configuration using online recommendations system\&.
.sp
.if n \{\
.RS 4
.br
.sp
-You can add here as many plugins you want, currently shipping
-\fBLastfm\fR
-only\&.
+You can add, combine here as many plugins you want\&.
.br
The priority may be used to order them\&.
.RE
.SS "Random section"
.PP
+When no similar tracks are found, falling back to random queuing\&.
+.PP
Random plugin\*(Aqs configuration:
.PP
\fB[random]\fR
.RS 4
.RE
.PP
+\fBtrack_to_add=\fR\fI1\fR
+.RS 4
+How many track(s) to add\&.
+.RE
+.PP
\fBflavour=\fR\fIsensible\fR
.RS 4
-When no similar tracks are found, falling back to random queuing\&. Different mode, aka random flavour, are available:
+Different mode, aka random flavour, are available:
\fIpure\fR,
\fIsensible\fR,
-\fIgenre\fR\&.
.sp
.RS 4
.ie n \{\
\fIsensible\fR, use play history to filter chosen tracks\&.
.RE
.sp
-.RS 4
-.ie n \{\
-\h'-04'\(bu\h'+03'\c
-.\}
-.el \{\
-.sp -1
-.IP \(bu 2.3
-.\}
-\fIgenre\fR, Not implemented yet\&.
-.RE
-.sp
.RE
.PP
\fBpriority=\fR\fI50\fR
and
\fBtrack\fR
queue modes\&. This is actually an upper limit, min(\fBmax_art\fR,
-\fBtrack_to_add\fR) will be used, and
-\fBmax_art\fR
-might be inferior lower than value set in config\&.
+\fBtrack_to_add\fR) will be used\&.
.RE
.PP
\fBalbum_to_add=\fR\fI1\fR
queue modes\&.
.RE
.PP
+\fBtrack_to_add_from_album=\fR\fI0\fR
+.RS 4
+How many track(s) to add from each selected albums\&. Only relevant in
+\fBalbum\fR
+queue modes\&. When set to 0 or lower the whole album is queued\&.
+.RE
+.PP
\fBcache=\fR\fITrue\fR
.RS 4
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:
.br
-$XDG_CONFIG_HOME/mpd_sima/http/WEB_SERVICE\&.
+$XDG_DATA_HOME/mpd_sima/http/WEB_SERVICE\&.
.br
If set to "false", caching is still done but in memory\&.
.RS 4
Plugin priority
.RE
+.SS "Genre section"
+.PP
+Genre plugin\*(Aqs configuration\&.
+.PP
+This plugin permits offline autoqueuing based on files genre tag only\&.
+.PP
+it will try to queue tracks base on genre tags of tracks in the queue\&.
+.PP
+\fB[genre]\fR
+.RS 4
+.RE
+.PP
+\fBqueue_mode=\fR\fItrack\fR
+.RS 4
+Queue mode to use among
+\fItrack\fR,
+\fIalbum\fR
+(see
+the section called \(lqQUEUE MODES\(rq
+for info about queue modes)\&.
+.RE
+.PP
+\fBsingle_album=\fR\fIfalse\fR
+.RS 4
+Prevent from queueing a track from the same album (it often happens with OST)\&.
+.br
+
+Only relevant in "track" queue mode\&.
+.RE
+.PP
+\fBpriority=\fR\fI80\fR
+.RS 4
+Plugin priority
+.RE
+.PP
+\fBtrack_to_add=\fR\fI1\fR
+.RS 4
+How many track(s) to add\&.
+.RE
+.PP
+\fBalbum_to_add=\fR\fI1\fR
+.RS 4
+How many album(s) to add\&. Only relevant in
+\fBalbum\fR
+queue mode\&.
+.RE
+.SS "Tags section"
+.PP
+Tags plugin\*(Aqs configuration\&. There is no default configuration for this plugin, it does not work out of the box\&.
+.PP
+This plugin permits offline autoqueuing based on files tags only\&. Supported tags are
+\fB\*(Aqcomment\*(Aq\fR,
+\fB\*(Aqdate\*(Aq\fR,
+\fB\*(Aqgenre\*(Aq\fR,
+\fB\*(Aqlabel\*(Aq\fR
+and
+\fB\*(Aqoriginaldate\*(Aq\fR\&.
+.PP
+In addition to supported tags above you can use an MPD filter\&. Please refer to MPD protocol documentation for more\&.
+.PP
+All tag entries in this section are ANDed as a single MPD filter to look for titles in the library\&. Moreover, for each tags, comma separated values are also ORed\&.
+.br
+
+For instance setting "\fBgenre=rock\fR" and "\fBdate=1982,1983,1984,1985,1986,1987,1988,1989\fR" will end up looking for track tagged with genre
+\fBrock\fR
+and date within 1982 through 1989\&.
+.br
+
+Using an MPD filter to replace
+\fBdate\fR
+you can achieve the same with the following setting: "\fBgenre=rock\fR" and "\fBfilter=(date =~ \*(Aq198[2\-9]+\*(Aq)\fR" (provided your MPD server was compiled with libpcre)\&.
+.PP
+\fB[tags]\fR
+.RS 4
+.RE
+.PP
+\fBqueue_mode=\fR\fItrack\fR
+.RS 4
+Queue mode to use among
+\fItrack\fR,
+\fIalbum\fR
+(see
+the section called \(lqQUEUE MODES\(rq
+for info about queue modes)\&.
+.RE
+.PP
+\fBsingle_album=\fR\fIfalse\fR
+.RS 4
+Prevent from queueing a track from the same album (it often happens with OST)\&.
+.br
+
+Only relevant in "track" queue mode\&.
+.RE
+.PP
+\fBfilter=\fR
+.RS 4
+You can use here any valid MPD filter as defined in MPD protocol documentation\&.
+.RE
+.PP
+\fBcomment=\fR
+.RS 4
+.RE
+.PP
+\fBdate=\fR
+.RS 4
+.RE
+.PP
+\fBgenre=\fR
+.RS 4
+.RE
+.PP
+\fBlabel=\fR
+.RS 4
+.RE
+.PP
+\fBoriginaldate=\fR
+.RS 4
+.RE
+.PP
+\fBpriority=\fR\fI80\fR
+.RS 4
+Plugin priority
+.RE
+.PP
+\fBtrack_to_add=\fR\fI1\fR
+.RS 4
+How many track(s) to add\&.
+.RE
+.PP
+\fBalbum_to_add=\fR\fI1\fR
+.RS 4
+How many album(s) to add\&. Only relevant in
+\fBalbum\fR
+queue mode\&.
+.RE
.SH "QUEUE MODES"
.PP
-mpd\-sima offers different queue modes\&. All of them pick up tracks from artists similar to the last track in the queue\&.
+Different queue modes are available with some plugins (check for
+\fBqueue_mode\fR
+presence in plugin config)\&.
.PP
-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\&.
+mpd\-sima tries preferably to chose among unplayed artists or at least not recently played artist\&.
.PP
\fBtrack\fR
.RS 4
.SH "FEEDBACK/BUGS"
.PP
The maintainer would be more than happy to ear from you, don\*(Aqt hesitate to send feedback,
-\m[blue]\fB\%http://kaliko.me/id/\fR\m[]\&.
+\m[blue]\fB\%https://kaliko.me/contact/\fR\m[]\&.
.PP
XMPP
users are welcome to join the dedicated chat room at
/usr/share/doc/mpd\-sima/
.SH "AUTHOR"
.PP
-\fBJack Kaliko\fR <\&kaliko@azylum\&.org\&>
+\fBkaliko\fR <\&kaliko@azylum\&.org\&>
.RS 4
Wrote this man page and is currently leading MPD_sima project\&.
.RE
.SH "COPYRIGHT"
.br
-Copyright \(co 2009-2019 Jack Kaliko
+Copyright \(co 2009-2021 kaliko
.br
.PP
This manual page was written for the Debian system (and may be used by others)\&.
home / dev / repositories / mpd-sima.git / blobdiff