| blob | 8a4901833a26b983f50d9ae43133e588c43a34d3 |
1 ####################################################
2 ## this is example configuration file, copy it to ##
3 ## ~/.ncmpcpp/config and set up your preferences ##
4 ####################################################
5 #
6 ##### connection settings #####
7 #
8 ## set it in order to make tag editor and renaming files work properly
9 #
10 #mpd_host = "localhost"
11 #
12 #mpd_port = "6600"
13 #
14 #mpd_music_dir = ""
15 #
16 #mpd_connection_timeout = "5"
17 #
18 #mpd_crossfade_time = "5"
19 #
20 #mpd_communication_mode = "polling" (polling/notifications)
21 #
22 ##### music visualizer #####
23 ##
24 ## Note: In order to make music visualizer work you'll
25 ## need to use mpd fifo output, whose format parameter
26 ## has to be set to 44100:16:1. Example configuration:
27 ## (it has to be put into mpd.conf)
28 ##
29 ## audio_output {
30 ## type "fifo"
31 ## name "My FIFO"
32 ## path "/tmp/mpd.fifo"
33 ## format "44100:16:1"
34 ## }
35 ##
36 #
37 #visualizer_fifo_path = ""
38 #
39 ##
40 ## Note: Below parameter is needed for ncmpcpp
41 ## to determine which output provides data for
42 ## visualizer and thus allow syncing between
43 ## visualization and sound as currently there
44 ## are some problems with it.
45 ##
46 #
47 #visualizer_output_name = ""
48 #
49 ##
50 ## Note: Below parameter defines how often ncmpcpp
51 ## has to "synchronize" visualizer and audio outputs.
52 ## 30 seconds is optimal value, but if you experience
53 ## synchronization problems, set it to lower value.
54 ## Keep in mind that sane values start with >=10.
55 ##
56 #
57 #visualizer_sync_interval = "30"
58 #
59 ##
60 ## Note: To enable spectrum frequency visualization
61 ## you need to compile ncmpcpp with fftw3 support.
62 ##
63 #
64 #visualizer_type = "wave" (spectrum/wave)
65 #
66 ##### system encoding #####
67 ##
68 ## ncmpcpp should detect your charset encoding
69 ## but if it failed to do so, you can specify
70 ## charset encoding you are using here.
71 ##
72 ## Note: You can see whether your ncmpcpp build
73 ## supports charset detection by checking output
74 ## of `ncmpcpp --version`.
75 ##
76 ## Note: Since MPD uses utf8 by default, setting
77 ## this option makes sense only if your encoding
78 ## is different.
79 ##
80 #
81 #system_encoding = ""
82 #
83 ##### delays #####
84 #
85 ## delay after playlist highlighting will be disabled (0 = don't disable)
86 #
87 #playlist_disable_highlight_delay = "5"
88 #
89 ## defines how long various messages are supposed to be visible
90 #
91 #message_delay_time = "4"
92 #
93 ##### song format #####
94 ##
95 ## for song format you can use:
96 ##
97 ## %l - length
98 ## %f - filename
99 ## %D - directory
100 ## %a - artist
101 ## %A - album artist
102 ## %t - title
103 ## %b - album
104 ## %y - year
105 ## %n - track number (01/12 -> 01)
106 ## %N - full track info (01/12 -> 01/12)
107 ## %g - genre
108 ## %c - composer
109 ## %p - performer
110 ## %d - disc
111 ## %C - comment
112 ## $R - begin right alignment
113 ##
114 ## you can also put them in { } and then it will be displayed
115 ## only if all requested values are available and/or define alternate
116 ## value with { }|{ } eg. {%a - %t}|{%f}
117 ##
118 ## Note: Format that is similar to "%a - %t" (i.e. without any additional
119 ## braces) is equal to "{%a - %t}", so if one of the tags is missing,
120 ## you'll get nothing.
121 ##
122 ## text can also have different color than the main window has,
123 ## eg. if you want length to be green, write $3%l$9
124 ##
125 ## available values:
126 ##
127 ## - 0 - default window color (discards all other colors)
128 ## - 1 - black
129 ## - 2 - red
130 ## - 3 - green
131 ## - 4 - yellow
132 ## - 5 - blue
133 ## - 6 - magenta
134 ## - 7 - cyan
135 ## - 8 - white
136 ## - 9 - end of current color
137 ##
138 ## Note: colors can be nested.
139 ##
140 #
141 #song_list_format = "{%a - }{%t}|{$8%f$9}$R{$3(%l)$9}"
142 #
143 #song_status_format = "{{%a{ \"%b\"{ (%y)}} - }{%t}}|{%f}"
144 #
145 #song_library_format = "{%n - }{%t}|{%f}"
146 #
147 #tag_editor_album_format = "{(%y) }%b"
148 #
149 ##
150 ## Note: Below variables are for alternative version of user's interface.
151 ## Their syntax supports all tags and colors listed above plus some extra
152 ## markers used for text attributes. They are followed by character '$'.
153 ## After that you can put:
154 ##
155 ## - b - bold text
156 ## - u - underline text
157 ## - r - reverse colors
158 ## - a - use alternative character set
159 ##
160 ## If you don't want to use an attribute anymore, just put it again, but
161 ## this time insert character '/' between '$' and attribute character,
162 ## e.g. {$b%t$/b}|{$r%f$/r} will display bolded title tag or filename
163 ## with reversed colors.
164 ##
165 #
166 #alternative_header_first_line_format = "$b$1$aqqu$/a$9 {%t}|{%f} $1$atqq$/a$9$/b"
167 #
168 #alternative_header_second_line_format = "{{$4$b%a$/b$9}{ - $7%b$9}{ ($4%y$9)}}|{%D}"
169 #
170 ##
171 ## Note: Below variables also supports
172 ## text attributes listed above.
173 ##
174 #
175 #now_playing_prefix = "$b"
176 #
177 #now_playing_suffix = "$/b"
178 #
179 #browser_playlist_prefix = "$2playlist$9 "
180 #
181 #selected_item_prefix = "$6"
182 #
183 #selected_item_suffix = "$9"
184 #
185 ## colors are not supported for below variable
186 #
187 #song_window_title_format = "{%a - }{%t}|{%f}"
188 #
189 ##### columns settings #####
190 ##
191 ## syntax of song columns list format is "column column etc."
192 ##
193 ## - syntax for each column is:
194 ##
195 ## (width of column)[column's color]{displayed tag}
196 ##
197 ## Note: Width is by default in %, if you want a column to
198 ## have fixed size, add 'f' after the value, e.g. (10)[white]{a}
199 ## will be the column that take 10% of screen (so the real column's
200 ## width will depend on actual screen size), whereas (10f)[white]{a}
201 ## will take 10 terminal cells, no matter how wide the screen is.
202 ##
203 ## - color is optional (if you want the default one, type [])
204 ##
205 ## Note: You can give a column additional attributes by putting appropriate
206 ## character after displayed tag character. Available attributes are:
207 ##
208 ## - r - column will be right aligned
209 ## - E - if tag is empty, empty tag marker won't be displayed
210 ##
211 ## E.g. {lr} will give you right aligned column of lengths.
212 ##
213 #
214 #song_columns_list_format = "(7f)[green]{l} (25)[cyan]{a} (40)[]{t} (30)[red]{b}"
215 #
216 ##### various settings #####
217 #
218 ##
219 ## Note: Custom command that will be executed each
220 ## time song changes. Useful for notifications etc.
221 ##
222 ## Attention: It doesn't support song format anymore.
223 ## Use `ncmpcpp --now-playing SONG_FORMAT` instead.
224 ##
225 #execute_on_song_change = ""
226 #
227 #playlist_show_remaining_time = "no"
228 #
229 #playlist_display_mode = "classic" (classic/columns)
230 #
231 #browser_display_mode = "classic" (classic/columns)
232 #
233 #search_engine_display_mode = "classic" (classic/columns)
234 #
235 #discard_colors_if_item_is_selected = "yes"
236 #
237 #incremental_seeking = "yes"
238 #
239 #seek_time = "1"
240 #
241 #autocenter_mode = "no"
242 #
243 #centered_cursor = "no"
244 #
245 #progressbar_look = "=>"
246 #
247 #default_place_to_search_in = "database" (database/playlist)
248 #
249 #user_interface = "classic" (classic/alternative)
250 #
251 #media_library_left_column = "a" (possible values: a,y,g,c,p, legend above)
252 #
253 #default_find_mode = "wrapped" (wrapped/normal)
254 #
255 #default_space_mode = "add" (add/select)
256 #
257 #default_tag_editor_left_col = "albums" (albums/dirs)
258 #
259 #default_tag_editor_pattern = "%n - %t"
260 #
261 #header_visibility = "yes"
262 #
263 #statusbar_visibility = "yes"
264 #
265 #header_text_scrolling = "yes"
266 #
267 #fancy_scrolling = "yes"
268 #
269 #cyclic_scrolling = "no"
270 #
271 #lines_scrolled = "2"
272 #
273 #follow_now_playing_lyrics = "no"
274 #
275 #ncmpc_like_songs_adding = "no" (enabled - add/remove, disabled - always add)
276 #
277 #show_hidden_files_in_local_browser = "no"
278 #
279 #display_screens_numbers_on_start = "yes"
280 #
281 ##
282 ## How shall key_screen_switcher work?
283 ##
284 ## - "previous" - switch between current and last used screen
285 ## - "sequence: 2 -> 9 -> 5" - switch between given sequence of screens.
286 ##
287 ## Screen numbers you can use after 'sequence' keyword are:
288 ##
289 ## - 1 - help
290 ## - 2 - playlist
291 ## - 3 - browser
292 ## - 4 - search engine
293 ## - 5 - media library
294 ## - 6 - playlist editor
295 ## - 7 - tag editor
296 ## - 8 - outputs
297 ## - 9 - visualizer
298 ## - 10 - clock
299 ##
300 ## As you can see, above example will switch between
301 ## playlist, visualizer and media library screens.
302 ##
303 #screen_switcher_mode = "sequence: 2 -> 3"
304 #
305 ##
306 ## Note: You can define startup screen for ncmpcpp
307 ## by choosing screen number from the list above.
308 ##
309 #startup_screen = "2"
310 #
311 #jump_to_now_playing_song_at_start = "yes"
312 #
313 #ask_before_clearing_main_playlist = "no"
314 #
315 #clock_display_seconds = "no"
316 #
317 #display_bitrate = "no"
318 #
319 #display_remaining_time = "no"
320 #
321 #regular_expressions = "basic" (basic/extended)
322 #
323 ##
324 ## Note: If below is enabled, ncmpcpp will ignore leading
325 ## "The" word while sorting items in browser, tags in
326 ## media library, etc.
327 ##
328 #ignore_leading_the = "no"
329 #
330 #block_search_constraints_change_if_items_found = "yes"
331 #
332 #mouse_support = "yes"
333 #
334 #mouse_list_scroll_whole_page = "yes"
335 #
336 #empty_tag_marker = "<empty>"
337 #
338 #tag_editor_extended_numeration = "no"
339 #
340 #media_library_display_date = "yes"
341 #
342 #media_library_disable_two_column_mode = "no"
343 #
344 #enable_window_title = "yes"
345 #
346 ##
347 ## Note: You can choose default search mode for search
348 ## engine. Available modes are:
349 ##
350 ## - 1 - use mpd built-in searching (no regexes, pattern matching)
351 ## - 2 - use ncmpcpp searching (pattern matching with support for regexes,
352 ## but if your mpd is on a remote machine, downloading big database
353 ## to process it can take a while
354 ## - 3 - match only exact values (this mode uses mpd function for searching
355 ## in database and local one for searching in current playlist)
356 ##
357 #
358 #search_engine_default_search_mode = "1"
359 #
360 ##
361 ## Note: These triggers will allow you to phisically remove
362 ## files and directories from your hdd using ncmpcpp's
363 ## browser screen.
364 ##
365 #
366 #allow_physical_files_deletion = "no"
367 #
368 #allow_physical_directories_deletion = "no"
369 #
370 ##### lyrics support #####
371 ##
372 ## supported lyrics databases:
373 ##
374 ## - 1 - lyricsplugin.com
375 ##
376 #
377 #lyrics_database = "1"
378 #
379 #external_editor = ""
380 #
381 #use_console_editor = "no" (set to yes, if your editor is console app)
382 #
383 ##### colors definitions #####
384 #
385 #colors_enabled = "yes"
386 #
387 #empty_tag_color = "cyan"
388 #
389 #header_window_color = "default"
390 #
391 #volume_color = "default"
392 #
393 #state_line_color = "default"
394 #
395 #state_flags_color = "default"
396 #
397 #main_window_color = "yellow"
398 #
399 #color1 = "white"
400 #
401 #color2 = "green"
402 #
403 #main_window_highlight_color = "yellow"
404 #
405 #progressbar_color = "default"
406 #
407 #statusbar_color = "default"
408 #
409 #alternative_ui_separator_color = "black"
410 #
411 #active_column_color = "red"
412 #
413 #window_border_color = "green"
414 #
415 #active_window_border = "red"
416 #