Theme

A theme determines the look of rmpc. You can customize it by creating a custom theme file placed in the themes directory and then configuring the theme property in the config file filename of the theme.

Bootstrapping a theme file

1. Config file can be bootstrapped by running the following command:

   rmpc theme > ~/.config/rmpc/themes/<theme_name>.ron

2. Use the theme in your config by editing the theme property ~/.config/rmpc/config.ron file like so:

   theme: Some("<theme_name>")

3. Restart rmpc

Theme file structure

Below is a list of properties that can be changed.

layout

layout: Pane | Split | Component

Base layout of the application, lets you configure where the various components are placed on the screen.

layout Configuration of rmpc's base layout

components

components: Map<string, Pane | Split | Component>

Reusable components which can be used in tabs, layout or other components. Check out components section in the layout page for more information.

default_album_art_path

default_album_art_path: None | Some("<string>")

A default image is displayed if a song does not have an album art. This property can override that default image.

cava

cava: <Cava>

Configures how the Cava music visualizer is displayed. More info on the cava page.

show_song_table_header

show_song_table_header: true | false

If set to false, the header of the song table is not displayed. Default is true.

draw_borders

draw_borders: true | false

Whether to draw borders in the UI.

symbols

Symbols to use in the various browser panes (artist, search, …)

symbols: <Symbols>

symbols.song

song: S

symbols.dir

dir: D

symbols.marker

marker: M

This symbol is used for selected items in the browser panes.

symbols.ellipsis

ellipsis: ...

Symbol used to indicate text truncation when content exceeds the available display space.

symbols.song_style

song_style: <style>

Style to use for the song symbol.

symbols.dir_style

dir_style: <style>

Style to use for the dir symbol.

level_styles

Configures style of various messages depending on their level, ie. info or error.

level_styles: LevelStyles

Defaults to:

level_styles: (
    info: (fg: "blue", bg: "black"),
    warn: (fg: "yellow", bg: "black"),
    error: (fg: "red", bg: "black"),
    debug: (fg: "light_green", bg: "black"),
    trace: (fg: "magenta", bg: "black"),
),

progress_bar

Progress bar at the bottom of the window.

progress_bar: ProgressBar

progress_bar.symbols

symbols: [start, elapsed, thumb, track, end]

Array of five single character strings that determine the look of the progress bar. First value is the start character, second is the elapsed part of the progress bar, third is the thumb, fourth is the empty track and the fifth is the end character. Default is `[”[”, ”-”, ”>”, ” ”, ”]“]

progress_bar.track_style

track_style: <style>

Style of the empty track part of the progress bar.

progress_bar.elapsed_style

elapsed_style: <style>

Style of the elapsed part of the progress bar.

progress_bar.thumb_style

thumb_style: <style>

Style of the progress bar thumb.

scrollbar

scrollbar: Scrollbar

Configure the style of scrollbars in rmpc. Passing in None hides them.

scrollbar.symbols

track_style: [track, thumb, end_top, end_bot]

Array of four single character strings that determine the look of the scrollbars. First value is the track, second is the thumb, third is the top end and the fourth is the bottom end. Default is ["│", "█", "▲", "▼"]

scrollbar.track_style

track_style: <style>

scrollbar.ends_style

ends_style: <style>

scrollbar.thumb_style

thumb_style: <style>

browser_column_widths

browser_column_widths: [number, number, number]

Three numerical values that determine the percent width of the columns in the browser tab. Default is [20, 38, 42]. Meaning the first column takes 20% of the width, the second 38% and the third 42%.

background_color

background_color: color

Background color of the main window.

header_background_color

background_color: color

Background color of the window header. The header is at the top of the window and contains tab bar and user configurable data.

modal_background_color

background_color: color

Background color of modal dialogs.

modal_backdrop

modal_backdrop: true | false

Enables a backdrop behind modals for increased visual clarity. Defaults to false.

text_color

text_color: color

Foreground color of basic text. Defaults to your terminal’s foreground color.

preview_label_style

preview_label_style: <style>

Style of song metadata labels in browser previews.

preview_metadata_group_style

preview_metadata_group_style: <style>

Style of song metadata group headers in browser previews.

tab_bar

Tab bar at the top of the window below header. Shows what tab is currently active.

tab_bar.enabled

Do not use. Deprecated in favor of the layout config.

tab_bar.active_style

active_style: <style>

Style for the active tab.

tab_bar.inactive_style

inactive_style: <style>

Style for all tabs except the active one.

highlighted_item_style

highlighted_item_style: <style>

current_item_style

current_item_style: <style>

borders_style

borders_style: <style>

highlight_border_style

highlight_border_style: <style>

format_tag_separator

format_tag_separator: "<string>"

Use this to separate entries when a song has multiple values for a tag. For example, a song with two values for artist and | as a separator will show artist1 | artist2. Default is |.

multiple_tag_resolution_strategy

multiple_tag_resolution_strategy: All | First | Last | Nth(<number>)

What strategy to choose when a song has multiple values for a tag. All uses #format_tag_separator to join all values to one. First and Last choose the first and last value respectively and Nth chooses exactly which one to take. Last value is used when index given to Nth is larger than the count of available values.

song_table_format

song_table_format: <song_table_format>

Configures the columns of the song table. This property is described in its own page:

song_table_format Configuration of the table of songs on the queue page

browser_song_format

browser_song_format: <song_table_format>

Format used to display song in the various browser panes (albums, artists, …). Is the same format as song_table_format except the styles are ignored.

Defaults to Track Artist - Title

header

header: <header[]>

Configuration of the header. Header is displayed at the top of the window. It can display info about current song, the player state and custom widgets. This property is described in its own page:

header Configuration of the window header

lyrics

lyrics.timestamp

lyrics.timestamp: true | false

Sets the visibility of the timestamps in the lyrics pane.