1 ####################################################
2 ## this is example configuration file, copy it to ##
3 ## ~/.ncmpcpp/config and set up your preferences ##
4 ####################################################
6 ##### directories ######
8 ## Directory for storing ncmpcpp related files.
9 ## Changing it is useful if you want to store
10 ## everything somewhere else and provide command
11 ## line setting for alternative location to config
12 ## file which defines that while launching ncmpcpp.
15 #ncmpcpp_directory = ~/.ncmpcpp
18 ## Directory for storing downloaded lyrics. It
19 ## defaults to ~/.lyrics since other MPD clients
20 ## (eg. ncmpc) also use that location.
23 #lyrics_directory = ~/.lyrics
25 ##### connection settings #####
31 #mpd_connection_timeout = 5
33 ## Needed for tag editor and file operations to work.
35 #mpd_music_dir = ~/music
37 #mpd_crossfade_time = 5
39 ##### music visualizer #####
41 ## Note: In order to make music visualizer work you'll
42 ## need to use mpd fifo output, whose format parameter
43 ## has to be set to 44100:16:1 for mono visualization
44 ## or 44100:16:2 for stereo visualization. Example
45 ## configuration (it has to be put into mpd.conf):
49 ## name "Visualizer feed"
50 ## path "/tmp/mpd.fifo"
51 ## format "44100:16:2"
55 #visualizer_fifo_path = /tmp/mpd.fifo
58 ## Note: Below parameter is needed for ncmpcpp
59 ## to determine which output provides data for
60 ## visualizer and thus allow syncing between
61 ## visualization and sound as currently there
62 ## are some problems with it.
65 #visualizer_output_name = Visualizer feed
68 ## If you set format to 44100:16:2, make it 'yes'.
70 #visualizer_in_stereo = yes
73 ## Multiply received samples by given value. Very
74 ## useful for proper visualization of quiet music.
76 #visualizer_sample_multipler = 1
79 ## Note: Below parameter defines how often ncmpcpp
80 ## has to "synchronize" visualizer and audio outputs.
81 ## 30 seconds is optimal value, but if you experience
82 ## synchronization problems, set it to lower value.
83 ## Keep in mind that sane values start with >=10.
86 #visualizer_sync_interval = 30
89 ## Note: To enable spectrum frequency visualization
90 ## you need to compile ncmpcpp with fftw3 support.
93 ## Available values: spectrum, wave.
95 #visualizer_type = wave
99 ##### system encoding #####
101 ## ncmpcpp should detect your charset encoding
102 ## but if it failed to do so, you can specify
103 ## charset encoding you are using here.
105 ## Note: You can see whether your ncmpcpp build
106 ## supports charset detection by checking output
107 ## of `ncmpcpp --version`.
109 ## Note: Since MPD uses UTF-8 by default, setting
110 ## this option makes sense only if your encoding
114 #system_encoding = ""
118 ## Time of inactivity (in seconds) after playlist
119 ## highlighting will be disabled (0 = always on).
121 #playlist_disable_highlight_delay = 5
123 ## Defines how long messages are supposed to be visible.
125 #message_delay_time = 5
127 ##### song format #####
129 ## for song format you can use:
139 ## %n - track number (01/12 -> 01)
140 ## %N - full track info (01/12 -> 01/12)
147 ## $R - begin right alignment
149 ## you can also put them in { } and then it will be displayed
150 ## only if all requested values are available and/or define alternate
151 ## value with { }|{ } eg. {%a - %t}|{%f}
153 ## Note: If you want to set limit on maximal length of a tag, just
154 ## put the appropriate number between % and character that defines
155 ## tag type, e.g. to make album take max. 20 terminal cells, use '%20b'.
157 ## Note: Format that is similar to "%a - %t" (i.e. without any additional
158 ## braces) is equal to "{%a - %t}", so if one of the tags is missing,
159 ## you'll get nothing.
161 ## text can also have different color than the main window has,
162 ## eg. if you want length to be green, write "$3%l$9".
166 ## - 0 - default window color (discards all other colors)
175 ## - 9 - end of current color
177 ## Note: colors can be nested.
180 #song_list_format = {%a - }{%t}|{$8%f$9}$R{$3(%l)$9}
182 #song_status_format = {{%a{ "%b"{ (%y)}} - }{%t}}|{%f}
184 #song_library_format = {%n - }{%t}|{%f}
186 #tag_editor_album_format = {(%y) }%b
189 ## Note: Below variables are used for sorting songs in browser.
190 ## The sort mode determines how songs are sorted, and can be used
191 ## in combination with a sort format to specify a custom sorting format.
192 ## Available values for browser_sort_mode are "name", "mtime", "format"
196 #browser_sort_mode = name
198 #browser_sort_format = {%a - }{%t}|{%f} {(%l)}
201 ## Note: Below variables are for alternative version of user's interface.
202 ## Their syntax supports all tags and colors listed above plus some extra
203 ## markers used for text attributes. They are followed by character '$'.
204 ## After that you can put:
207 ## - u - underline text
208 ## - r - reverse colors
209 ## - a - use alternative character set
211 ## If you don't want to use an attribute anymore, just put it again, but
212 ## this time insert character '/' between '$' and attribute character,
213 ## e.g. {$b%t$/b}|{$r%f$/r} will display bolded title tag or filename
214 ## with reversed colors.
217 #alternative_header_first_line_format = $b$1$aqqu$/a$9 {%t}|{%f} $1$atqq$/a$9$/b
219 #alternative_header_second_line_format = {{$4$b%a$/b$9}{ - $7%b$9}{ ($4%y$9)}}|{%D}
222 ## Note: below variables also support text attributes listed above.
225 #now_playing_prefix = $b
227 #now_playing_suffix = $/b
229 #browser_playlist_prefix = "$2playlist$9 "
231 #selected_item_prefix = $6
233 #selected_item_suffix = $9
235 #modified_item_prefix = $3> $9
237 ## Note: colors are not supported for below variable.
239 #song_window_title_format = {%a - }{%t}|{%f}
241 ##### columns settings #####
243 ## syntax of song columns list format is "column column etc."
245 ## - syntax for each column is:
247 ## (width of column)[column's color]{displayed tag}
249 ## Note: Width is by default in %, if you want a column to
250 ## have fixed size, add 'f' after the value, e.g. (10)[white]{a}
251 ## will be the column that take 10% of screen (so the real column's
252 ## width will depend on actual screen size), whereas (10f)[white]{a}
253 ## will take 10 terminal cells, no matter how wide the screen is.
255 ## - color is optional (if you want the default one, type [])
257 ## Note: You can give a column additional attributes by putting appropriate
258 ## character after displayed tag character. Available attributes are:
260 ## - r - column will be right aligned
261 ## - E - if tag is empty, empty tag marker won't be displayed
265 ## - give a column custom name by putting it after attributes,
266 ## separated with character ':', e.g. {lr:Length} gives you
267 ## right aligned column of lengths named "Length".
269 ## - define sequence of tags, that have to be displayed in case
270 ## predecessor is empty in a way similar to the one in classic
271 ## song format, i.e. using '|' character, e.g. {a|c|p:Owner}
272 ## creates column named "Owner" that tries to display artist
273 ## tag and then composer and performer if previous ones are
277 #song_columns_list_format = (20)[]{a} (6f)[green]{NE} (50)[white]{t|f:Title} (20)[cyan]{b} (7f)[magenta]{l}
279 ##### various settings #####
282 ## Note: Custom command that will be executed each
283 ## time song changes. Useful for notifications etc.
285 ## Attention: It doesn't support song format anymore.
286 ## Use `ncmpcpp --now-playing SONG_FORMAT` instead.
288 #execute_on_song_change = ""
290 #playlist_show_remaining_time = no
292 #playlist_shorten_total_times = no
294 #playlist_separate_albums = no
297 ## Note: Possible display modes: classic, columns.
299 #playlist_display_mode = columns
301 #browser_display_mode = classic
303 #search_engine_display_mode = classic
305 #playlist_editor_display_mode = classic
307 #discard_colors_if_item_is_selected = yes
309 #incremental_seeking = yes
313 #volume_change_step = 2
315 #autocenter_mode = no
317 #centered_cursor = no
320 ## Note: You can specify third character which will
321 ## be used to build 'empty' part of progressbar.
323 #progressbar_look = =>
325 #progressbar_boldness = yes
327 ## Available values: database, playlist.
329 #default_place_to_search_in = database
331 ## Available values: classic, alternative.
333 #user_interface = classic
335 #data_fetching_delay = yes
337 ## Available values: artist, album_artist, date, genre, composer, performer.
339 #media_library_primary_tag = artist
341 ## Available values: wrapped, normal.
343 #default_find_mode = wrapped
345 ## Available values: add, select.
347 #default_space_mode = add
349 #default_tag_editor_pattern = %n - %t
351 #header_visibility = yes
353 #statusbar_visibility = yes
355 #titles_visibility = yes
357 #header_text_scrolling = yes
359 #cyclic_scrolling = no
363 #follow_now_playing_lyrics = no
365 #fetch_lyrics_for_current_song_in_background = no
367 #store_lyrics_in_song_dir = no
369 #generate_win32_compatible_filenames = yes
371 #allow_for_physical_item_deletion = no
374 ## Note: If you set this variable, ncmpcpp will try to
375 ## get info from last.fm in language you set and if it
376 ## fails, it will fall back to english. Otherwise it will
377 ## use english the first time.
379 ## Note: Language has to be expressed as an ISO 639 alpha-2 code.
381 #lastfm_preferred_language = en
383 ## Available values: add_remove, always_add.
385 #space_add_mode = always_add
387 #show_hidden_files_in_local_browser = no
390 ## How shall screen switcher work?
392 ## - "previous" - switch between the current and previous screen.
393 ## - "screen1,...,screenN" - switch between given sequence of screens.
395 ## Screens available for use: help, playlist, browser, search_engine,
396 ## media_library, playlist_editor, tag_editor, outputs, visualizer, clock.
398 #screen_switcher_mode = playlist, browser
401 ## Note: You can define startup screen for ncmpcpp
402 ## by choosing screen from the list above.
404 #startup_screen = playlist
407 ## Default width of locked screen (in %).
408 ## Acceptable values are from 20 to 80.
411 #locked_screen_width_part = 50
413 #ask_for_locked_screen_width_part = yes
415 #jump_to_now_playing_song_at_start = yes
417 #ask_before_clearing_playlists = yes
419 #clock_display_seconds = no
421 #display_volume_level = yes
423 #display_bitrate = no
425 #display_remaining_time = no
427 ## Available values: none, basic, extended.
429 #regular_expressions = none
432 ## Note: If below is enabled, ncmpcpp will ignore leading
433 ## "The" word while sorting items in browser, tags in
434 ## media library, etc.
436 #ignore_leading_the = no
438 #block_search_constraints_change_if_items_found = yes
442 #mouse_list_scroll_whole_page = yes
444 #empty_tag_marker = <empty>
446 #tags_separator = " | "
448 #tag_editor_extended_numeration = no
450 #media_library_sort_by_mtime = no
452 #enable_window_title = yes
455 ## Note: You can choose default search mode for search
456 ## engine. Available modes are:
458 ## - 1 - use mpd built-in searching (no regexes, pattern matching)
459 ## - 2 - use ncmpcpp searching (pattern matching with support for regexes,
460 ## but if your mpd is on a remote machine, downloading big database
461 ## to process it can take a while
462 ## - 3 - match only exact values (this mode uses mpd function for searching
463 ## in database and local one for searching in current playlist)
466 #search_engine_default_search_mode = 1
468 #external_editor = nano
470 ## Note: set to yes if external editor is a console application.
472 #use_console_editor = yes
474 ##### colors definitions #####
476 #colors_enabled = yes
478 #empty_tag_color = cyan
480 #header_window_color = default
482 #volume_color = default
484 #state_line_color = default
486 #state_flags_color = default
488 #main_window_color = yellow
494 #main_window_highlight_color = yellow
496 #progressbar_color = black
498 #progressbar_elapsed_color = green
500 #statusbar_color = default
502 #alternative_ui_separator_color = black
504 #active_column_color = red
506 #visualizer_color = yellow
508 #window_border_color = green
510 #active_window_border = red