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 = "Crop, Lastfm, RandomFallBack"
  69 #          contrib =
  70 # description: Plugins list declaration.
  71 #     Optional plugin's configuration lays in its own section.
  72 #     For instance a "AwesomePlugin" declared here
  73 #     gets its configuration from the corresponding section:
  74 #     "[awesomeplugin]"
  75 #     internal plugins will look for a section named after the lower-cased name
  76 #     of the pluglin, ie. RandomFallBack → randomfallback.
  77 #
  78 #     Two plugins sources are available, internal and contrib
  79 #
  80 internal = Crop, Lastfm, RandomFallBack
  81 #contrib =
  82
  83 ## HISTORY_DURATION
  84 # type: integer (in hours)
  85 # default: 8
  86 # description: How far to look back in history to avoid to play twice the same
  87 #     track/title
  88 #
  89 history_duration = 8
  90
  91 ## USER_DB # NOT IMPLEMENTED #
  92 # type: boolean
  93 # description: Load user database to find similar artists
  94 #     User DB is loaded from $XDG_CONFIG_HOME/mpd_sima/sima.db
  95 #     Use simadb_cli to edit/add entries.
  96 user_db = false
  97
  98 ## QUEUE_LENGTH
  99 # type: integer
 100 # default: 1
 101 # description: Queue length triggering tracks addition
 102 queue_length = 1
 103
 104 ######################### PLUGINS #####################################
 105
 106 [crop]
 107 ## CONSUME
 108 # type: integer
 109 # default: unset, not cropping playlist
 110 # description: How many played tracks to keep in the playlist.
 111 #  Allow to maintain a fixed length playlist.
 112 #  Leave commented to keep all tracks
 113 #consume = 10
 114
 115 [randomfallback]
 116 ## FLAVOUR
 117 # type: string
 118 # default: sensible
 119 # description: When no similar tracks are found, falling back to random
 120 #     queuing. Different mode, aka random flavour, are available.
 121 #     random flavour :
 122 #       * pure:     complete random choice among all tracks available in the
 123 #                   player media library
 124 #       * sensible: use play history to filter chosen tracks
 125 #       * genre:    # NOT IMPLEMENTED #
 126 #                   chose among the same genre as current track (using genre
 127 #                   tag). If no genre tag is available "sensible" flavour
 128 #                   is used  instead
 129 #flavour=sensible
 130
 131 ## TRACK_TO_ADD
 132 # type: integer
 133 # description: how many tracks the plugin will try to get
 134 # default: 1
 135 #track_to_add = 1
 136
 137
 138 # EchoNest or LastFM
 139 #[echonest]
 140 [lastfm]
 141 ## QUEUE_MODE
 142 # type: string
 143 # description: The default is to queue random tracks from similar artists.
 144 # Possible values:
 145 #       track : Will queue tracks from similar artists (default).
 146 #       top   : Will queue top tracks from similar artists.
 147 #       album : Will queue whole album from similar artists.
 148 queue_mode = track
 149
 150 ## MAX_ART
 151 # type: integer
 152 # description: Number of similar artist to retrieve from local media library.
 153 #  When set to something superior to zero, MPD_sima tries to get as much similar
 154 #  artists from media library
 155 max_art = 10
 156
 157 ## DEPTH
 158 # type: integer in [1, +∞]
 159 # default: 1
 160 # description: TBD
 161 depth = 1
 162
 163 ## SINGLE_ALBUM
 164 # type: boolean
 165 # scope: "track" and "top" queue modes
 166 # description: Prevent from queueing a track from the same album (for instance
 167 #  with OST).
 168 single_album = false
 169
 170 ## TRACK_TO_ADD
 171 # type: integer
 172 # scope: "track" and "top" queue modes
 173 # description: how many tracks the plugin will try to get
 174 track_to_add = 1
 175
 176 ## ALBUM_TO_ADD
 177 # type: integer
 178 # scope: "album" queue mode
 179 # description: how many albums the plugin will try to get
 180 album_to_add = 1
 181
 182 ## CACHE
 183 # type: boolean
 184 # description: whether or not to use on-disk persistent http cache
 185 #  * When set to "true", sima will use a persistent cache for its http client.
 186 #    The cache is written along with the dbfile in:
 187 #                $XDG_CONFIG_HOME/mpd_sima/http/<web_service>
 188 #    Toggling http cache is only available for last.fm. EchoNest have rate limits,
 189 #    we must then pay attention to bandwidth and use of caching is required.
 190 #  * If set to "false", caching is still done but in memory.
 191 # default: True
 192 cache = True
 193
 194 #
 195 ####################### END OF CONFIGURATION ##########################
 196 # vim: syntax=cfg fileencoding=utf-8