doc/examples/all_settings.cfg

   1 ########################################################################
   2 #
   3 # If you need special settings, rename this file as mpd_sima.cfg within
   4 # your $XDG_CONFIG_HOME (default is $HOME/.config/mpd_sima/)
   5 # You can also call it with --config option.
   6 #
   7 # cf. man 5 mpd_sima.cfg
   8 ########################################################################
   9
  10 ########################## MPD SECTION ################################
  11 #
  12 [MPD]
  13 ## HOST
  14 # type: string (IP or FQDN)
  15 # description: MPD host
  16 # default: localhost
  17 host = localhost
  18
  19 ## PORT
  20 # type: integer
  21 # description: MPD host port
  22 # default: 6600
  23 port = 6600
  24
  25 ## PASSWORD
  26 # type: string
  27 # default: unset, not using authentication
  28 # description: MPD host password, comment if you don't use
  29 #password = s3cr3t
  30
  31 #
  32 #######################################################################
  33
  34 ########################## DAEMON SECTION ################################
  35 #
  36 [daemon]
  37 ## DAEMON
  38 # type: boolean
  39 # description: whether to daemonize process or not
  40 # default: False
  41 daemon=false
  42
  43 ## PIDFILE
  44 # type: string (path to the pid file)
  45 # description: where to store process ID
  46 # default: unset, process ID not saved to file
  47 #pidfile=
  48 #
  49 #######################################################################
  50
  51 ######################## LOGGING FACILITY #############################
  52 #
  53 [log]
  54 ## LOGFILE
  55 # type: string (file path)
  56 # description: file to log to. Usually used when process is daemonized.
  57 # default: unset, logging to stdin/stdout
  58 #logfile =
  59
  60 ## VERBOSITY
  61 # type: string
  62 # description: log verbosity
  63 # default: info
  64 # Possible values:
  65 #    * debug, PAY ATTENTION: *DEBUG LEVEL MIGHT PRINT OUT YOUR PASSWORD*
  66 #    * info, default
  67 #    * warning
  68 #    * error
  69 verbosity = info
  70 #
  71 #######################################################################
  72
  73
  74 ######################## SIMA CORE ####################################
  75 #
  76 # These settings deal with MPD_sima core behaviour.
  77 [sima]
  78 ## PLUGINS
  79 # type: comma separated string list
  80 #       for ex.:
  81 #                contrib = Scrobble, AwesomePlugin,
  82 #                          ExperimentalTest, AnotherTest
  83 # default:
  84 #          internal = "Lastfm, Random, Crop"
  85 #          contrib =
  86 #
  87 # Possible values for internal
  88 #       Lastfm   : Queue using last.fm web service for suggestions.
  89 #       Random   : Queue a track at random (different flavour, cf. documentation)
  90 #       Crop     : Remove old tracks from queue
  91 #
  92 # description: Plugins list declaration.
  93 #     Optional plugin's configuration lays in its own section.
  94 #     For instance a "AwesomePlugin" declared here
  95 #     gets its configuration from the corresponding section:
  96 #     "[awesomeplugin]"
  97 #     internal plugins will look for a section named after the lower-cased name
  98 #     of the plugin, ie. AwesomePlugin → awesomeplugin.
  99 #
 100 #     Two plugins sources are available, internal and contrib
 101 #
 102 internal = Lastfm, Random, Crop
 103 #contrib =
 104
 105 ## HISTORY_DURATION
 106 # type: integer (in hours)
 107 # default: 8
 108 # description: How far to look back in history to avoid to play twice the same
 109 #     track/title
 110 #
 111 history_duration = 8
 112
 113 ## QUEUE_LENGTH
 114 # type: integer
 115 # default: 2
 116 # description: Queue length threshold triggering tracks addition
 117 queue_length = 2
 118
 119 ## MUSICBRAINZID
 120 # type: boolean
 121 # default: True
 122 # description: Use of MusicBrainzIdentifier tag
 123 musicbrainzid = True
 124
 125 ## REPEAT_DISABLE_QUEUE
 126 # type: boolean
 127 # default: True
 128 # description: Prevent repeat play mode to disable queuing
 129 repeat_disable_queue = True
 130
 131 ## SINGLE_DISABLE_QUEUE
 132 # type: boolean
 133 # default: True
 134 # description: Prevent single play mode to disable queuing
 135 single_disable_queue  = True
 136 #
 137 #######################################################################
 138
 139 ######################### PLUGINS #####################################
 140 #
 141 [genre]
 142 ## Offline genre queing
 143
 144 ## QUEUE_MODE
 145 # type: string
 146 # description: Configure queue mode, a single track or an album
 147 # Possible values:
 148 #       track : Will queue single track artists (default).
 149 #       album : Will queue whole album from artists.
 150 queue_mode = track
 151
 152 ## SINGLE_ALBUM
 153 # type: boolean
 154 # scope: "track" queue mode only
 155 # description: Prevent from queueing a track from the same album (for instance
 156 #  with OST).
 157 single_album = false
 158
 159 ## TRACK_TO_ADD
 160 # type: integer
 161 # scope: "track" and "top" queue modes
 162 # description: how many tracks the plugin will try to get
 163 track_to_add = 1
 164
 165 ## ALBUM_TO_ADD
 166 # type: integer
 167 # scope: "album" queue mode
 168 # description: how many albums the plugin will try to get
 169 album_to_add = 1
 170
 171
 172 [tags]
 173 ## Offline tags queing
 174 # This plugin has no defaults set
 175
 176 # TAGS, any of the supported tags below
 177 # type: string
 178 # default: not set
 179 # description:
 180 comment=
 181 date=
 182 genre=
 183 label=
 184 originaldate=
 185
 186 ## FILTER
 187 # type: string
 188 # default: not set
 189 # description: Forge your own MPD filter (cf MPD protocol documentation)
 190 filter=
 191
 192 ## QUEUE_MODE
 193 # type: string
 194 # description: Configure queue mode, a single track or an album
 195 # Possible values:
 196 #       track : Will queue single track artists (default).
 197 #       album : Will queue whole album from artists.
 198 queue_mode = track
 199
 200 ## SINGLE_ALBUM
 201 # type: boolean
 202 # scope: "track" queue mode only
 203 # description: Prevent from queueing a track from the same album (for instance
 204 #  with OST).
 205 single_album = false
 206
 207 ## TRACK_TO_ADD
 208 # type: integer
 209 # scope: "track" and "top" queue modes
 210 # description: how many tracks the plugin will try to get
 211 track_to_add = 1
 212
 213 ## ALBUM_TO_ADD
 214 # type: integer
 215 # scope: "album" queue mode
 216 # description: how many albums the plugin will try to get
 217 album_to_add = 1
 218
 219 [crop]
 220 ## CONSUME
 221 # type: integer
 222 # default: 10
 223 # description: How many played tracks to keep in the playlist.
 224 #  Allow to maintain a fixed length playlist.
 225 #  Set a negative value to disable cropping (or remove plugin from sima/internal)
 226 #consume = 10
 227
 228 [random]
 229 ## FLAVOUR
 230 # type: string
 231 # default: sensible
 232 # description: Random queuing, different mode, aka random flavour, are available.
 233 #     random flavour :
 234 #       * pure:     complete random choice among all tracks available in the
 235 #                   player media library
 236 #       * sensible: use play history to filter chosen tracks
 237 #       * genre:    # NOT IMPLEMENTED #
 238 #                   chose among the same genre as current track (using genre
 239 #                   tag). If no genre tag is available "sensible" flavour
 240 #                   is used  instead
 241 flavour=sensible
 242
 243 ## TRACK_TO_ADD
 244 # type: integer
 245 # description: how many tracks the plugin will try to get
 246 # default: 1
 247 #track_to_add = 1
 248
 249
 250 [lastfm]
 251 ## QUEUE_MODE
 252 # type: string
 253 # description: Does it queue a single track, top track or an album.
 254 # Possible values:
 255 #       track : Will queue single tracks from similar artists (default).
 256 #       top   : Will queue top tracks from similar artists.
 257 #       album : Will queue whole album from similar artists.
 258 queue_mode = track
 259
 260 ## MAX_ART
 261 # type: integer
 262 # description: Number of similar artist to retrieve from local media library.
 263 #  When set to something superior to zero, MPD_sima tries to get as much similar
 264 #  artists from media library
 265 max_art = 20
 266
 267 ## DEPTH
 268 # type: integer in [1, +∞]
 269 # default: 1
 270 # description: TBD
 271 depth = 1
 272
 273 ## SINGLE_ALBUM
 274 # type: boolean
 275 # scope: "track" and "top" queue modes
 276 # description: Prevent from queueing a track from the same album (for instance
 277 #  with OST).
 278 single_album = false
 279
 280 ## TRACK_TO_ADD
 281 # type: integer
 282 # scope: "track" and "top" queue modes
 283 # description: how many tracks the plugin will try to get
 284 track_to_add = 1
 285
 286 ## ALBUM_TO_ADD
 287 # type: integer
 288 # scope: "album" queue mode
 289 # description: how many albums the plugin will try to get
 290 album_to_add = 1
 291
 292 ## TRACK_TO_ADD_FROM_ALBUM
 293 # type: integer
 294 # scope: "album" queue mode
 295 # description: how many tracks from one album the plugin will try to get
 296 #              defaults to 0 to queue the whole album
 297 track_to_add_from_album = 0
 298
 299 ## SHUFFLE_ALBUM
 300 # type: boolean
 301 # scope: "album" queue mode
 302 # description: should the tracks of the album be shuffled
 303 shuffle_album = false
 304
 305 ## CACHE
 306 # type: boolean
 307 # description: whether or not to use on-disk persistent http cache
 308 #  * When set to "true", sima will use a persistent cache for its http client.
 309 #    The cache is written along with the dbfile in:
 310 #                $XDG_CONFIG_HOME/mpd_sima/http/<web_service>
 311 #     Until #7 is closed LastFM is broken; cf. https://gitlab.com/kaliko/sima/issues/7
 312 #  * If set to "false", caching is still done but in memory.
 313 # default: True
 314 cache = True
 315 #
 316 #######################################################################
 317
 318 # vim: syntax=cfg fileencoding=utf-8