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