]> kaliko git repositories - mpd-sima.git/blob - doc/examples/all_settings.cfg
Some more clean-up
[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 = "Crop, Lastfm, RandomFallBack"
69 #          contrib =
70 # description: Plugins list declaration.
71 #     Optional plugin's configuration lays in its own section.
72 #     For instance a "AwesomePlugin" declared here
73 #     gets its configuration from the corresponding section:
74 #     "[awesomeplugin]"
75 #     internal plugins will look for a section named after the lower-cased name
76 #     of the pluglin, ie. RandomFallBack → randomfallback.
77 #
78 #     Two plugins sources are available, internal and contrib
79 #
80 internal = Crop, Lastfm, RandomFallBack
81 #contrib =
82
83 ## HISTORY_DURATION
84 # type: integer (in hours)
85 # default: 8
86 # description: How far to look back in history to avoid to play twice the same
87 #     track/title
88 #
89 history_duration = 8
90
91 ## USER_DB # NOT IMPLEMENTED #
92 # type: boolean
93 # description: Load user database to find similar artists
94 #     User DB is loaded from $XDG_CONFIG_HOME/mpd_sima/sima.db
95 #     Use simadb_cli to edit/add entries.
96 user_db = false
97
98 ## QUEUE_LENGTH
99 # type: integer
100 # default: 1
101 # description: Queue length triggering tracks addition
102 queue_length = 1
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 [randomfallback]
122 ## FLAVOUR
123 # type: string
124 # default: sensible
125 # description: When no similar tracks are found, falling back to random
126 #     queuing. Different mode, aka random flavour, are available.
127 #     random flavour :
128 #       * pure:     complete random choice among all tracks available in the
129 #                   player media library
130 #       * sensible: use play history to filter chosen tracks
131 #       * genre:    # NOT IMPLEMENTED #
132 #                   chose among the same genre as current track (using genre
133 #                   tag). If no genre tag is available "sensible" flavour
134 #                   is used  instead
135 #flavour=sensible
136
137 ## TRACK_TO_ADD
138 # type: integer
139 # description: how many tracks the plugin will try to get
140 # default: 1
141 #track_to_add = 1
142
143
144 # EchoNest or LastFM
145 #[echonest]
146 [lastfm]
147 ## QUEUE_MODE
148 # type: string
149 # description: The default is to queue random tracks from similar artists.
150 # Possible values:
151 #       track : Will queue tracks from similar artists (default).
152 #       top   : Will queue top tracks from similar artists.
153 #       album : Will queue whole album from similar artists.
154 queue_mode = track
155
156 ## MAX_ART
157 # type: integer
158 # description: Number of similar artist to retrieve from local media library.
159 #  When set to something superior to zero, MPD_sima tries to get as much similar
160 #  artists from media library
161 max_art = 10
162
163 ## DEPTH
164 # type: integer in [1, +∞]
165 # default: 1
166 # description: TBD
167 depth = 1
168
169 ## SINGLE_ALBUM
170 # type: boolean
171 # scope: "track" and "top" queue modes
172 # description: Prevent from queueing a track from the same album (for instance
173 #  with OST).
174 single_album = false
175
176 ## TRACK_TO_ADD
177 # type: integer
178 # scope: "track" and "top" queue modes
179 # description: how many tracks the plugin will try to get
180 track_to_add = 1
181
182 ## ALBUM_TO_ADD
183 # type: integer
184 # scope: "album" queue mode
185 # description: how many albums the plugin will try to get
186 album_to_add = 1
187
188 ## CACHE
189 # type: boolean
190 # description: whether or not to use on-disk persistent http cache
191 #  * When set to "true", sima will use a persistent cache for its http client.
192 #    The cache is written along with the dbfile in:
193 #                $XDG_CONFIG_HOME/mpd_sima/http/<web_service>
194 #    Toggling http cache is only available for last.fm. EchoNest have rate limits,
195 #    we must then pay attention to bandwidth and use of caching is required.
196 #  * If set to "false", caching is still done but in memory.
197 # default: True
198 cache = True
199
200 #
201 ####################### END OF CONFIGURATION ##########################
202 # vim: syntax=cfg fileencoding=utf-8