]> kaliko git repositories - mpd-sima.git/blob - doc/examples/all_settings.cfg
119d7f42a15a187d0746ea0c4945edae5d661f99
[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 ## VERBOSITY
53 # type: string
54 # description: log verbosity
55 # default: info
56 # Possible values:
57 #    * debug, PAY ATTENTION: *DEBUG LEVEL MIGHT PRINT OUT YOUR PASSWORD*
58 #    * info, default
59 #    * warning
60 #    * error
61 verbosity = info
62
63 #
64 #######################################################################
65
66
67 ######################## SIMA CORE ####################################
68 #
69 # These settings deal with MPD_sima core behaviour.
70 [sima]
71 ## PLUGINS
72 # type: comma separated string list
73 #       for ex.:
74 #                contrib = Scrobble, AwesomePlugin,
75 #                          ExperimentalTest, AnotherTest
76 # default:
77 #          internal = "Crop, Lastfm, RandomFallBack"
78 #          contrib =
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 =
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 ## USER_DB # NOT IMPLEMENTED #
99 # type: boolean
100 # description: Load user database to find similar artists
101 #     User DB is loaded from $XDG_CONFIG_HOME/mpd_sima/sima.db
102 #     Use simadb_cli to edit/add entries.
103 user_db = false
104
105 ## QUEUE_LENGTH
106 # type: integer
107 # default: 1
108 # description: Queue length triggering tracks addition
109 queue_length = 1
110
111 ######################### PLUGINS #####################################
112
113 [crop]
114 ## CONSUME
115 # type: integer
116 # default: unset, not cropping playlist
117 # description: How many played tracks to keep in the playlist.
118 #  Allow to maintain a fixed length playlist.
119 #  Leave commented to keep all tracks
120 #consume = 10
121
122 [randomfallback]
123 ## FLAVOUR
124 # type: string
125 # default: sensible
126 # description: When no similar tracks are found, falling back to random
127 #     queuing. Different mode, aka random flavour, are available.
128 #     random flavour :
129 #       * pure:     complete random choice among all tracks available in the
130 #                   player media library
131 #       * sensible: use play history to filter chosen tracks
132 #       * genre:    # NOT IMPLEMENTED #
133 #                   chose among the same genre as current track (using genre
134 #                   tag). If no genre tag is available "sensible" flavour
135 #                   is used  instead
136 #flavour=sensible
137
138 ## TRACK_TO_ADD
139 # type: integer
140 # description: how many tracks the plugin will try to get
141 # default: 1
142 #track_to_add = 1
143
144
145 # EchoNest or LastFM
146 #[echonest]
147 [lastfm]
148 ## QUEUE_MODE
149 # type: string
150 # description: The default is to queue random tracks from similar artists.
151 # Possible values:
152 #       track : Will queue tracks from similar artists (default).
153 #       top   : Will queue top tracks from similar artists.
154 #       album : Will queue whole album from similar artists.
155 queue_mode = track
156
157 ## MAX_ART
158 # type: integer
159 # description: Number of similar artist to retrieve from local media library.
160 #  When set to something superior to zero, MPD_sima tries to get as much similar
161 #  artists from media library
162 max_art = 10
163
164 ## DEPTH
165 # type: integer in [1, +∞]
166 # default: 1
167 # description: TBD
168 depth = 1
169
170 ## SINGLE_ALBUM
171 # type: boolean
172 # scope: "track" and "top" queue modes
173 # description: Prevent from queueing a track from the same album (for instance
174 #  with OST).
175 single_album = false
176
177 ## TRACK_TO_ADD
178 # type: integer
179 # scope: "track" and "top" queue modes
180 # description: how many tracks the plugin will try to get
181 track_to_add = 1
182
183 ## ALBUM_TO_ADD
184 # type: integer
185 # scope: "album" queue mode
186 # description: how many albums the plugin will try to get
187 album_to_add = 1
188
189 ## CACHE
190 # type: boolean
191 # description: whether or not to use on-disk persistent http cache
192 #  * When set to "true", sima will use a persistent cache for its http client.
193 #    The cache is written along with the dbfile in:
194 #                $XDG_CONFIG_HOME/mpd_sima/http/<web_service>
195 #    Toggling http cache is only available for last.fm. EchoNest have rate limits,
196 #    we must then pay attention to bandwidth and use of caching is required.
197 #  * If set to "false", caching is still done but in memory.
198 # default: True
199 cache = True
200
201 #
202 ####################### END OF CONFIGURATION ##########################
203
204 # vim: syntax=cfg fileencoding=utf-8