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