| 1 | ############################################################## |
| 2 | ## This is the example configuration file. Copy it to ## |
| 3 | ## $HOME/.ncmpcpp/config or $XDG_CONFIG_HOME/ncmpcpp/config ## |
| 4 | ## and set up your preferences. ## |
| 5 | ############################################################## |
| 6 | # |
| 7 | ##### directories ###### |
| 8 | ## |
| 9 | ## Directory for storing ncmpcpp related files. |
| 10 | ## Changing it is useful if you want to store |
| 11 | ## everything somewhere else and provide command |
| 12 | ## line setting for alternative location to config |
| 13 | ## file which defines that while launching ncmpcpp. |
| 14 | ## |
| 15 | # |
| 16 | ncmpcpp_directory = ~/.ncmpcpp |
| 17 | # |
| 18 | ## |
| 19 | ## Directory for storing downloaded lyrics. It |
| 20 | ## defaults to ~/.lyrics since other MPD clients |
| 21 | ## (eg. ncmpc) also use that location. |
| 22 | ## |
| 23 | # |
| 24 | #lyrics_directory = ~/.lyrics |
| 25 | # |
| 26 | ##### connection settings ##### |
| 27 | # |
| 28 | #mpd_host = localhost |
| 29 | # |
| 30 | #mpd_port = 6600 |
| 31 | # |
| 32 | #mpd_connection_timeout = 5 |
| 33 | # |
| 34 | ## Needed for tag editor and file operations to work. |
| 35 | ## |
| 36 | mpd_music_dir = ~/usr/music |
| 37 | # |
| 38 | #mpd_crossfade_time = 5 |
| 39 | # |
| 40 | ##### music visualizer ##### |
| 41 | ## |
| 42 | ## Note: In order to make music visualizer work you'll |
| 43 | ## need to use mpd fifo output, whose format parameter |
| 44 | ## has to be set to 44100:16:1 for mono visualization |
| 45 | ## or 44100:16:2 for stereo visualization. Example |
| 46 | ## configuration (it has to be put into mpd.conf): |
| 47 | ## |
| 48 | ## audio_output { |
| 49 | ## type "fifo" |
| 50 | ## name "Visualizer feed" |
| 51 | ## path "/tmp/mpd.fifo" |
| 52 | ## format "44100:16:2" |
| 53 | ## } |
| 54 | ## |
| 55 | # |
| 56 | visualizer_fifo_path = /tmp/mpd.fifo |
| 57 | # |
| 58 | ## |
| 59 | ## Note: Below parameter is needed for ncmpcpp |
| 60 | ## to determine which output provides data for |
| 61 | ## visualizer and thus allow syncing between |
| 62 | ## visualization and sound as currently there |
| 63 | ## are some problems with it. |
| 64 | ## |
| 65 | # |
| 66 | visualizer_output_name = my fifo |
| 67 | # |
| 68 | ## |
| 69 | ## If you set format to 44100:16:2, make it 'yes'. |
| 70 | ## |
| 71 | visualizer_in_stereo = yes |
| 72 | # |
| 73 | ## |
| 74 | ## Multiply received samples by given value. Very |
| 75 | ## useful for proper visualization of quiet music. |
| 76 | ## |
| 77 | #visualizer_sample_multiplier = 1 |
| 78 | # |
| 79 | ## |
| 80 | ## Note: Below parameter defines how often ncmpcpp |
| 81 | ## has to "synchronize" visualizer and audio outputs. |
| 82 | ## 30 seconds is optimal value, but if you experience |
| 83 | ## synchronization problems, set it to lower value. |
| 84 | ## Keep in mind that sane values start with >=10. |
| 85 | ## |
| 86 | # |
| 87 | visualizer_sync_interval = 30 |
| 88 | # |
| 89 | ## |
| 90 | ## Note: To enable spectrum frequency visualization |
| 91 | ## you need to compile ncmpcpp with fftw3 support. |
| 92 | ## |
| 93 | # |
| 94 | ## Available values: spectrum, wave, wave_filled, ellipse. |
| 95 | ## |
| 96 | visualizer_type = spectrum |
| 97 | # |
| 98 | #visualizer_look = ●▮ |
| 99 | visualizer_look = "●•" |
| 100 | # |
| 101 | #visualizer_color = blue, cyan, green, yellow, magenta, red |
| 102 | # |
| 103 | ## Alternative subset of 256 colors for terminals that support it. |
| 104 | ## |
| 105 | #visualizer_color = 41, 83, 119, 155, 185, 215, 209, 203, 197, 161 |
| 106 | # |
| 107 | ##### system encoding ##### |
| 108 | ## |
| 109 | ## ncmpcpp should detect your charset encoding |
| 110 | ## but if it failed to do so, you can specify |
| 111 | ## charset encoding you are using here. |
| 112 | ## |
| 113 | ## Note: You can see whether your ncmpcpp build |
| 114 | ## supports charset detection by checking output |
| 115 | ## of `ncmpcpp --version`. |
| 116 | ## |
| 117 | ## Note: Since MPD uses UTF-8 by default, setting |
| 118 | ## this option makes sense only if your encoding |
| 119 | ## is different. |
| 120 | ## |
| 121 | # |
| 122 | #system_encoding = "" |
| 123 | # |
| 124 | ##### delays ##### |
| 125 | # |
| 126 | ## Time of inactivity (in seconds) after playlist |
| 127 | ## highlighting will be disabled (0 = always on). |
| 128 | ## |
| 129 | #playlist_disable_highlight_delay = 5 |
| 130 | # |
| 131 | ## Defines how long messages are supposed to be visible. |
| 132 | ## |
| 133 | #message_delay_time = 5 |
| 134 | # |
| 135 | ##### song format ##### |
| 136 | ## |
| 137 | ## For a song format you can use: |
| 138 | ## |
| 139 | ## %l - length |
| 140 | ## %f - filename |
| 141 | ## %D - directory |
| 142 | ## %a - artist |
| 143 | ## %A - album artist |
| 144 | ## %t - title |
| 145 | ## %b - album |
| 146 | ## %y - date |
| 147 | ## %n - track number (01/12 -> 01) |
| 148 | ## %N - full track info (01/12 -> 01/12) |
| 149 | ## %g - genre |
| 150 | ## %c - composer |
| 151 | ## %p - performer |
| 152 | ## %d - disc |
| 153 | ## %C - comment |
| 154 | ## %P - priority |
| 155 | ## $R - begin right alignment |
| 156 | ## |
| 157 | ## If you want to make sure that a part of the format is displayed |
| 158 | ## only when certain tags are present, you can archieve it by |
| 159 | ## grouping them with brackets, e.g. '{%a - %t}' will be evaluated |
| 160 | ## to 'ARTIST - TITLE' if both tags are present or '' otherwise. |
| 161 | ## It is also possible to define a list of alternatives by providing |
| 162 | ## several groups and separating them with '|', e.g. '{%t}|{%f}' |
| 163 | ## will be evaluated to 'TITLE' or 'FILENAME' if the former is not |
| 164 | ## present. |
| 165 | ## |
| 166 | ## Note: If you want to set limit on maximal length of a tag, just |
| 167 | ## put the appropriate number between % and character that defines |
| 168 | ## tag type, e.g. to make album take max. 20 terminal cells, use '%20b'. |
| 169 | ## |
| 170 | ## In addition, formats support markers used for text attributes. |
| 171 | ## They are followed by character '$'. After that you can put: |
| 172 | ## |
| 173 | ## - 0 - default window color (discards all other colors) |
| 174 | ## - 1 - black |
| 175 | ## - 2 - red |
| 176 | ## - 3 - green |
| 177 | ## - 4 - yellow |
| 178 | ## - 5 - blue |
| 179 | ## - 6 - magenta |
| 180 | ## - 7 - cyan |
| 181 | ## - 8 - white |
| 182 | ## - 9 - end of current color |
| 183 | ## - b - bold text |
| 184 | ## - u - underline text |
| 185 | ## - r - reverse colors |
| 186 | ## - a - use alternative character set |
| 187 | ## |
| 188 | ## If you don't want to use a non-color attribute anymore, just put it |
| 189 | ## again, but this time insert character '/' between '$' and attribute |
| 190 | ## character, e.g. {$b%t$/b}|{$r%f$/r} will display bolded title tag |
| 191 | ## or filename with reversed colors. |
| 192 | ## |
| 193 | ## If you want to use 256 colors and/or background colors in formats |
| 194 | ## (the naming scheme is described below in section about color |
| 195 | ## definitions), it can be done with the syntax $(COLOR), e.g. to set |
| 196 | ## the artist tag to one of the non-standard colors and make it have |
| 197 | ## yellow background, you need to write $(197_yellow)%a$(end). Note |
| 198 | ## that for standard colors this is interchangable with attributes |
| 199 | ## listed above. |
| 200 | ## |
| 201 | ## Note: colors can be nested. |
| 202 | ## |
| 203 | # |
| 204 | #song_list_format = {%a - }{%t}|{$8%f$9}$R{$3(%l)$9} |
| 205 | # |
| 206 | #song_status_format = {{%a{ "%b"{ (%y)}} - }{%t}}|{%f} |
| 207 | # |
| 208 | #song_library_format = {%n - }{%t}|{%f} |
| 209 | # |
| 210 | # |
| 211 | #alternative_header_first_line_format = $b$1$aqqu$/a$9 {%t}|{%f} $1$atqq$/a$9$/b |
| 212 | # |
| 213 | #alternative_header_second_line_format = {{$4$b%a$/b$9}{ - $7%b$9}{ ($4%y$9)}}|{%D} |
| 214 | # |
| 215 | #now_playing_prefix = $b |
| 216 | # |
| 217 | #now_playing_suffix = $/b |
| 218 | # |
| 219 | #browser_playlist_prefix = "$2playlist$9 " |
| 220 | # |
| 221 | #selected_item_prefix = $6 |
| 222 | # |
| 223 | #selected_item_suffix = $9 |
| 224 | # |
| 225 | #modified_item_prefix = $3> $9 |
| 226 | # |
| 227 | ## |
| 228 | ## Note: attributes are not supported for the following variables. |
| 229 | ## |
| 230 | #song_window_title_format = {%a - }{%t}|{%f} |
| 231 | ## |
| 232 | ## Note: Below variables are used for sorting songs in browser. |
| 233 | ## The sort mode determines how songs are sorted, and can be used |
| 234 | ## in combination with a sort format to specify a custom sorting format. |
| 235 | ## Available values for browser_sort_mode are "name", "mtime", "format" |
| 236 | ## and "noop". |
| 237 | ## |
| 238 | # |
| 239 | #browser_sort_mode = name |
| 240 | # |
| 241 | #browser_sort_format = {%a - }{%t}|{%f} {(%l)} |
| 242 | # |
| 243 | ##### columns settings ##### |
| 244 | ## |
| 245 | ## syntax of song columns list format is "column column etc." |
| 246 | ## |
| 247 | ## - syntax for each column is: |
| 248 | ## |
| 249 | ## (width of the column)[color of the column]{displayed tag} |
| 250 | ## |
| 251 | ## Note: Width is by default in %, if you want a column to |
| 252 | ## have fixed size, add 'f' after the value, e.g. (10)[white]{a} |
| 253 | ## will be the column that take 10% of screen (so the real width |
| 254 | ## will depend on actual screen size), whereas (10f)[white]{a} |
| 255 | ## will take 10 terminal cells, no matter how wide the screen is. |
| 256 | ## |
| 257 | ## - color is optional (if you want the default one, |
| 258 | ## leave the field empty). |
| 259 | ## |
| 260 | ## Note: You can give a column additional attributes by putting appropriate |
| 261 | ## character after displayed tag character. Available attributes are: |
| 262 | ## |
| 263 | ## - r - column will be right aligned |
| 264 | ## - E - if tag is empty, empty tag marker won't be displayed |
| 265 | ## |
| 266 | ## You can also: |
| 267 | ## |
| 268 | ## - give a column custom name by putting it after attributes, |
| 269 | ## separated with character ':', e.g. {lr:Length} gives you |
| 270 | ## right aligned column of lengths named "Length". |
| 271 | ## |
| 272 | ## - define sequence of tags, that have to be displayed in case |
| 273 | ## predecessor is empty in a way similar to the one in classic |
| 274 | ## song format, i.e. using '|' character, e.g. {a|c|p:Owner} |
| 275 | ## creates column named "Owner" that tries to display artist |
| 276 | ## tag and then composer and performer if previous ones are |
| 277 | ## not available. |
| 278 | ## |
| 279 | # |
| 280 | #song_columns_list_format = (20)[]{a} (6f)[green]{NE} (50)[white]{t|f:Title} (20)[cyan]{b} (7f)[magenta]{l} |
| 281 | # |
| 282 | ##### various settings ##### |
| 283 | # |
| 284 | ## |
| 285 | ## Note: Custom command that will be executed each |
| 286 | ## time song changes. Useful for notifications etc. |
| 287 | ## |
| 288 | #execute_on_song_change = "" |
| 289 | # |
| 290 | #playlist_show_mpd_host = no |
| 291 | # |
| 292 | #playlist_show_remaining_time = no |
| 293 | # |
| 294 | #playlist_shorten_total_times = no |
| 295 | # |
| 296 | #playlist_separate_albums = no |
| 297 | # |
| 298 | ## |
| 299 | ## Note: Possible display modes: classic, columns. |
| 300 | ## |
| 301 | #playlist_display_mode = columns |
| 302 | # |
| 303 | #browser_display_mode = classic |
| 304 | # |
| 305 | #search_engine_display_mode = classic |
| 306 | # |
| 307 | #playlist_editor_display_mode = classic |
| 308 | # |
| 309 | #discard_colors_if_item_is_selected = yes |
| 310 | # |
| 311 | #incremental_seeking = yes |
| 312 | # |
| 313 | #seek_time = 1 |
| 314 | # |
| 315 | #volume_change_step = 2 |
| 316 | # |
| 317 | #autocenter_mode = no |
| 318 | # |
| 319 | #centered_cursor = no |
| 320 | # |
| 321 | ## |
| 322 | ## Note: You can specify third character which will |
| 323 | ## be used to build 'empty' part of progressbar. |
| 324 | ## |
| 325 | #progressbar_look = => |
| 326 | progressbar_look = "─╼╶" |
| 327 | #progressbar_look = "─⊙╶" |
| 328 | # |
| 329 | #progressbar_boldness = yes |
| 330 | # |
| 331 | ## Available values: database, playlist. |
| 332 | ## |
| 333 | #default_place_to_search_in = database |
| 334 | # |
| 335 | ## Available values: classic, alternative. |
| 336 | ## |
| 337 | #user_interface = classic |
| 338 | # |
| 339 | #data_fetching_delay = yes |
| 340 | # |
| 341 | ## Available values: artist, album_artist, date, genre, composer, performer. |
| 342 | ## |
| 343 | #media_library_primary_tag = artist |
| 344 | # |
| 345 | ## Available values: wrapped, normal. |
| 346 | ## |
| 347 | #default_find_mode = wrapped |
| 348 | # |
| 349 | #default_tag_editor_pattern = %n - %t |
| 350 | # |
| 351 | #header_visibility = yes |
| 352 | # |
| 353 | #statusbar_visibility = yes |
| 354 | # |
| 355 | #titles_visibility = yes |
| 356 | # |
| 357 | #header_text_scrolling = yes |
| 358 | # |
| 359 | #cyclic_scrolling = no |
| 360 | # |
| 361 | #lines_scrolled = 2 |
| 362 | # |
| 363 | #follow_now_playing_lyrics = no |
| 364 | # |
| 365 | #fetch_lyrics_for_current_song_in_background = no |
| 366 | # |
| 367 | #store_lyrics_in_song_dir = no |
| 368 | # |
| 369 | #generate_win32_compatible_filenames = yes |
| 370 | # |
| 371 | #allow_for_physical_item_deletion = no |
| 372 | # |
| 373 | ## |
| 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. |
| 378 | ## |
| 379 | ## Note: Language has to be expressed as an ISO 639 alpha-2 code. |
| 380 | ## |
| 381 | #lastfm_preferred_language = en |
| 382 | # |
| 383 | #show_hidden_files_in_local_browser = no |
| 384 | # |
| 385 | ## |
| 386 | ## How shall screen switcher work? |
| 387 | ## |
| 388 | ## - "previous" - switch between the current and previous screen. |
| 389 | ## - "screen1,...,screenN" - switch between given sequence of screens. |
| 390 | ## |
| 391 | ## Screens available for use: help, playlist, browser, search_engine, |
| 392 | ## media_library, playlist_editor, tag_editor, outputs, visualizer, clock. |
| 393 | ## |
| 394 | #screen_switcher_mode = playlist, browser |
| 395 | # |
| 396 | ## |
| 397 | ## Note: You can define startup screen |
| 398 | ## by choosing screen from the list above. |
| 399 | ## |
| 400 | #startup_screen = playlist |
| 401 | # |
| 402 | ## |
| 403 | ## Note: You can define startup slave screen |
| 404 | ## by choosing screen from the list above or |
| 405 | ## an empty value for no slave screen. |
| 406 | ## |
| 407 | #startup_slave_screen = "" |
| 408 | # |
| 409 | #startup_slave_screen_focus = no |
| 410 | # |
| 411 | ## |
| 412 | ## Default width of locked screen (in %). |
| 413 | ## Acceptable values are from 20 to 80. |
| 414 | ## |
| 415 | # |
| 416 | #locked_screen_width_part = 50 |
| 417 | # |
| 418 | #ask_for_locked_screen_width_part = yes |
| 419 | # |
| 420 | #jump_to_now_playing_song_at_start = yes |
| 421 | # |
| 422 | #ask_before_clearing_playlists = yes |
| 423 | # |
| 424 | #clock_display_seconds = no |
| 425 | # |
| 426 | #display_volume_level = yes |
| 427 | # |
| 428 | #display_bitrate = no |
| 429 | # |
| 430 | #display_remaining_time = no |
| 431 | # |
| 432 | ## Available values: none, basic, extended, perl. |
| 433 | ## |
| 434 | #regular_expressions = perl |
| 435 | # |
| 436 | ## |
| 437 | ## Note: If below is enabled, ncmpcpp will ignore leading |
| 438 | ## "The" word while sorting items in browser, tags in |
| 439 | ## media library, etc. |
| 440 | ## |
| 441 | #ignore_leading_the = no |
| 442 | # |
| 443 | #block_search_constraints_change_if_items_found = yes |
| 444 | # |
| 445 | #mouse_support = yes |
| 446 | # |
| 447 | #mouse_list_scroll_whole_page = yes |
| 448 | # |
| 449 | #empty_tag_marker = <empty> |
| 450 | # |
| 451 | #tags_separator = " | " |
| 452 | # |
| 453 | #tag_editor_extended_numeration = no |
| 454 | # |
| 455 | #media_library_sort_by_mtime = no |
| 456 | # |
| 457 | #enable_window_title = yes |
| 458 | # |
| 459 | ## |
| 460 | ## Note: You can choose default search mode for search |
| 461 | ## engine. Available modes are: |
| 462 | ## |
| 463 | ## - 1 - use mpd built-in searching (no regexes, pattern matching) |
| 464 | ## - 2 - use ncmpcpp searching (pattern matching with support for regexes, |
| 465 | ## but if your mpd is on a remote machine, downloading big database |
| 466 | ## to process it can take a while |
| 467 | ## - 3 - match only exact values (this mode uses mpd function for searching |
| 468 | ## in database and local one for searching in current playlist) |
| 469 | ## |
| 470 | # |
| 471 | #search_engine_default_search_mode = 1 |
| 472 | # |
| 473 | #external_editor = nano |
| 474 | # |
| 475 | ## Note: set to yes if external editor is a console application. |
| 476 | ## |
| 477 | #use_console_editor = yes |
| 478 | # |
| 479 | ##### colors definitions ##### |
| 480 | ## |
| 481 | ## It is possible to set a background color by setting a color |
| 482 | ## value "<foreground>_<background>", e.g. red_black will set |
| 483 | ## foregound color to red and background color to black. |
| 484 | ## |
| 485 | ## In addition, for terminals that support 256 colors it |
| 486 | ## is possible to set one of them by using a number in range |
| 487 | ## [1, 256] instead of color name, e.g. numerical value |
| 488 | ## corresponding to red_black is 2_1. To find out if the |
| 489 | ## terminal supports 256 colors, run ncmpcpp and check out |
| 490 | ## the bottom of the help screen for list of available colors |
| 491 | ## and their numerical values. |
| 492 | ## |
| 493 | ## Note: due to technical limitations of ncurses, if 256 colors |
| 494 | ## are used, it is possible to either use only the colors with |
| 495 | ## default background color, or all pairs from 1_1 up to 254_127, |
| 496 | ## depending on the ncurses version used. |
| 497 | ## |
| 498 | # |
| 499 | #colors_enabled = yes |
| 500 | # |
| 501 | #empty_tag_color = cyan |
| 502 | # |
| 503 | #header_window_color = default |
| 504 | # |
| 505 | #volume_color = default |
| 506 | # |
| 507 | #state_line_color = default |
| 508 | # |
| 509 | #state_flags_color = default |
| 510 | # |
| 511 | #main_window_color = yellow |
| 512 | # |
| 513 | #color1 = white |
| 514 | # |
| 515 | #color2 = green |
| 516 | # |
| 517 | #main_window_highlight_color = yellow |
| 518 | # |
| 519 | #progressbar_color = black |
| 520 | # |
| 521 | #progressbar_elapsed_color = green |
| 522 | # |
| 523 | #statusbar_color = default |
| 524 | # |
| 525 | #alternative_ui_separator_color = black |
| 526 | # |
| 527 | #active_column_color = red |
| 528 | # |
| 529 | #window_border_color = green |
| 530 | # |
| 531 | #active_window_border = red |
| 532 | # |