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 [tags]
 124 ## Offline tags queing
 125 # This plugin has no defaults set
 126
 127 # TAGS, any of the supported tags below
 128 # type: string
 129 # default: not set
 130 # description:
 131 comment=
 132 date=
 133 genre=
 134 label=
 135 originaldate=
 136
 137 ## FILTER
 138 # type: string
 139 # default: not set
 140 # description: Forge your own MPD filter (cf MPD protocol documentation)
 141 filter=
 142
 143 ## QUEUE_MODE
 144 # type: string
 145 # description: The default is to queue random tracks from similar artists.
 146 # Possible values:
 147 #       track : Will queue tracks from similar artists (default).
 148 #       album : Will queue whole album from similar artists.
 149 queue_mode = track
 150
 151 ## TRACK_TO_ADD
 152 # type: integer
 153 # scope: "track" and "top" queue modes
 154 # description: how many tracks the plugin will try to get
 155 track_to_add = 1
 156
 157 ## ALBUM_TO_ADD
 158 # type: integer
 159 # scope: "album" queue mode
 160 # description: how many albums the plugin will try to get
 161 album_to_add = 1
 162
 163 [crop]
 164 ## CONSUME
 165 # type: integer
 166 # default: 10
 167 # description: How many played tracks to keep in the playlist.
 168 #  Allow to maintain a fixed length playlist.
 169 #  Set a negative value to disable cropping (or remove plugin from sima/internal)
 170 #consume = 10
 171
 172 [random]
 173 ## FLAVOUR
 174 # type: string
 175 # default: sensible
 176 # description: Random queuing, different mode, aka random flavour, are available.
 177 #     random flavour :
 178 #       * pure:     complete random choice among all tracks available in the
 179 #                   player media library
 180 #       * sensible: use play history to filter chosen tracks
 181 #       * genre:    # NOT IMPLEMENTED #
 182 #                   chose among the same genre as current track (using genre
 183 #                   tag). If no genre tag is available "sensible" flavour
 184 #                   is used  instead
 185 flavour=sensible
 186
 187 ## TRACK_TO_ADD
 188 # type: integer
 189 # description: how many tracks the plugin will try to get
 190 # default: 1
 191 #track_to_add = 1
 192
 193
 194 [lastfm]
 195 ## QUEUE_MODE
 196 # type: string
 197 # description: The default is to queue random tracks from similar artists.
 198 # Possible values:
 199 #       track : Will queue tracks from similar artists (default).
 200 #       top   : Will queue top tracks from similar artists.
 201 #       album : Will queue whole album from similar artists.
 202 queue_mode = track
 203
 204 ## MAX_ART
 205 # type: integer
 206 # description: Number of similar artist to retrieve from local media library.
 207 #  When set to something superior to zero, MPD_sima tries to get as much similar
 208 #  artists from media library
 209 max_art = 10
 210
 211 ## DEPTH
 212 # type: integer in [1, +∞]
 213 # default: 1
 214 # description: TBD
 215 depth = 1
 216
 217 ## SINGLE_ALBUM
 218 # type: boolean
 219 # scope: "track" and "top" queue modes
 220 # description: Prevent from queueing a track from the same album (for instance
 221 #  with OST).
 222 single_album = false
 223
 224 ## TRACK_TO_ADD
 225 # type: integer
 226 # scope: "track" and "top" queue modes
 227 # description: how many tracks the plugin will try to get
 228 track_to_add = 1
 229
 230 ## ALBUM_TO_ADD
 231 # type: integer
 232 # scope: "album" queue mode
 233 # description: how many albums the plugin will try to get
 234 album_to_add = 1
 235
 236 ## TRACK_TO_ADD_FROM_ALBUM
 237 # type: integer
 238 # scope: "album" queue mode
 239 # description: how many tracks from one album the plugin will try to get
 240 #              defaults to 0 to queue the whole album
 241 track_to_add_from_album = 0
 242
 243 ## SHUFFLE_ALBUM
 244 # type: boolean
 245 # scope: "album" queue mode
 246 # description: should the tracks of the album be shuffled
 247 shuffle_album = false
 248
 249 ## CACHE
 250 # type: boolean
 251 # description: whether or not to use on-disk persistent http cache
 252 #  * When set to "true", sima will use a persistent cache for its http client.
 253 #    The cache is written along with the dbfile in:
 254 #                $XDG_CONFIG_HOME/mpd_sima/http/<web_service>
 255 #     Until #7 is closed LastFM is broken; cf. https://gitlab.com/kaliko/sima/issues/7
 256 #  * If set to "false", caching is still done but in memory.
 257 # default: True
 258 cache = True
 259
 260 #
 261 ####################### END OF CONFIGURATION ##########################
 262 # vim: syntax=cfg fileencoding=utf-8