doc/examples/all_settings.cfg

   1 ########################################################################
   2 #
   3 # If you need special settings, rename this file as sima.cfg within
   4 # your $XDG_CONFIG_HOME (default is $HOME/.config/sima/)
   5 # You can also call it with --config option.
   6 #
   7 # Pay Attention:
   8 # * Inline comment are not possible
   9 #
  10 #  WRONG:
  11 #  host = localhost  # My host
  12 #
  13 #  OK:
  14 #  # My host
  15 #  host = localhost
  16 #
  17 ########################################################################
  18
  19 ########################## MPD SECTION ################################
  20 #
  21 [MPD]
  22 ## HOST
  23 # type: string
  24 host = localhost
  25 ## PORT
  26 # type: integer
  27 port = 6600
  28 ## PASSWORD
  29 # type: string
  30 #
  31 # please comment if you don't use
  32 #password = s3cr3t
  33
  34 #
  35 #######################################################################
  36
  37 ######################## LOGGING FACILITY #############################
  38 #
  39 [log]
  40 ## LOGFILE
  41 # type: string (file path)
  42 # description: file to log to. Usually used in daemon mode.
  43 # default: logging to stdin/stdout
  44 #logfile =
  45 ##
  46
  47 ## VERBOSITY
  48 # type: string
  49 # description: log verbosity
  50 # Possible values:
  51 #  * debug, *DEBUG LEVEL MIGHT PRINT OUT YOUR PASSWORD*
  52 #  * info, default
  53 #  * warning
  54 #  * error
  55 #
  56 verbosity = info
  57 ##
  58
  59 #
  60 #######################################################################
  61
  62 ######################### PLUGINS #####################################
  63 #
  64 [placeholder]
  65 key = Value
  66
  67 #[crop]
  68 # type: integer
  69 # description: How many played tracks to keep in the playlist.
  70 #  Allow to maintain a fixed length playlist.
  71 #  Leave commented to keep all tracks
  72 #consume = 10
  73
  74 [crop]
  75 consume = 10
  76
  77 [RandomFallback]
  78 # random falvour :
  79 #  * pure:     complete ramdom choice among all tracks available in the player media library
  80 #  * sensible: use play history to filter chosen tracks
  81 #  * genre:    chose among the same genre as current track (tagged genre). If
  82 #              no genre tag is available "sensible" flavour is used instead
  83 flavour=pure
  84
  85 [lastfm]
  86
  87 depth = 1
  88
  89 ## QUEUE_MODE # NOT COMPLETED #
  90 # type: string
  91 # description: The default is to queue random tracks from similar artists.
  92 # Possible values:
  93 #       track : Will queue tracks from similar artists (default).
  94 #       top   : Will queue top tracks from similar artists. # NOT IMPLEMENTED #
  95 #       album : Will queue whole album from similar artists.
  96 queue_mode = track
  97
  98 ## SIMILARITY
  99 # type: integer in [0 100]
 100 # description: Similarity as a percentage of similarity between artists
 101 # (this is a last.fm metric)
 102 similarity = 15
 103
 104 ## DYNAMIC
 105 # type: integer
 106 # description: Number of similar artist to retrieve from local media library.
 107 #  When set to something superior to zero, MPD_sima tries to get as much similar
 108 #  artists from media library provided artists similarity is superior to
 109 #  similarity value.
 110 dynamic = 10
 111
 112 ## SINGLE_ALBUM # NOT IMPLEMENTED #
 113 # type: boolean
 114 # scope: "track" and "top" queue modes
 115 # description: Prevent from queueing a track from the same album (for instance with OST).
 116 single_album = true
 117
 118 ## TRACK_TO_ADD
 119 # type: integer
 120 # scope: "track" and "top" queue modes
 121 # description: how many tracks the plugin will try to get
 122 track_to_add = 1
 123
 124 ## ALBUM_TO_ADD
 125 # type: integer
 126 # scope: "album" queue mode
 127 # description: how many albums the plugin will try to get
 128 album_to_add = 1
 129
 130 #
 131 #######################################################################
 132
 133
 134 ######################## SIMA CORE ####################################
 135 #
 136 # These settings deal with MPD_sima core behaviour.
 137 [sima]
 138 ## PLUGINS
 139 # type: comma separated string list
 140 # for ex.:
 141 #          contrib = Scrobble, AwesomePlugin,
 142 #                    ExperimentalTest,AnotherTest
 143 #
 144 # Plugins list declaration.
 145 # Optional plugin's configuration must be in its own section. For instance an
 146 # "AwesomePlugin" declared here gets its configuration from the
 147 # "[AwesomePlugin]" or "[awesomeplugin]" section (case insensitive).
 148 #
 149 #internal = Crop, History, MpdOptions, Lastfm, RandomFallBack
 150 contrib = PlaceHolder
 151
 152 ## HISTORY_DURATION
 153 # type: integer (in hours)
 154 #
 155 # How far to look back in history to avoid to play twice the same track/title
 156 #
 157 history_duration = 8
 158 ##
 159
 160 ## USER_DB # NOT IMPLEMENTED #
 161 # type: boolean
 162 # description: Load user database to find similar artists
 163 #  User DB is loaded from $XDG_CONFIG_HOME/sima/sima.db
 164 #  Use simadb_cli to edit/add entries.
 165 user_db = false
 166 ##
 167
 168 #####################################################################
 169 # You do not need to set up options below.
 170 # But well, you got bored of the way MPD_sima is behaving, then go ahead
 171 # play with it :)
 172
 173 ## QUEUE_LENGTH
 174 # type: integer
 175 #
 176 # Queue length triggering tracks addition
 177 queue_length = 1
 178 ##
 179
 180 #
 181 ####################### END OF CONFIGURATION ##########################
 182
 183 # vim: syntax=cfg fileencoding=utf-8