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