]> kaliko git repositories - mpd-sima.git/blob - doc/examples/all_settings.cfg
Add option to generate config on stdout
[mpd-sima.git] / doc / examples / all_settings.cfg
1 ########################################################################
2 #
3 # If you need special settings, rename this file as mpd_sima.cfg within
4 # your $XDG_CONFIG_HOME (default is $HOME/.config/mpd_sima/)
5 # You can also call it with --config option.
6 #
7 # cf. man 5 mpd_sima.cfg
8 ########################################################################
9
10 ########################## MPD SECTION ################################
11 #
12 [MPD]
13 ## HOST
14 # type: string (IP or FQDN)
15 # description: MPD host
16 # default: localhost
17 host = localhost
18
19 ## PORT
20 # type: integer
21 # description: MPD host port
22 # default: 6600
23 port = 6600
24
25 ## PASSWORD
26 # type: string
27 # default: unset, not using authentication
28 # description: MPD host password, comment if you don't use
29 #password = s3cr3t
30
31 #
32 #######################################################################
33
34 ######################## LOGGING FACILITY #############################
35 #
36 [log]
37 ## LOGFILE
38 # type: string (file path)
39 # description: file to log to. Usually used in daemon mode.
40 # default: unset, logging to stdin/stdout
41 #logfile =
42
43 ## VERBOSITY
44 # type: string
45 # description: log verbosity
46 # default: info
47 # Possible values:
48 #    * debug, PAY ATTENTION: *DEBUG LEVEL MIGHT PRINT OUT YOUR PASSWORD*
49 #    * info, default
50 #    * warning
51 #    * error
52 verbosity = info
53
54 #
55 #######################################################################
56
57
58 ######################## SIMA CORE ####################################
59 #
60 # These settings deal with MPD_sima core behaviour.
61 [sima]
62 ## PLUGINS
63 # type: comma separated string list
64 #       for ex.:
65 #                contrib = Scrobble, AwesomePlugin,
66 #                          ExperimentalTest, AnotherTest
67 # default:
68 #          internal = "Lastfm, Random, Crop"
69 #          contrib =
70 #
71 # Possible values for internal
72 #       Lastfm   : Queue using last.fm web service for suggestions.
73 #       EchoNest : Queue using EchoNest web service for suggestions.
74 #       Random   : Queue a track at random (different flavour, cf. documentation)
75 #       Crop     : Remove old tracks from queue
76 #
77 # description: Plugins list declaration.
78 #     Optional plugin's configuration lays in its own section.
79 #     For instance a "AwesomePlugin" declared here
80 #     gets its configuration from the corresponding section:
81 #     "[awesomeplugin]"
82 #     internal plugins will look for a section named after the lower-cased name
83 #     of the plugin, ie. AwesomePlugin → awesomeplugin.
84 #
85 #     Two plugins sources are available, internal and contrib
86 #
87 internal = Lastfm, Random, Crop
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 ## QUEUE_LENGTH
99 # type: integer
100 # default: 2
101 # description: Queue length threshold triggering tracks addition
102 queue_length = 2
103
104 ## MUSICBRAINZID
105 # type: boolean
106 # default: True
107 # description: Use of MusicBrainzIdentifier tag
108 musicbrainzid = True
109
110 ######################### PLUGINS #####################################
111
112 [crop]
113 ## CONSUME
114 # type: integer
115 # default: unset, not cropping playlist
116 # description: How many played tracks to keep in the playlist.
117 #  Allow to maintain a fixed length playlist.
118 #  Leave commented to keep all tracks
119 #consume = 10
120
121 [random]
122 ## FLAVOUR
123 # type: string
124 # default: sensible
125 # description: Random queuing, different mode, aka random flavour, are available.
126 #     random flavour :
127 #       * pure:     complete random choice among all tracks available in the
128 #                   player media library
129 #       * sensible: use play history to filter chosen tracks
130 #       * genre:    # NOT IMPLEMENTED #
131 #                   chose among the same genre as current track (using genre
132 #                   tag). If no genre tag is available "sensible" flavour
133 #                   is used  instead
134 flavour=sensible
135
136 ## TRACK_TO_ADD
137 # type: integer
138 # description: how many tracks the plugin will try to get
139 # default: 1
140 #track_to_add = 1
141
142
143 # EchoNest or Lastfm
144 #[echonest]
145 [lastfm]
146 ## QUEUE_MODE
147 # type: string
148 # description: The default is to queue random tracks from similar artists.
149 # Possible values:
150 #       track : Will queue tracks from similar artists (default).
151 #       top   : Will queue top tracks from similar artists.
152 #       album : Will queue whole album from similar artists.
153 queue_mode = track
154
155 ## MAX_ART
156 # type: integer
157 # description: Number of similar artist to retrieve from local media library.
158 #  When set to something superior to zero, MPD_sima tries to get as much similar
159 #  artists from media library
160 max_art = 10
161
162 ## DEPTH
163 # type: integer in [1, +∞]
164 # default: 1
165 # description: TBD
166 depth = 1
167
168 ## SINGLE_ALBUM
169 # type: boolean
170 # scope: "track" and "top" queue modes
171 # description: Prevent from queueing a track from the same album (for instance
172 #  with OST).
173 single_album = false
174
175 ## TRACK_TO_ADD
176 # type: integer
177 # scope: "track" and "top" queue modes
178 # description: how many tracks the plugin will try to get
179 track_to_add = 1
180
181 ## ALBUM_TO_ADD
182 # type: integer
183 # scope: "album" queue mode
184 # description: how many albums the plugin will try to get
185 album_to_add = 1
186
187 ## CACHE
188 # type: boolean
189 # description: whether or not to use on-disk persistent http cache
190 #  * When set to "true", sima will use a persistent cache for its http client.
191 #    The cache is written along with the dbfile in:
192 #                $XDG_CONFIG_HOME/mpd_sima/http/<web_service>
193 #    Toggling http cache is only available for last.fm. EchoNest have rate limits,
194 #    we must then pay attention to bandwidth and use of caching is required.
195 #  * If set to "false", caching is still done but in memory.
196 # default: True
197 cache = True
198
199 #
200 ####################### END OF CONFIGURATION ##########################
201 # vim: syntax=cfg fileencoding=utf-8