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