Configuration

Configuration

A configuration file is located at ${HOME}/.config/spotatui/config.yml.

Note: This is not to be confused with client.yml which handles Spotify authentication.

Sample Configuration

# The theme colours can be an rgb string of the form "255, 255, 255" or a 
# string that references the colours from your terminal theme: Reset, Black, 
# Red, Green, Yellow, Blue, Magenta, Cyan, Gray, DarkGray, LightRed, 
# LightGreen, LightYellow, LightBlue, LightMagenta, LightCyan, White.
theme:
  active: Cyan # current playing song in list
  banner: LightCyan # the "spotatui" banner on launch
  error_border: Red # error dialog border
  error_text: LightRed # error message text
  hint: Yellow # hint text in errors
  hovered: Magenta # hovered pane border
  inactive: Gray # borders of inactive panes
  playbar_background: Black # background of progress bar
  playbar_progress: LightCyan # filled-in part of the progress bar
  playbar_progress_text: Cyan # song length and time indicator
  playbar_text: White # artist name in player pane
  selected: LightCyan # selected pane border, hovered item, track title
  text: "255, 255, 255" # text in panes
  header: White # header text in panes

behavior:
  seek_milliseconds: 5000
  volume_increment: 10
  # Lower = higher FPS for audio visualization (but more expensive)
  tick_rate_milliseconds: 250
  enable_text_emphasis: true
  show_loading_indicator: true
  enforce_wide_search_bar: false
  enable_global_song_count: true
  # Icons (require a patched nerd font)
  liked_icon: ♥
  shuffle_icon: 🔀
  repeat_track_icon: 🔂
  repeat_context_icon: 🔁
  playing_icon: ▶
  paused_icon: ⏸
  set_window_title: true

keybindings:
  back: "ctrl-q"
  jump_to_album: "a"
  jump_to_artist_album: "A"
  manage_devices: "d"
  decrease_volume: "-"
  increase_volume: "+"
  toggle_playback: " "
  seek_backwards: "<"
  seek_forwards: ">"
  next_track: "n"
  previous_track: "p"
  copy_song_url: "c"
  copy_album_url: "C"
  help: "?"
  shuffle: "ctrl-s"
  repeat: "r"
  search: "/"
  audio_analysis: "v"
  jump_to_context: "o"
  lyrics_view: "B"
  add_item_to_queue: "z"

In-App Settings

Press Alt-, to open the Settings screen where you can customize spotatui without editing config files.

Settings Categories

Category	Description
Behavior	Seek duration, volume increment, tick rate, icons, toggles
Keybindings	View current keybindings (customization coming soon)
Theme	Color presets and individual color customization