Skip to content

Add a "reset" option that will reset all options when loading the plugin #500

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Add a "reset" option that will reset all options when loading the plugin #500

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
882a376
Add a "reset" option that will reset all options when loading the plugin
kjnsn Mar 5, 2025
22b32d8
Create the first draft for resetting theme (#509)
rogeruiz Mar 30, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
74 changes: 74 additions & 0 deletions catppuccin_options_tmux.conf
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,80 @@
# This is executed separately to the main configuration
# so that options are set before parsing the rest of the config.

# Reset everything if requested.
#
# Useful for auto switching between themes:
#
# set-hook -g client-dark-theme {
# set -g @catppuccin_flavor "frappe"
# set -g @catppuccin_reset "true"
# run ~/code/github.com/catppuccin/tmux/catppuccin.tmux
# }
# set-hook -g client-light-theme {
# set -g @catppuccin_flavor "latte"
# set -g @catppuccin_reset "true"
# run ~/code/github.com/catppuccin/tmux/catppuccin.tmux
# }
%if "#{==:#{@catppuccin_reset},true}"
set -Ugq @thm_bg
set -Ugq @thm_fg
set -Ugq @thm_rosewater
set -Ugq @thm_flamingo
set -Ugq @thm_rosewater
set -Ugq @thm_pink
set -Ugq @thm_mauve
set -Ugq @thm_red
set -Ugq @thm_maroon
set -Ugq @thm_peach
set -Ugq @thm_yellow
set -Ugq @thm_green
set -Ugq @thm_teal
set -Ugq @thm_sky
set -Ugq @thm_sapphire
set -Ugq @thm_blue
set -Ugq @thm_lavender
set -Ugq @thm_subtext_1
set -Ugq @thm_subtext_0
set -Ugq @thm_overlay_2
set -Ugq @thm_overlay_1
set -Ugq @thm_overlay_0
set -Ugq @thm_surface_2
set -Ugq @thm_surface_1
set -Ugq @thm_surface_0
set -Ugq @thm_mantle
set -Ugq @thm_crust
set -Ugq @catppuccin_window_status_style
set -Ugq @catppuccin_window_text_color
set -Ugq @catppuccin_window_number_color
set -Ugq @catppuccin_window_text
set -Ugq @catppuccin_window_number
set -Ugq @catppuccin_window_current_text_color
set -Ugq @catppuccin_window_current_number_color
set -Ugq @catppuccin_window_current_text
set -Ugq @catppuccin_window_current_number
set -Ugq @catppuccin_window_number_position
set -Ugq @catppuccin_window_flags
set -Ugq @catppuccin_window_flags_icon_last
set -Ugq @catppuccin_window_flags_icon_current
set -Ugq @catppuccin_window_flags_icon_zoom
set -Ugq @catppuccin_window_flags_icon_mark
set -Ugq @catppuccin_window_flags_icon_silent
set -Ugq @catppuccin_window_flags_icon_activity
set -Ugq @catppuccin_window_flags_icon_bell
set -Ugq @catppuccin_window_flags_icon_format
set -Ugq @catppuccin_status_left_separator
set -Ugq @catppuccin_status_middle_separator
set -Ugq @catppuccin_status_right_separator
set -Ugq @catppuccin_status_connect_separator
set -Ugq @catppuccin_status_module_text_bg
set -Ugq @catppuccin_window_current_left_separator
set -Ugq @catppuccin_window_current_middle_separator
set -Ugq @catppuccin_window_current_right_separator

# Finally reset the reset option.
set -Ug @catppuccin_reset
%endif

set -ogq @catppuccin_flavor "mocha"

set -ogq @catppuccin_status_background "default"
Expand Down
184 changes: 184 additions & 0 deletions docs/tutorials/03-resetting-theme.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,184 @@
# Changing the flavor of the theme by resetting

To reset the colors colors in your status line, you can perform a reset of all
the options associated with the styling of the Tmux-line. This is done by
setting a global option called `@catppuccin_reset` to `true.

```txt
@thm_bg
@thm_fg
@thm_rosewater
@thm_flamingo
@thm_rosewater
@thm_pink
@thm_mauve
@thm_red
@thm_maroon
@thm_peach
@thm_yellow
@thm_green
@thm_teal
@thm_sky
@thm_sapphire
@thm_blue
@thm_lavender
@thm_subtext_1
@thm_subtext_0
@thm_overlay_2
@thm_overlay_1
@thm_overlay_0
@thm_surface_2
@thm_surface_1
@thm_surface_0
@thm_mantle
@thm_crust
@catppuccin_window_status_style
@catppuccin_window_text_color
@catppuccin_window_number_color
@catppuccin_window_text
@catppuccin_window_number
@catppuccin_window_current_text_color
@catppuccin_window_current_number_color
@catppuccin_window_current_text
@catppuccin_window_current_number
@catppuccin_window_number_position
@catppuccin_window_flags
@catppuccin_window_flags_icon_last
@catppuccin_window_flags_icon_current
@catppuccin_window_flags_icon_zoom
@catppuccin_window_flags_icon_mark
@catppuccin_window_flags_icon_silent
@catppuccin_window_flags_icon_activity
@catppuccin_window_flags_icon_bell
@catppuccin_window_flags_icon_format
@catppuccin_status_left_separator
@catppuccin_status_middle_separator
@catppuccin_status_right_separator
@catppuccin_status_connect_separator
@catppuccin_status_module_text_bg
@catppuccin_window_current_left_separator
@catppuccin_window_current_middle_separator
@catppuccin_window_current_right_separator
```

All of these Tmux options are unset, with the `-U` flag, when the plugin is
called with the option named `@catppuccin_reset` with a value of `true`. Due to
the way options are set within the plugin, with the `-o` flag, this means that
all user-set options will be reset to their original default values. _This means
that if you have set custom options, you will lose your updates and **will need
to run the plugin again after setting your custom options**_.

This feature is most useful for auto switching between the theme's flavor.

## Minimal example of resetting the flavor

If you're using all the defaults of Catppuccin Tmux, you will only have to worry
about setting the flavor when setting the `@catppuccin_reset` option.

```sh
# somewhere in a Tmux configuration file
set -g @catppuccin_flavor "latte"
set -g @catppuccin_reset "true"
run /path/to/catppuccin/tmux/catppuccin.tmux
```

> [!NOTE]
> Your path above, the line starting with `run ...`, will need to be updated to
> where ever the `catpuccin.tmux` file is located on your system.

## Custom example of resetting the flavor

If you're customizing any of the settings that get reset in the list above, you
must set set options you're customizing along with any dependent options _that
aren't necessary_ when configuring the theme for only a single flavor.

> [!TIP]
> This section is most important for folks who've really riced the shit of our
> of their setup.

Like in the minimal example, you will set your flavor and also reset the plugin.

```sh
# somewhere in a Tmux configuration file
set -g @catppuccin_flavor "latte"
set -g @catppuccin_reset "true"
run /path/to/catppuccin/tmux/catppuccin.tmux
```

But right afterwards, you'll have to set both the before and after your `run
...` the plugin. This does mean running the plugin twice in rapid succession.

```sh

# somewhere in a Tmux configuration file
set -g @catppuccin_flavor "latte"
set -g @catppuccin_reset "true"
run /path/to/catppuccin/tmux/catppuccin.tmux

# after the initial reset call
set -g @catppuccin_flavor "mocha"
set -g @catppuccin_window_status_style "basic"
set -g @catppuccin_window_text " #W"
set -g @catppuccin_window_number "#I"
set -g @catppuccin_window_current_text " #W"
set -g @catppuccin_window_current_number "#I"
set -g @catppuccin_pane_status_enabled "yes"
set -g @catppuccin_pane_border_status "yes"
set -g @catppuccin_window_number_position "right"
set -g @catppuccin_window_current_text "#{pane_current_path}"
set -g @catppuccin_pane_left_separator "▓"
set -g @catppuccin_pane_middle_separator "▓"
set -g @catppuccin_pane_right_separator "▓"
set -g @catppuccin_status_left_separator "▓"
set -g @catppuccin_status_middle_separator "▓"
set -g @catppuccin_status_right_separator "▓"
set -g @catppuccin_status_right_separator_inverse "no"
set -g @catppuccin_status_connect_separator "yes"
set -g @catppuccin_window_status_enable "yes"
set -g @catppuccin_status_fill "icon"
set -g @catppuccin_window_flags "icon"
set -g @catppuccin_application_icon " 󰣆 "
set -g @catppuccin_session_icon "  "
set -g @catppuccin_window_text_color "#{@thm_surface_0}"
set -g @catppuccin_window_number_color "#{@thm_overlay_2}"
set -g @catppuccin_window_current_text_color "#{@thm_surface_1}"
set -g @catppuccin_window_current_number_color "#{@thm_mauve}"
set -g @catppuccin_status_module_bg_color "#{@thm_surface_0}"
set -g @catppuccin_status_application_icon_fg "#{E:@thm_crust}"
set -g @catppuccin_status_application_text_fg "#{E:@thm_fg}"
set -g @catppuccin_application_color "#{E:@thm_maroon}"
set -g @catppuccin_status_session_icon_fg "#{E:@thm_crust}"
set -g @catppuccin_status_session_text_fg "#{E:@thm_fg}"
set -g @catppuccin_session_color "#{?client_prefix,#{E:@thm_red},#{E:@thm_green}}"
set -g @catppuccin_status_module_text_bg "#{?@catppuccin_status_module_bg_color,#{E:@catppuccin_status_module_bg_color},#{@thm_surface_0}}"

run /path/to/catppuccin/tmux/catppuccin.tmux
```

Notice that above there are certain lines that are being set that aren't usually
set initially. This is due to the colors being updated. _These options are
highlighted below in a smaller snippet_. These specific options aren't usually
set when configuring the plugin for a single flavor. Due to how options are
reset and then immediately set in the entry point for the plugin, all options
will be updated to their defaults which aren't going to be what you've
customized.

```sh
set -g @catppuccin_window_text_color "#{@thm_surface_0}"
set -g @catppuccin_window_number_color "#{@thm_overlay_2}"
set -g @catppuccin_window_current_text_color "#{@thm_surface_1}"
set -g @catppuccin_window_current_number_color "#{@thm_mauve}"
set -g @catppuccin_status_module_bg_color "#{@thm_surface_0}"
set -g @catppuccin_status_application_icon_fg "#{E:@thm_crust}"
set -g @catppuccin_status_application_text_fg "#{E:@thm_fg}"
set -g @catppuccin_application_color "#{E:@thm_maroon}"
set -g @catppuccin_status_session_icon_fg "#{E:@thm_crust}"
set -g @catppuccin_status_session_text_fg "#{E:@thm_fg}"
set -g @catppuccin_session_color "#{?client_prefix,#{E:@thm_red},#{E:@thm_green}}"
set -g @catppuccin_status_module_text_bg "#{?@catppuccin_status_module_bg_color,#{E:@catppuccin_status_module_bg_color},#{@thm_surface_0}}"
```

> [!NOTE]
> See the `@catppuccin_status_module_bg_color` and other color options such as
> `@catppuccin_application_color` and others have to be set due to the how the
> plugin resets all the values listed at the top of this document.
3 changes: 3 additions & 0 deletions foo.conf
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
%if "#{==:$USER_THEME,}"
source "~/scripts/tmux/$USER_THEME.conf"
%endif