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