'\" t
.\" Title: mpd_sima.cfg
.\" Author: kaliko <kaliko@azylum.org>
-.\" Generator: DocBook XSL Stylesheets v1.79.1 <http://docbook.sf.net/>
-.\" Date: 01/09/2021
-.\" Manual: mpd-sima 0.16.1 User Manual
+.\" 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" "01/09/2021" "mpd-sima" "mpd-sima 0.16.1 User Manual"
+.TH "MPD_SIMA\&.CFG" "5" "11/16/2021" "mpd-sima" "mpd-sima 0.18.0 User Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.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
.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
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\&.
\fB\*(Aqgenre\*(Aq\fR,
\fB\*(Aqlabel\*(Aq\fR
and
-\fB\*(Aqoriginaldate\*(Aq\fR\&. It currently supports single track queuing only, no album mode for this plugin\&.
+\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 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 ORed\&.
+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 1985 through 1990\&.
+and date within 1982 through 1989\&.
.br
Using an MPD filter to replace
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\&.
.RS 4
.RE
.PP
+\fBoriginaldate=\fR
+.RS 4
+.RE
+.PP
\fBpriority=\fR\fI80\fR
.RS 4
Plugin priority
home / dev / repositories / mpd-sima.git / blobdiff