diff --git a/README.md b/README.md index 80c2d86..d5114de 100644 --- a/README.md +++ b/README.md @@ -28,6 +28,7 @@ 4. [Pane](#pane) 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) @@ -175,6 +176,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: @@ -296,6 +308,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 9279836..cc280b8 100755 --- a/catppuccin.tmux +++ b/catppuccin.tmux @@ -260,7 +260,8 @@ build_status_module() { load_modules() { local modules_list=$1 - local modules_custom_path=$PLUGIN_DIR/custom + local custom_path="$(get_tmux_option "@catppuccin_custom_plugin_dir" "${PLUGIN_DIR}/custom")" + local modules_custom_path=$custom_path local modules_status_path=$PLUGIN_DIR/status local modules_window_path=$PLUGIN_DIR/window local modules_pane_path=$PLUGIN_DIR/pane @@ -374,6 +375,7 @@ main() { setw pane-border-style "$pane_border_style" setw pane-border-format "$pane_format" + # windows setw window-status-activity-style "fg=${thm_fg},bg=${thm_bg},none" setw window-status-separator "" diff --git a/custom/README.md b/custom/README.md index 232df4a..e55aa9b 100644 --- a/custom/README.md +++ b/custom/README.md @@ -30,3 +30,14 @@ show_() { # save this module in a file with the name . echo "$module" } ``` + +## Configure custom modules path + +You can configure a custom path for your modules by setting the `@catppuccin_custom_plugin_dir` option. +```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" +}