miasma/miasma-os
1
0
Fork 0
mirror of https://github.com/tumillanino/miasma-os.git synced 2026-04-11 07:15:31 +00:00
Code Issues Packages Projects Releases Wiki Activity

move to new repo

Browse Source
This commit is contained in:
tumillanino
2026-03-24 20:17:22 +11:00
parent 083b57c87b
commit 35bcba335a
1910 changed files with 161640 additions and 41 deletions
Download Patch File Download Diff File Expand all files Collapse all files

116
files/system/etc/skel/.tmux/plugins/tmux/docs/reference/configuration.md Normal file
View File

@@ -0,0 +1,116 @@
## Configuration Reference
<img src="../../assets/structure.svg" style="background: #eff1f5" />
This is a diagram of how the theme is split between its components.
### Top Level Options
| Option | Effect |
| -------------------- | ------------------------------------------------------------------------------ |
| `@catppuccin_flavor` | Sets the catppuccin flavor, one of "latte", "frappe", "macchiato", or "mocha". |
### Status Line
| Option | Effect |
| ----------------------------- | --------------------------------------------- |
| @catppuccin_status_background | Sets the background color of the status line. |
- `default` will use the color from the selected theme
- `none` will make the status bar transparent
- use hex color codes for other colors or a theme color (`#{@thm_<color>}`)
### Window
The plugin comes with three window styles built in, these can be customized by
setting the `@catppuccin_window_status_style` option. The default is `basic`.
| Option | Effect | Preview |
| --------- | ------------------------------------------------------------------------ | ------------------------------------------------------ |
| `basic` | Simple styling with blocks. | ![window basic](../../assets/window-basic.webp) |
| `rounded` | Each window is separated with rounded separators. | ![window rounded style](../../assets/window-rounded.webp) |
| `slanted` | Each window is separated with slanted separators. | ![window slanted style](../../assets/window-slanted.webp) |
| `custom` | Custom separators are used. This is required to override the separators! | |
| `none` | Styling of the window status is completely disabled. | ![window no styling](../../assets/window-none.webp) |
If you want to change the active color to something else (the default is mauve),
use the following. For example to use lavender:
```bash
set -g @catppuccin_window_current_number_color "#{@thm_lavender}"
```
<details>
<summary>Customising the separators</summary>
Add the following,
setting whatever values you'd like for the separators:
```bash
set -g @catppuccin_window_status_style "custom"
set -g @catppuccin_window_left_separator ""
set -g @catppuccin_window_middle_separator ""
set -g @catppuccin_window_right_separator ""
```
</details>
### Menu
**Set the menu selected style:**
```sh
# Use a value compatible with the standard tmux `menu-selected-style`
set -g @catppuccin_menu_selected_style "fg=#{@thm_surface_0},bg=#{@thm_yellow}"
```
### All options and their defaults
```bash
# Menu styling options
set -ogq @catppuccin_menu_selected_style "fg=#{@thm_fg},bold,bg=#{@thm_overlay_0}"
# Pane styling options
set -ogq @catppuccin_pane_status_enabled "no" # set to "yes" to enable
set -ogq @catppuccin_pane_border_status "off" # set to "yes" to enable
set -ogq @catppuccin_pane_border_style "fg=#{@thm_overlay_0}"
set -ogq @catppuccin_pane_active_border_style "##{?pane_in_mode,fg=#{@thm_lavender},##{?pane_synchronized,fg=#{@thm_mauve},fg=#{@thm_lavender}}}"
set -ogq @catppuccin_pane_left_separator "█"
set -ogq @catppuccin_pane_middle_separator "█"
set -ogq @catppuccin_pane_right_separator "█"
set -ogq @catppuccin_pane_color "#{@thm_green}"
set -ogq @catppuccin_pane_background_color "#{@thm_surface_0}"
set -ogq @catppuccin_pane_default_text "##{b:pane_current_path}"
set -ogq @catppuccin_pane_default_fill "number"
set -ogq @catppuccin_pane_number_position "left" # right, left
set -ogq @catppuccin_window_status_style "basic" # basic, rounded, slanted, custom, or none
set -ogq @catppuccin_window_text_color "#{@thm_surface_0}"
set -ogq @catppuccin_window_number_color "#{@thm_overlay_2}"
set -ogq @catppuccin_window_text " #T"
set -ogq @catppuccin_window_number "#I"
set -ogq @catppuccin_window_current_text_color "#{@thm_surface_1}"
set -ogq @catppuccin_window_current_number_color "#{@thm_mauve}"
set -ogq @catppuccin_window_current_text " #T"
set -ogq @catppuccin_window_current_number "#I"
set -ogq @catppuccin_window_number_position "left"
set -ogq @catppuccin_window_flags "none" # none, icon, or text
set -ogq @catppuccin_window_flags_icon_last " 󰖰" # -
set -ogq @catppuccin_window_flags_icon_current " 󰖯" # *
set -ogq @catppuccin_window_flags_icon_zoom " 󰁌" # Z
set -ogq @catppuccin_window_flags_icon_mark " 󰃀" # M
set -ogq @catppuccin_window_flags_icon_silent " 󰂛" # ~
set -ogq @catppuccin_window_flags_icon_activity " 󱅫" # #
set -ogq @catppuccin_window_flags_icon_bell " 󰂞" # !
# Matches icon order when using `#F` (`#!~[*-]MZ`)
set -ogq @catppuccin_window_flags_icon_format "##{?window_activity_flag,#{E:@catppuccin_window_flags_icon_activity},}##{?window_bell_flag,#{E:@catppuccin_window_flags_icon_bell},}##{?window_silence_flag,#{E:@catppuccin_window_flags_icon_silent},}##{?window_active,#{E:@catppuccin_window_flags_icon_current},}##{?window_last_flag,#{E:@catppuccin_window_flags_icon_last},}##{?window_marked_flag,#{E:@catppuccin_window_flags_icon_mark},}##{?window_zoomed_flag,#{E:@catppuccin_window_flags_icon_zoom},} "
# Status line options
set -ogq @catppuccin_status_left_separator ""
set -ogq @catppuccin_status_middle_separator ""
set -ogq @catppuccin_status_right_separator "█"
set -ogq @catppuccin_status_connect_separator "yes" # yes, no
set -ogq @catppuccin_status_fill "icon"
set -ogq @catppuccin_status_module_bg_color "#{@thm_surface_0}"
```

239
files/system/etc/skel/.tmux/plugins/tmux/docs/reference/status-line.md Normal file
View File

@@ -0,0 +1,239 @@
## Using the theme's built-in status modules
To use the theme's built in status modules, set the `status-left` and
`status-right` tmux options _after_ the plugin has been loaded with `run`.
The tmux status line modules are set as variables and prefixed with `@catppuccin_status_<module>`.
To use the `application` and `session` modules on the right and have nothing on
the left:
```sh
set -g status-right-length 100
set -g status-right "#{E:@catppuccin_status_application}#{E:@catppuccin_status_session}"
set -g status-left ""
```
## Customizing modules
Every module supports the following overrides:
### Override the specific module icon
```sh
set -g @catppuccin_[module_name]_icon "icon"
```
### Override the specific module color
```sh
set -g @catppuccin_[module_name]_color "color"
```
### Override the specific module text
```sh
set -g @catppuccin_[module_name]_text "text"
```
### Override the specific module's background color
```sh
set -g @catppuccin_status_[module_name]_bg_color "#{@thm_surface_0}"
```
### Removing a specific module option
```sh
set -g @catppuccin_[module_name]_[option] ""
```
This is for the situation where you want to remove the icon from a module.
For example:
```sh
set -g @catppuccin_date_time_icon ""
```
### Notes for TPM users
Make sure you load the catppuccin theme prior to setting the status-left and/or
status-left options. This ensures the catppuccin options (such as colors and
status modules) are defined so they can then be used.
After status-left and/or status-left have been set, make sure to run TPM to load
the modules. This runs any plugins that may replace text in the status line.
```bash
# load catppuccin theme ...
run '~/.config/tmux/plugins/tmux/catppuccin.tmux' # or where this file is located on your machine
# ... and then set status-left & status-right ...
set -g status-left "#{E:@catppuccin_status_session}"
set -g status-right "#{E:@catppuccin_status_[module_name]}"
set -ag status-right "#{E:@catppuccin_status_[module_name]}"
set -agF status-right "#{E:@catppuccin_status_[module_name]}"
# ... and finally start TPM
set -g @plugin 'tmux-plugins/tpm'
run '~/.tmux/plugins/tpm/tpm'
```
## Battery module
**Requirements:** This module depends on [tmux-battery](https://github.com/tmux-plugins/tmux-battery/tree/master).
**Install:** The preferred way to install tmux-battery is using [TPM](https://github.com/tmux-plugins/tpm).
**Configure:**
```sh
run ~/.config/tmux/plugins/catppuccin/tmux/catppuccin.tmux
set -agF status-right "#{E:@catppuccin_status_battery}"
set -g @plugin 'tmux-plugins/tmux-battery'
run '~/.tmux/plugins/tpm/tpm'
```
## CPU module
**Requirements:** This module depends on [tmux-cpu](https://github.com/tmux-plugins/tmux-cpu/tree/master).
**Install:** The preferred way to install tmux-cpu is using [TPM](https://github.com/tmux-plugins/tpm).
**Configure:**
```sh
run ~/.config/tmux/plugins/catppuccin/tmux/catppuccin.tmux
set -agF status-right "#{E:@catppuccin_status_cpu}"
set -g @plugin 'tmux-plugins/tmux-cpu'
run '~/.tmux/plugins/tpm/tpm'
```
## Weather modules
### tmux-weather
**Requirements:** This module depends on [tmux-weather](https://github.com/xamut/tmux-weather).
**Install:** The preferred way to install tmux-weather is using [TPM](https://github.com/tmux-plugins/tpm).
**Configure:**
```sh
run ~/.config/tmux/plugins/catppuccin/tmux/catppuccin.tmux
set -agF status-right "#{E:@catppuccin_status_weather}"
set -g @plugin 'xamut/tmux-weather'
run '~/.tmux/plugins/tpm/tpm'
```
### tmux-clima
**Requirements:** This module depends on [tmux-clima](https://github.com/vascomfnunes/tmux-clima).
**Install:** The preferred way to install tmux-clima is using [TPM](https://github.com/tmux-plugins/tpm).
**Configure:**
```sh
run ~/.config/tmux/plugins/catppuccin/tmux/catppuccin.tmux
set -agF status-right "#{E:@catppuccin_status_clima}"
set -g @plugin 'vascomfnunes/tmux-clima'
run '~/.tmux/plugins/tpm/tpm'
```
## Load module
**Configure:**
```sh
run ~/.config/tmux/plugins/catppuccin/tmux/catppuccin.tmux
set -agF status-right "#{E:@catppuccin_status_load}"
```
## Gitmux module
**Requirements:** This module depends on [gitmux](https://github.com/arl/gitmux).
**Install:** To install gitmux, follow the instructions in the [gitmux documentation](https://github.com/arl/gitmux/blob/main/README.md#installing).
**Configure:**
Add the gitmux module to the status modules list.
```sh
run ~/.config/tmux/plugins/catppuccin/tmux/catppuccin.tmux
set -agF status-right "#{@catppuccin_status_gitmux}"
```
Follow the instructions in the [gitmux documentation](https://github.com/arl/gitmux/blob/main/README.md#customizing)
to create a gitmux config file. The gitmux plugin expects a file to be present
at `~/.gitmux.conf`.
Add the following to your `~/.gitmux.conf` so that it uses catppuccin colors:
```yaml
tmux:
styles:
clear: "#[fg=#{@thm_fg}]"
state: "#[fg=#{@thm_red},bold]"
branch: "#[fg=#{@thm_fg},bold]"
remote: "#[fg=#{@thm_teal}]"
divergence: "#[fg=#{@thm_fg}]"
staged: "#[fg=#{@thm_green},bold]"
conflict: "#[fg=#{@thm_red},bold]"
modified: "#[fg=#{@thm_yellow},bold]"
untracked: "#[fg=#{@thm_mauve},bold]"
stashed: "#[fg=#{@thm_blue},bold]"
clean: "#[fg=#{@thm_rosewater},bold]"
insertions: "#[fg=#{@thm_green}]"
deletions: "#[fg=#{@thm_red}]"
```
## Pomodoro module
**Requirements:**: This module depends on [tmux-pomodoro-plus](https://github.com/olimorris/tmux-pomodoro-plus/tree/main).
**Install:**: The preferred way to install tmux-pomodoro-plus is using [TPM](https://github.com/tmux-plugins/tpm).
**Configure:**
```sh
run ~/.config/tmux/plugins/catppuccin/tmux/catppuccin.tmux
set -agF status-right "#{E:@catppuccin_status_pomodoro_plus}"
set -g @plugin 'olimorris/tmux-pomodoro-plus'
run '~/.tmux/plugins/tpm/tpm'
```
## Kube module
**Requirements:** This module depends on [kube-tmux](https://github.com/jonmosco/kube-tmux).
**Install:** The preferred way to install kube-tmux is using [TPM](https://github.com/tmux-plugins/tpm).
**Configure:**
```sh
set -g @catppuccin_kube_context_color "#{@thm_red}"
set -g @catppuccin_kube_namespace_color "#{@thm_sky}"
run ~/.config/tmux/plugins/catppuccin/tmux/catppuccin.tmux
set -agF status-right "#{E:@catppuccin_status_kube}"
set -g @plugin 'jonmosco/kube-tmux'
run '~/.tmux/plugins/tpm/tpm'
```