Migration guide

[vdbe]

v1 -> v2

Option Changes

Changes were made so the option names are more intuitive and more closely follow
the tmux naming conventions.

• @catppuccin_window_current_background -> @catppuccin_window_current_number_color
• @catppuccin_window_current_color -> @catppuccin_window_current_text_color
• @catppuccin_window_default_background -> @catppuccin_window_number_color
• @catppuccin_window_default_color -> @catppuccin_window_text_color
• @catppuccin_window_default_text -> @catppuccin_window_text
• @catppuccin_window_status -> @catppuccin_window_flags
• @catppuccin_window_default_fill -> removed, use number & text colors
• @catppuccin_window_current_fill -> removed, use number & text colors
• @catppuccin_status_fill -> removed, see status module styling

Status module styling

There are four colors involved:

• Icon
  • fg: @catppuccin_status_[module]_icon_fg [default = crust]
  • bg: @catppuccin_status_[module]_icon_bg [default = @catppuccin_[module]_color]
• Text
  • fg: @catppuccin_status_[module]_text_fg [default = foreground]
  • bg: @catppuccin_status_[module]_text_bg [default = @catppuccin_status_module_text_bg]

v0.3.0 -> v0.4.0

This is a breaking change, and you will likely need to adjust your config file. It is recommended to pin to version v0.3.0 if you do not want to upgrade. These changes were made to ensure the continued health and maintainability of the plugin.

• Custom status line modules will break and will need to be rewritten.
• @catppuccin_status_modules_{left,right} have been removed.
  • Instead, use the following syntax to add modules: set -g status-right "#{E:@catppuccin_status_<module>}". See the readme for more details.
• The theme colors use tmux options rather than environment variables, so instead of $thm_green, you need to use #{@thm_green}.
• Theme colors now match the catppuccin palette, see https://catppuccin.com/palette for a full list.
  • Overlay, subtext, and surface colors are available as e.g. @thm_surface_1, @thm_overlay_0.

The plugin can be pinned to v0.3.0 if desired: set -g @plugin 'catppuccin/tmux#v0.3.0'.

v0.1.0 -> v0.3.0

• @catppuccin_flavour has been renamed to @catppuccin_flavor
• @catppuccin_window_status_enable and @catppuccin_window_status_icon_enable have been merged into @catppuccin_window_status
  • @catppuccin_window_status_enable "yes" becomes @catppuccin_window_status "icon"
  • @catppuccin_window_status_enable "yes" and @catppuccin_window_status_icon_enable "no" becomes @catppuccin_window_status "text"
  • Other combinations are default