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