diff --git a/README.md b/README.md index 75e0639..0169d42 100644 --- a/README.md +++ b/README.md @@ -27,6 +27,7 @@ 4. [Status](#status) 5. [Customizing modules](#customizing-modules) 6. [Battery module](#battery-module) + 7. [CPU module](#CPU-module) 5. [Create a custom module](#create-a-custom-module) 6. [Configuration Examples](#configuration-examples) 1. [Config 1](#config-1) @@ -174,6 +175,17 @@ set -g @catppuccin_window_format_directory_text "#{b:pane_current_path}" ``` Use this to overide the way the directory is displayed. +### Pane + +#### Set the pane border style: + +set -g @catppuccin_pane_border_style "fg=blue" # Use a value compatible with the standard tmux 'pane-border-style' + +#### Set the pane active border style: + +set -g @catppuccin_pane_active_border_style "fg=red" # Use a value compatible with the standard tmux 'pane-border-active-style' + + ### Status #### Set the status module left separator: @@ -277,6 +289,27 @@ Add the battery module to the status modules list. set -g @catppuccin_status_modules_right "... battery ..." ``` +### CPU module + +#### Requirements +This module depends on [tmux-cpu](https://github.com/tmux-plugins/tmux-cpu/tree/master). + +#### Install +The prefered way to install tmux-cpu is using [TPM](https://github.com/tmux-plugins/tpm). + +#### Configure +Load tmux-cpu after you load catppuccin. +```sh +set -g @plugin 'catppuccin/tmux' +... +set -g @plugin 'tmux-plugins/tmux-cpu' +``` + +Add the cpu module to the status modules list. +```sh +set -g @catppuccin_status_modules_right "... cpu ..." +``` + ## Create a custom module It is possible to add a new custom module or overrite any of the existing modules. diff --git a/catppuccin.tmux b/catppuccin.tmux index e85e079..5186560 100755 --- a/catppuccin.tmux +++ b/catppuccin.tmux @@ -285,8 +285,10 @@ main() { set message-command-style "fg=${thm_cyan},bg=${thm_gray},align=centre" # panes - set pane-border-style "fg=${thm_gray}" - set pane-active-border-style "fg=${thm_blue}" + local pane_border_style=$(get_tmux_option "@catppuccin_pane_border_style" "fg=${thm_gray}") + local pane_active_border_style=$(get_tmux_option "@catppuccin_pane_active_border_style" "fg=${thm_blue}") + set pane-border-style "${pane_border_style}" + set pane-active-border-style "${pane_active_border_style}" # windows setw window-status-activity-style "fg=${thm_fg},bg=${thm_bg},none" diff --git a/custom/README.md b/custom/README.md index 2a39982..e55aa9b 100644 --- a/custom/README.md +++ b/custom/README.md @@ -37,3 +37,7 @@ You can configure a custom path for your modules by setting the `@catppuccin_cus ```sh set -g @catppuccin_custom_plugin_dir "" ``` + +To use the output of a command, use e.g. `local text="$(get_tmux_option "@catppuccin_test_text" "#(date +%T)")"`. + +To use the output of a script, use e.g. `local text="$(get_tmux_option "@catppuccin_test_text" "#($HOME/my_script.sh)")"`. diff --git a/status/cpu.sh b/status/cpu.sh new file mode 100644 index 0000000..0d43359 --- /dev/null +++ b/status/cpu.sh @@ -0,0 +1,14 @@ +show_cpu() { + tmux set-option -g @cpu_low_bg_color "$thm_yellow" # background color when cpu is low + tmux set-option -g @cpu_medium_bg_color "$thm_orange" # background color when cpu is medium + tmux set-option -g @cpu_high_bg_color "$thm_red" # background color when cpu is high + + local index=$1 + local icon=$(get_tmux_option "@catppuccin_cpu_icon" "") + local color="$(get_tmux_option "@catppuccin_cpu_color" "#{cpu_bg_color}")" + local text="$(get_tmux_option "@catppuccin_cpu_text" "#{cpu_percentage}")" + + local module=$( build_status_module "$index" "$icon" "$color" "$text" ) + + echo "$module" +}