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