ringofstorms/tmux-catppuccin-coal
1
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Merge branch 'main' into fix-conflicts

Browse source
This commit is contained in:
Emil Toivainen 2024-01-18 16:28:16 +02:00 • committed by GitHub
commit 23a6d4aca7
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
4 changed files with 61 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

33
README.md
View file

@ -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.

4
catppuccin.tmux
View file

@ -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 ""

11
custom/README.md
View file

@ -30,3 +30,14 @@ show_<module_name>() { # save this module in a file with the name <module_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 "<path>"
```
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)")"`.

14
status/cpu.sh Normal file
View file

@ -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"
}