From 074a1363e3f31a14a1ec41d527a1ef332ed467c1 Mon Sep 17 00:00:00 2001
From: Theoreticallyhugo <me@theoreticallyhugo.com>
Date: Tue, 20 Aug 2024 11:28:19 +0200
Subject: [PATCH 01/20] wip/copied most flags that can be set

---
 README.md       | 12 +++-------
 docs/battery.md |  4 ++++
 docs/dracula.md | 59 +++++++++++++++++++++++++++++++++++++++++++++++++
 docs/misc.md    | 58 ++++++++++++++++++++++++++++++++++++++++++++++++
 4 files changed, 124 insertions(+), 9 deletions(-)
 create mode 100644 docs/battery.md
 create mode 100644 docs/dracula.md
 create mode 100644 docs/misc.md

diff --git a/README.md b/README.md
index cfa53f87..66be2875 100644
--- a/README.md
+++ b/README.md
@@ -15,13 +15,14 @@ Configuration and options can be found at [draculatheme.com/tmux](https://dracul
 ## Features
 
 - Support for powerline
+- Support for NerdFonts
 - Day, date, time, timezone
 - [Fully custom color theming](/docs/color_theming/README.md)
 - Current location based on network with temperature and forecast icon (if available)
 - Network connection status, bandwidth and SSID
 - SSH session user, hostname and port of active tmux pane
 - Git branch and status
-- Battery percentage and AC power connection status
+- Battery percentage and AC power connection status with icons
 - Refresh rate control
 - CPU usage (percentage or load average)
 - RAM usage (system and/or tmux server)
@@ -31,14 +32,7 @@ Configuration and options can be found at [draculatheme.com/tmux](https://dracul
 - GPU power draw
 - Color code based on whether a prefix is active or not
 - List of windows with the current window highlighted
-- When prefix is enabled, a smiley face turns from green to yellow
-- When charging, 'AC' is displayed
-    - Alternatively show battery level and whether its charging next to percentage by setting:
-    ```
-    set -g @dracula-battery-label false
-    set -g @dracula-no-battery-label false
-    set -g @dracula-show-battery-status true
-    ```
+- When prefix is enabled, the left status bar widget turns from green to yellow
 - If forecast information is available, a ☀, ☁, ☂, or ❄ unicode character corresponding with the forecast is displayed alongside the temperature
 - Read system temperature
 - Info if the Panes are synchronized
diff --git a/docs/battery.md b/docs/battery.md
new file mode 100644
index 00000000..8ce33ec8
--- /dev/null
+++ b/docs/battery.md
@@ -0,0 +1,4 @@
+# battery display
+
+set -g @dracula-battery-label false
+set -g @dracula-show-battery-status true
diff --git a/docs/dracula.md b/docs/dracula.md
new file mode 100644
index 00000000..0d3222b5
--- /dev/null
+++ b/docs/dracula.md
@@ -0,0 +1,59 @@
+  # set configuration option variables
+  show_kubernetes_context_label=$(get_tmux_option "@dracula-kubernetes-context-label" "")
+  eks_hide_arn=$(get_tmux_option "@dracula-kubernetes-eks-hide-arn" false)
+  eks_extract_account=$(get_tmux_option "@dracula-kubernetes-eks-extract-account" false)
+  hide_kubernetes_user=$(get_tmux_option "@dracula-kubernetes-hide-user" false)
+  terraform_label=$(get_tmux_option "@dracula-terraform-label" "")
+  show_fahrenheit=$(get_tmux_option "@dracula-show-fahrenheit" true)
+  show_location=$(get_tmux_option "@dracula-show-location" true)
+  fixed_location=$(get_tmux_option "@dracula-fixed-location")
+  show_powerline=$(get_tmux_option "@dracula-show-powerline" false)
+  show_flags=$(get_tmux_option "@dracula-show-flags" false)
+  show_left_icon=$(get_tmux_option "@dracula-show-left-icon" smiley)
+  show_left_icon_padding=$(get_tmux_option "@dracula-left-icon-padding" 1)
+  show_military=$(get_tmux_option "@dracula-military-time" false)
+  timezone=$(get_tmux_option "@dracula-set-timezone" "")
+  show_timezone=$(get_tmux_option "@dracula-show-timezone" true)
+  show_left_sep=$(get_tmux_option "@dracula-show-left-sep" )
+  show_right_sep=$(get_tmux_option "@dracula-show-right-sep" )
+  show_border_contrast=$(get_tmux_option "@dracula-border-contrast" false)
+  show_day_month=$(get_tmux_option "@dracula-day-month" false)
+  show_refresh=$(get_tmux_option "@dracula-refresh-rate" 5)
+  show_synchronize_panes_label=$(get_tmux_option "@dracula-synchronize-panes-label" "Sync")
+  time_format=$(get_tmux_option "@dracula-time-format" "")
+  show_ssh_session_port=$(get_tmux_option "@dracula-show-ssh-session-port" false)
+  show_libreview=$(get_tmux_option "@dracula-show-libreview" false)
+  IFS=' ' read -r -a plugins <<< $(get_tmux_option "@dracula-plugins" "battery network weather")
+  show_empty_plugins=$(get_tmux_option "@dracula-show-empty-plugins" true)
+
+## widget colours
+```bash
+set -g "@dracula-cwd-colors" "dark_gray white"
+set -g "@dracula-fossil-colors" "green dark_gray"
+set -g "@dracula-git-colors" "green dark_gray"
+set -g "@dracula-hg-colors" "green dark_gray"
+set -g "@dracula-battery-colors" "pink dark_gray"
+set -g "@dracula-gpu-usage-colors" "pink dark_gray"
+set -g "@dracula-gpu-ram-usage-colors" "cyan dark_gray"
+set -g "@dracula-gpu-power-draw-colors" "green dark_gray"
+set -g "@dracula-cpu-usage-colors" "orange dark_gray"
+set -g "@dracula-ram-usage-colors" "cyan dark_gray"
+set -g "@dracula-tmux-ram-usage-colors" "cyan dark_gray"
+set -g "@dracula-network-colors" "cyan dark_gray"
+set -g "@dracula-network-bandwidth-colors" "cyan dark_gray"
+set -g "@dracula-network-ping-colors" "cyan dark_gray"
+set -g "@dracula-network-vpn-colors" "cyan dark_gray"
+set -g "@dracula-attached-clients-colors" "cyan dark_gray"
+set -g "@dracula-mpc-colors" "green dark_gray"
+set -g "@dracula-spotify-tui-colors" "green dark_gray"
+set -g "@dracula-playerctl-colors" "green dark_gray"
+set -g "@dracula-kubernetes-context-colors" "cyan dark_gray"
+set -g "@dracula-terraform-colors" "light_purple dark_gray"
+set -g "@dracula-continuum-colors" "cyan dark_gray"
+set -g "@dracula-weather-colors" "orange dark_gray"
+set -g "@dracula-time-colors" "dark_purple white"
+set -g "@dracula-synchronize-panes-colors" "cyan dark_gray"
+set -g "@dracula-libre-colors" "white dark_gray"
+set -g "@dracula-ssh-session-colors" "green dark_gray"
+```
+
diff --git a/docs/misc.md b/docs/misc.md
new file mode 100644
index 00000000..ac101906
--- /dev/null
+++ b/docs/misc.md
@@ -0,0 +1,58 @@
+## left icon
+
+pretty example:
+`set -g @dracula-show-left-icon "#h | #S"`
+
+formats:
+`#H: Hostname of local host`
+`#h: Hostname of local host (no domain name)`
+`#S: name of session` -> alias trs to tmux rename-session
+more formats can be found here, though those without a shorthand like #H need to be used like #{host}, which is equivalent.
+[tmux(1) - OpenBSD manual pages](https://man.openbsd.org/tmux.1#FORMATS)
+
+besides formats, any other string can be used.
+## continuum
+
+alert_mode="@dracula-continuum-mode"
+time_threshold="@dracula-continuum-time-threshold"
+warn_threshold=360
+first_save="@dracula-continuum-first-save"
+
+## cpu_info
+
+  RATE=$(get_tmux_option "@dracula-refresh-rate" 5)
+  cpu_load=$(get_tmux_option "@dracula-cpu-display-load" false)
+  cpu_label=$(get_tmux_option "@dracula-cpu-usage-label" "CPU")
+
+## gpu_info
+
+  RATE=$(get_tmux_option "@dracula-refresh-rate" 5)
+  ignore_lspci=$(get_tmux_option "@dracula-ignore-lspci" false)
+  gpu_label=$(get_tmux_option "@dracula-gpu-usage-label" "GPU")
+  gpu_label=$(get_tmux_option "@dracula-gpu-usage-label" "VRAM")
+  gpu_label=$(get_tmux_option "@dracula-gpu-usage-label" "GPU")
+
+## network
+**this will only display the wifi youre connected to, if it provides internet access!**
+## network bandwidth
+tmux show-option -gqv "@dracula-network-bandwidth"
+## network ping
+    pingserver=$(get_tmux_option "@dracula-ping-server" "google.com")
+  RATE=$(get_tmux_option "@dracula-ping-rate" 5)
+## playerctl
+
+  RATE=$(get_tmux_option "@dracula-refresh-rate" 5)
+  FORMAT=$(get_tmux_option "@dracula-playerctl-format" "Now playing: {{ artist }} - {{ album }} - {{ title }}")
+## ram usage
+  ram_label=$(get_tmux_option "@dracula-ram-usage-label" "RAM")
+## spotify tui
+  RATE=$(get_tmux_option "@dracula-refresh-rate" 5)
+  FORMAT=$(get_tmux_option "@dracula-spotify-tui-format" "%f %s %t - %a")
+  max_len=$(get_tmux_option "@dracula-spotify-tui-max-len" 0)
+## synchronise panes
+  current_synchronize_panes_status=$(get_tmux_window_option "synchronize-panes" "off")
+  RATE=$(get_tmux_option "@dracula-refresh-rate" 5)
+## terraform
+  RATE=$(get_tmux_option "@dracula-refresh-rate" 5)
+## tmux ram usage
+  ram_label=$(get_tmux_option "@dracula-tmux-ram-usage-label" "MEM")

From 45eb708146ea6b5a0dbf6245c81e83a063272d31 Mon Sep 17 00:00:00 2001
From: Theoreticallyhugo <me@theoreticallyhugo.com>
Date: Mon, 26 Aug 2024 18:46:15 +0200
Subject: [PATCH 02/20] improvements

---
 docs/battery.md |  7 +++++++
 docs/misc.md    | 37 +++++++++++++++++++++++++++----------
 2 files changed, 34 insertions(+), 10 deletions(-)

diff --git a/docs/battery.md b/docs/battery.md
index 8ce33ec8..d6d22374 100644
--- a/docs/battery.md
+++ b/docs/battery.md
@@ -1,4 +1,11 @@
 # battery display
 
+Display any icon for the battery you'd like with:
+`set -g @dracula-battery-label "put_your_label_here"`
+
+Alternatively set:
+```
 set -g @dracula-battery-label false
 set -g @dracula-show-battery-status true
+```
+Which will display the battery charge and whether its charging (or just drawing from AC) as nerdfont icons.
diff --git a/docs/misc.md b/docs/misc.md
index ac101906..e5dbcdf2 100644
--- a/docs/misc.md
+++ b/docs/misc.md
@@ -1,6 +1,16 @@
+"󰈀 "
+"󰣀 "
+"󱍢 "
+"󰉉 "
+
+
+
 ## left icon
 
-pretty example:
+The left icon can be set to anything static you'd like.
+However if you use tmux on multiple machines, it may be helpful to display the hostname.
+If you use multiple sessions simultaneously it can be good to name them and have the name in the left icon.
+the following example uses formatting to display "hostname | session_name":
 `set -g @dracula-show-left-icon "#h | #S"`
 
 formats:
@@ -11,20 +21,27 @@ more formats can be found here, though those without a shorthand like #H need to
 [tmux(1) - OpenBSD manual pages](https://man.openbsd.org/tmux.1#FORMATS)
 
 besides formats, any other string can be used.
+
 ## continuum
 
-alert_mode="@dracula-continuum-mode"
-time_threshold="@dracula-continuum-time-threshold"
-warn_threshold=360
-first_save="@dracula-continuum-first-save"
+@dracula-continuum-mode
+@dracula-continuum-time-threshold
+@dracula-continuum-first-save
+@resurrect-dir
+@continuum-save-last-timestamp
+@continuum-save-interval
 
 ## cpu_info
+Displays cpu usage in percent by default, but can display cpu load on linux, if the following flag is set to true:
+`set -g @dracula-cpu-display-load false`
+Additionally the label can be set to whatever you'd like.
+`set -g @dracula-cpu-usage-label "CPU"`
+If you're using nerdfonts, try one of the following.
+`   󰍛 󰘚 󰻟 󰻠 `
 
-  RATE=$(get_tmux_option "@dracula-refresh-rate" 5)
-  cpu_load=$(get_tmux_option "@dracula-cpu-display-load" false)
-  cpu_label=$(get_tmux_option "@dracula-cpu-usage-label" "CPU")
-
+`set -g @dracula-refresh-rate` affects this widget
 ## gpu_info
+"󰢮 "
 
   RATE=$(get_tmux_option "@dracula-refresh-rate" 5)
   ignore_lspci=$(get_tmux_option "@dracula-ignore-lspci" false)
@@ -33,7 +50,7 @@ first_save="@dracula-continuum-first-save"
   gpu_label=$(get_tmux_option "@dracula-gpu-usage-label" "GPU")
 
 ## network
-**this will only display the wifi youre connected to, if it provides internet access!**
+**This will only display the wifi you're connected to, if it provides internet access!**
 ## network bandwidth
 tmux show-option -gqv "@dracula-network-bandwidth"
 ## network ping

From 2381c08f35e3c3aa1848af4178e796efff78934e Mon Sep 17 00:00:00 2001
From: Theoreticallyhugo <me@theoreticallyhugo.com>
Date: Thu, 29 Aug 2024 23:11:19 +0200
Subject: [PATCH 03/20] more improvements

---
 docs/misc.md      | 75 +++++++++++++++++++++++++++++++++++++----------
 docs/theming.md   | 41 ++++++++++++++++++++++++++
 docs/tmux_conf.md |  1 +
 3 files changed, 102 insertions(+), 15 deletions(-)
 create mode 100644 docs/theming.md
 create mode 100644 docs/tmux_conf.md

diff --git a/docs/misc.md b/docs/misc.md
index e5dbcdf2..cc3fbaba 100644
--- a/docs/misc.md
+++ b/docs/misc.md
@@ -3,8 +3,6 @@
 "󱍢 "
 "󰉉 "
 
-
-
 ## left icon
 
 The left icon can be set to anything static you'd like.
@@ -32,6 +30,7 @@ besides formats, any other string can be used.
 @continuum-save-interval
 
 ## cpu_info
+
 Displays cpu usage in percent by default, but can display cpu load on linux, if the following flag is set to true:
 `set -g @dracula-cpu-display-load false`
 Additionally the label can be set to whatever you'd like.
@@ -40,36 +39,82 @@ If you're using nerdfonts, try one of the following.
 `   󰍛 󰘚 󰻟 󰻠 `
 
 `set -g @dracula-refresh-rate` affects this widget
+
 ## gpu_info
+
+currently only works with NVIDIA gpus.
 "󰢮 "
 
-  RATE=$(get_tmux_option "@dracula-refresh-rate" 5)
-  ignore_lspci=$(get_tmux_option "@dracula-ignore-lspci" false)
-  gpu_label=$(get_tmux_option "@dracula-gpu-usage-label" "GPU")
-  gpu_label=$(get_tmux_option "@dracula-gpu-usage-label" "VRAM")
-  gpu_label=$(get_tmux_option "@dracula-gpu-usage-label" "GPU")
+if your gpu is not recognised, force the script to run anyways.
+`set -g @dracula-ignore-lspci false`
+
+```
+set -g @dracula-gpu-usage-label "GPU"
+set -g @dracula-gpu-vram-label "VRAM"
+set -g @dracula-gpu-power-label "GPU"
+```
+
+TODO:
+
+- switch from `lspci` to `which -s nvidia-smi`
+- add support for amd without testing and clarify that this is an experimental feature! ask someone whos got an amd card to test it.
+
+`set -g @dracula-refresh-rate` affects this widget
 
 ## network
+
 **This will only display the wifi you're connected to, if it provides internet access!**
+
+set -g @dracula-network-ethernet-label "󰈀 Eth"
+set -g @dracula-network-offline-label "󱍢 "
+set -g @dracula-network-wifi-label " "
+set -g @dracula-network-hosts "1.1.1.1 8.8.8.8"
+
 ## network bandwidth
+
 tmux show-option -gqv "@dracula-network-bandwidth"
+
 ## network ping
+
     pingserver=$(get_tmux_option "@dracula-ping-server" "google.com")
-  RATE=$(get_tmux_option "@dracula-ping-rate" 5)
+
+RATE=$(get_tmux_option "@dracula-ping-rate" 5)
+
+## network vpn
+
+set -g @dracula-network-vpn-verbose true
+
+TODO:
+set -g @dracula-network-vpn-label
+
 ## playerctl
 
-  RATE=$(get_tmux_option "@dracula-refresh-rate" 5)
+RATE=$(get_tmux_option "@dracula-refresh-rate" 5)
   FORMAT=$(get_tmux_option "@dracula-playerctl-format" "Now playing: {{ artist }} - {{ album }} - {{ title }}")
+
 ## ram usage
-  ram_label=$(get_tmux_option "@dracula-ram-usage-label" "RAM")
+
+ram_label=$(get_tmux_option "@dracula-ram-usage-label" "RAM")
+
+## ssh session
+
+set -g @dracula-show-ssh-only-when-connected true
+
 ## spotify tui
-  RATE=$(get_tmux_option "@dracula-refresh-rate" 5)
+
+RATE=$(get_tmux_option "@dracula-refresh-rate" 5)
   FORMAT=$(get_tmux_option "@dracula-spotify-tui-format" "%f %s %t - %a")
-  max_len=$(get_tmux_option "@dracula-spotify-tui-max-len" 0)
+max_len=$(get_tmux_option "@dracula-spotify-tui-max-len" 0)
+
 ## synchronise panes
-  current_synchronize_panes_status=$(get_tmux_window_option "synchronize-panes" "off")
+
+current_synchronize_panes_status=$(get_tmux_window_option "synchronize-panes" "off")
   RATE=$(get_tmux_option "@dracula-refresh-rate" 5)
+
 ## terraform
-  RATE=$(get_tmux_option "@dracula-refresh-rate" 5)
+
+RATE=$(get_tmux_option "@dracula-refresh-rate" 5)
+
 ## tmux ram usage
-  ram_label=$(get_tmux_option "@dracula-tmux-ram-usage-label" "MEM")
+
+ram_label=$(get_tmux_option "@dracula-tmux-ram-usage-label" "MEM")
diff --git a/docs/theming.md b/docs/theming.md
new file mode 100644
index 00000000..5d0f107e
--- /dev/null
+++ b/docs/theming.md
@@ -0,0 +1,41 @@
+# drac to cat
+
+# catppuccin Color Pallette
+Rosewater='#f5e0dc'
+Flamingo='#f2cdcd'
+Pink='#f5c2e7'
+Mauve='#cba6f7' # replace pink
+Red='#f38ba8'
+Maroon='#eba0ac'
+Peach='#fab387' # replacing orange
+Yellow='#f9e2af' # replacing yellow
+Green='#a6e3a1' # replacing green
+Teal='#94e2d5'
+Sky='#89dceb' # replacing cyan
+Sapphire='#74c7ec'
+Blue='#89b4fa' # replacing dark_purple
+Lavender='#b4befe' # replacing light_purple
+Text='#cdd6f4' # replacing white
+Subtext1='#bac2de'
+Subtext0='#a6adc8'
+Overlay2='#9399b2'
+Overlay1='#7f849c'
+Overlay0='#6c7086'
+Surface2='#585b70'
+Surface1='#45475a'
+Surface0='#313244' # replace dark_gray
+Base='#1e1e2e'
+Mantle='#181825'
+Crust='#11111b'
+
+set -g "@dracula-color-white" $Text
+set -g "@dracula-color-gray" $Surface1
+set -g "@dracula-color-dark_gray" $Surface0
+set -g "@dracula-color-light_purple" $Lavender
+set -g "@dracula-color-dark_purple" $Overlay0
+set -g "@dracula-color-cyan" $Sky
+set -g "@dracula-color-green" $Green
+set -g "@dracula-color-orange" $Peach
+set -g "@dracula-color-red" $Red
+set -g "@dracula-color-pink" $Mauve
+set -g "@dracula-color-yellow" $Yellow
diff --git a/docs/tmux_conf.md b/docs/tmux_conf.md
new file mode 100644
index 00000000..64fc860a
--- /dev/null
+++ b/docs/tmux_conf.md
@@ -0,0 +1 @@
+# a sensible tmux config with defaults for a nerdfont user

From 896084e91305a833981d95b7d71b8d5f37c2a334 Mon Sep 17 00:00:00 2001
From: Theoreticallyhugo <me@theoreticallyhugo.com>
Date: Sat, 31 Aug 2024 00:41:42 +0200
Subject: [PATCH 04/20] basic theming

---
 docs/theming.md | 63 ++++++++++++++++++++++++++++++++++++++++---------
 1 file changed, 52 insertions(+), 11 deletions(-)

diff --git a/docs/theming.md b/docs/theming.md
index 5d0f107e..c2bda106 100644
--- a/docs/theming.md
+++ b/docs/theming.md
@@ -1,6 +1,30 @@
 # drac to cat
 
+if your tmux config is in `~/.config/tmux/`, then consider using the following:
+`set -g @dracula-colors "~/.config/tmux/colors.sh"`
+
+for a quick setup, fill the file with the following contents:
+```
+# simple catppuccin Color Pallette
+pink='#cba6f7'
+orange='#fab387'
+yellow='#f9e2af'
+green='#a6e3a1'
+cyan='#89dceb'
+light_purple='#b4befe'
+white='#cdd6f4'
+dark_gray='#313244'
+red='#f38ba8'
+gray='#45475a'
+dark_purple='#6c7086'
+```
+
+
+alternatively use the full catppuccin color palette and customise the flags accordingly
+
 # catppuccin Color Pallette
+
+# TODO: check em all
 Rosewater='#f5e0dc'
 Flamingo='#f2cdcd'
 Pink='#f5c2e7'
@@ -28,14 +52,31 @@ Base='#1e1e2e'
 Mantle='#181825'
 Crust='#11111b'
 
-set -g "@dracula-color-white" $Text
-set -g "@dracula-color-gray" $Surface1
-set -g "@dracula-color-dark_gray" $Surface0
-set -g "@dracula-color-light_purple" $Lavender
-set -g "@dracula-color-dark_purple" $Overlay0
-set -g "@dracula-color-cyan" $Sky
-set -g "@dracula-color-green" $Green
-set -g "@dracula-color-orange" $Peach
-set -g "@dracula-color-red" $Red
-set -g "@dracula-color-pink" $Mauve
-set -g "@dracula-color-yellow" $Yellow
+# TODO: check em all
+set -g "@dracula-cwd-colors" "Surface0 Text"
+set -g "@dracula-fossil-colors" "Green Surface0"
+set -g "@dracula-git-colors" "Green Surface0"
+set -g "@dracula-hg-colors" "Green Surface0"
+set -g "@dracula-battery-colors" "Mauve Surface0"
+set -g "@dracula-gpu-usage-colors" "Mauve Surface0"
+set -g "@dracula-gpu-ram-usage-colors" "Sky Surface0"
+set -g "@dracula-gpu-power-draw-colors" "Green Surface0"
+set -g "@dracula-cpu-usage-colors" "orange Surface0"
+set -g "@dracula-ram-usage-colors" "Sky Surface0"
+set -g "@dracula-tmux-ram-usage-colors" "Sky Surface0"
+set -g "@dracula-network-colors" "Sky Surface0"
+set -g "@dracula-network-bandwidth-colors" "Sky Surface0"
+set -g "@dracula-network-ping-colors" "Sky Surface0"
+set -g "@dracula-network-vpn-colors" "Sky Surface0"
+set -g "@dracula-attached-clients-colors" "Sky Surface0"
+set -g "@dracula-mpc-colors" "Green Surface0"
+set -g "@dracula-spotify-tui-colors" "Green Surface0"
+set -g "@dracula-playerctl-colors" "Green Surface0"
+set -g "@dracula-kubernetes-context-colors" "Sky Surface0"
+set -g "@dracula-terraform-colors" "Lavender Surface0"
+set -g "@dracula-continuum-colors" "Sky Surface0"
+set -g "@dracula-weather-colors" "orange Surface0"
+set -g "@dracula-time-colors" "dark_purple white"
+set -g "@dracula-synchronize-panes-colors" "Sky Surface0"
+set -g "@dracula-libre-colors" "Text Surface0"
+set -g "@dracula-ssh-session-colors" "Green Surface0"

From 70a0f25bb223464b76763e6daa7190da95040648 Mon Sep 17 00:00:00 2001
From: Theoreticallyhugo <me@theoreticallyhugo.com>
Date: Sat, 31 Aug 2024 00:42:08 +0200
Subject: [PATCH 05/20] todo/custom_scripts

---
 docs/custom_scripts.md | 15 +++++++++++++++
 1 file changed, 15 insertions(+)
 create mode 100644 docs/custom_scripts.md

diff --git a/docs/custom_scripts.md b/docs/custom_scripts.md
new file mode 100644
index 00000000..36657200
--- /dev/null
+++ b/docs/custom_scripts.md
@@ -0,0 +1,15 @@
+# document this
+```
+  for plugin in "${plugins[@]}"; do
+
+    if case $plugin in custom:*) true;; *) false;; esac; then
+      script=${plugin#"custom:"}
+      if [[ -x "${current_dir}/${script}" ]]; then
+        IFS=' ' read -r -a colors <<<$(get_tmux_option "@dracula-custom-plugin-colors" "cyan dark_gray")
+        script="#($current_dir/${script})"
+      else
+        colors[0]="red"
+        colors[1]="dark_gray"
+        script="${script} not found!"
+      fi
+```

From 53f1bd1eeb34914973dbee454e197f64c5fa816a Mon Sep 17 00:00:00 2001
From: Theoreticallyhugo <me@theoreticallyhugo.com>
Date: Wed, 4 Sep 2024 20:02:39 +0200
Subject: [PATCH 06/20] theming basis

---
 docs/dracula.md                            |  31 ------
 docs/theming/README.md                     |  51 ++++++++++
 docs/{theming.md => theming/catppuccin.md} | 112 +++++++++++++++++++--
 docs/theming/dracula.md                    |   0
 docs/theming/gruvbox.md                    |   0
 5 files changed, 153 insertions(+), 41 deletions(-)
 create mode 100644 docs/theming/README.md
 rename docs/{theming.md => theming/catppuccin.md} (59%)
 create mode 100644 docs/theming/dracula.md
 create mode 100644 docs/theming/gruvbox.md

diff --git a/docs/dracula.md b/docs/dracula.md
index 0d3222b5..4f466c6b 100644
--- a/docs/dracula.md
+++ b/docs/dracula.md
@@ -26,34 +26,3 @@
   IFS=' ' read -r -a plugins <<< $(get_tmux_option "@dracula-plugins" "battery network weather")
   show_empty_plugins=$(get_tmux_option "@dracula-show-empty-plugins" true)
 
-## widget colours
-```bash
-set -g "@dracula-cwd-colors" "dark_gray white"
-set -g "@dracula-fossil-colors" "green dark_gray"
-set -g "@dracula-git-colors" "green dark_gray"
-set -g "@dracula-hg-colors" "green dark_gray"
-set -g "@dracula-battery-colors" "pink dark_gray"
-set -g "@dracula-gpu-usage-colors" "pink dark_gray"
-set -g "@dracula-gpu-ram-usage-colors" "cyan dark_gray"
-set -g "@dracula-gpu-power-draw-colors" "green dark_gray"
-set -g "@dracula-cpu-usage-colors" "orange dark_gray"
-set -g "@dracula-ram-usage-colors" "cyan dark_gray"
-set -g "@dracula-tmux-ram-usage-colors" "cyan dark_gray"
-set -g "@dracula-network-colors" "cyan dark_gray"
-set -g "@dracula-network-bandwidth-colors" "cyan dark_gray"
-set -g "@dracula-network-ping-colors" "cyan dark_gray"
-set -g "@dracula-network-vpn-colors" "cyan dark_gray"
-set -g "@dracula-attached-clients-colors" "cyan dark_gray"
-set -g "@dracula-mpc-colors" "green dark_gray"
-set -g "@dracula-spotify-tui-colors" "green dark_gray"
-set -g "@dracula-playerctl-colors" "green dark_gray"
-set -g "@dracula-kubernetes-context-colors" "cyan dark_gray"
-set -g "@dracula-terraform-colors" "light_purple dark_gray"
-set -g "@dracula-continuum-colors" "cyan dark_gray"
-set -g "@dracula-weather-colors" "orange dark_gray"
-set -g "@dracula-time-colors" "dark_purple white"
-set -g "@dracula-synchronize-panes-colors" "cyan dark_gray"
-set -g "@dracula-libre-colors" "white dark_gray"
-set -g "@dracula-ssh-session-colors" "green dark_gray"
-```
-
diff --git a/docs/theming/README.md b/docs/theming/README.md
new file mode 100644
index 00000000..8a10881b
--- /dev/null
+++ b/docs/theming/README.md
@@ -0,0 +1,51 @@
+# widget color options
+
+set -g @dracula-custom-plugin-colors "cyan dark_gray"
+set -g @dracula-cwd-colors "dark_gray white"
+set -g @dracula-fossil-colors "green dark_gray"
+set -g @dracula-git-colors "green dark_gray"
+set -g @dracula-hg-colors "green dark_gray"
+set -g @dracula-battery-colors "pink dark_gray"
+set -g @dracula-gpu-usage-colors "pink dark_gray"
+set -g @dracula-gpu-ram-usage-colors "cyan dark_gray"
+set -g @dracula-gpu-power-draw-colors "green dark_gray"
+set -g @dracula-cpu-usage-colors "orange dark_gray"
+set -g @dracula-ram-usage-colors "cyan dark_gray"
+set -g @dracula-tmux-ram-usage-colors "cyan dark_gray"
+set -g @dracula-network-colors "cyan dark_gray"
+set -g @dracula-network-bandwidth-colors "cyan dark_gray"
+set -g @dracula-network-ping-colors "cyan dark_gray"
+set -g @dracula-network-vpn-colors "cyan dark_gray"
+set -g @dracula-attached-clients-colors "cyan dark_gray"
+set -g @dracula-mpc-colors "green dark_gray"
+set -g @dracula-spotify-tui-colors "green dark_gray"
+set -g @dracula-playerctl-colors "green dark_gray"
+set -g @dracula-kubernetes-context-colors "cyan dark_gray"
+set -g @dracula-terraform-colors "light_purple dark_gray"
+set -g @dracula-continuum-colors "cyan dark_gray"
+set -g @dracula-weather-colors "orange dark_gray"
+set -g @dracula-time-colors "dark_purple white"
+set -g @dracula-synchronize-panes-colors "cyan dark_gray"
+set -g @dracula-libre-colors "white dark_gray"
+set -g @dracula-ssh-session-colors "green dark_gray"
+
+
+# overriding colors
+if your tmux config is in `~/.config/tmux/`, then consider using the following:
+`set -g @dracula-colors "~/.config/tmux/colors.sh"`
+
+for a quick setup, fill the file with the following contents:
+```
+# simple catppuccin Color Pallette
+pink='#cba6f7'
+orange='#fab387'
+yellow='#f9e2af'
+green='#a6e3a1'
+cyan='#89dceb'
+light_purple='#b4befe'
+white='#cdd6f4'
+dark_gray='#313244'
+red='#f38ba8'
+gray='#45475a'
+dark_purple='#6c7086'
+```
diff --git a/docs/theming.md b/docs/theming/catppuccin.md
similarity index 59%
rename from docs/theming.md
rename to docs/theming/catppuccin.md
index c2bda106..eecc6540 100644
--- a/docs/theming.md
+++ b/docs/theming/catppuccin.md
@@ -24,22 +24,113 @@ alternatively use the full catppuccin color palette and customise the flags acco
 
 # catppuccin Color Pallette
 
-# TODO: check em all
+# latte
+```
+Rosewater='#dc8a78'
+Flamingo='#dd7878'
+Pink='#ea76cb'
+Mauve='#8839ef'
+Red='#d20f39'
+Maroon='#e64553'
+Peach='#fe640b'
+Yellow='#df8e1d'
+Green='#40a02b'
+Teal='#179299'
+Sky='#04a5e5'
+Sapphire='#209fb5'
+Blue='#1e66f5'
+Lavender='#7287fd'
+Text='#4c4f69'
+Subtext1='#5c5f77'
+Subtext0='#6c6f85'
+Overlay2='#7c7f93'
+Overlay1='#8c8fa1'
+Overlay0='#9ca0b0'
+Surface2='#acb0be'
+Surface1='#bcc0cc'
+Surface0='#ccd0da'
+Base='#eff1f5'
+Mantle='#e6e9ef'
+Crust='#dce0e8'
+```
+
+# frappe
+```
+Rosewater='#f2d5cf'
+Flamingo='#eebebe'
+Pink='#f4b8e4'
+Mauve='#ca9ee6'
+Red='#e78284'
+Maroon='#ea999c'
+Peach='#ef9f76'
+Yellow='#e5c890'
+Green='#a6d189'
+Teal='#81c8be'
+Sky='#99d1db'
+Sapphire='#85c1dc'
+Blue='#8caaee'
+Lavender='#babbf1'
+Text='#c6d0f5'
+Subtext1='#b5bfe2'
+Subtext0='#a5adce'
+Overlay2='#949cbb'
+Overlay1='#838ba7'
+Overlay0='#737994'
+Surface2='#626880'
+Surface1='#51576d'
+Surface0='#414559'
+Base='#303446'
+Mantle='#292c3c'
+Crust='#232634'
+```
+
+# macchiato
+```
+Rosewater='#f4dbd6'
+Flamingo='#f0c6c6'
+Pink='#f5bde6'
+Mauve='#c6a0f6'
+Red='#ed8796'
+Maroon='#ee99a0'
+Peach='#f5a97f'
+Yellow='#eed49f'
+Green='#a6da95'
+Teal='#8bd5ca'
+Sky='#91d7e3'
+Sapphire='#7dc4e4'
+Blue='#8aadf4'
+Lavender='#b7bdf8'
+Text='#cad3f5'
+Subtext1='#b8c0e0'
+Subtext0='#a5adcb'
+Overlay2='#939ab7'
+Overlay1='#8087a2'
+Overlay0='#6e738d'
+Surface2='#5b6078'
+Surface1='#494d64'
+Surface0='#363a4f'
+Base='#24273a'
+Mantle='#1e2030'
+Crust='#181926'
+```
+
+# mocha
+```
 Rosewater='#f5e0dc'
 Flamingo='#f2cdcd'
 Pink='#f5c2e7'
-Mauve='#cba6f7' # replace pink
+Mauve='#cba6f7'
 Red='#f38ba8'
 Maroon='#eba0ac'
-Peach='#fab387' # replacing orange
-Yellow='#f9e2af' # replacing yellow
-Green='#a6e3a1' # replacing green
+Peach='#fab387'
+Yellow='#f9e2af'
+Green='#a6e3a1'
 Teal='#94e2d5'
-Sky='#89dceb' # replacing cyan
+Sky='#89dceb'
 Sapphire='#74c7ec'
-Blue='#89b4fa' # replacing dark_purple
-Lavender='#b4befe' # replacing light_purple
-Text='#cdd6f4' # replacing white
+Blue='#89b4fa'
+Lavender='#b4befe'
+Text='#cdd6f4'
 Subtext1='#bac2de'
 Subtext0='#a6adc8'
 Overlay2='#9399b2'
@@ -47,10 +138,11 @@ Overlay1='#7f849c'
 Overlay0='#6c7086'
 Surface2='#585b70'
 Surface1='#45475a'
-Surface0='#313244' # replace dark_gray
+Surface0='#313244'
 Base='#1e1e2e'
 Mantle='#181825'
 Crust='#11111b'
+```
 
 # TODO: check em all
 set -g "@dracula-cwd-colors" "Surface0 Text"
diff --git a/docs/theming/dracula.md b/docs/theming/dracula.md
new file mode 100644
index 00000000..e69de29b
diff --git a/docs/theming/gruvbox.md b/docs/theming/gruvbox.md
new file mode 100644
index 00000000..e69de29b

From 025c8245cfc09047b0d70cd760648fb16536c30e Mon Sep 17 00:00:00 2001
From: Theoreticallyhugo <me@theoreticallyhugo.com>
Date: Sun, 8 Sep 2024 11:39:05 +0200
Subject: [PATCH 07/20] combining gpu bullet points

---
 README.md | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

diff --git a/README.md b/README.md
index 66be2875..55022bbe 100644
--- a/README.md
+++ b/README.md
@@ -26,10 +26,10 @@ Configuration and options can be found at [draculatheme.com/tmux](https://dracul
 - Refresh rate control
 - CPU usage (percentage or load average)
 - RAM usage (system and/or tmux server)
-- GPU usage
 - Custom status texts from external scripts
-- GPU VRAM usage
-- GPU power draw
+- GPU stats
+    - usage, power draw, and VRAM usage for NVIDIA on Linux
+    - usage, and power draw for MacOS. **requires sudo privileges**
 - Color code based on whether a prefix is active or not
 - List of windows with the current window highlighted
 - When prefix is enabled, the left status bar widget turns from green to yellow

From 2f61f06b08f4e7fd4d835e7bc62fcc376ae9034f Mon Sep 17 00:00:00 2001
From: Theoreticallyhugo <me@theoreticallyhugo.com>
Date: Fri, 20 Sep 2024 14:06:49 +0200
Subject: [PATCH 08/20] improve gpu documentation

---
 docs/misc.md | 38 +++++++++++++++++++++++++++++++++-----
 1 file changed, 33 insertions(+), 5 deletions(-)

diff --git a/docs/misc.md b/docs/misc.md
index cc3fbaba..ac69fab1 100644
--- a/docs/misc.md
+++ b/docs/misc.md
@@ -43,22 +43,50 @@ If you're using nerdfonts, try one of the following.
 ## gpu_info
 
 currently only works with NVIDIA gpus.
-"󰢮 "
 
-if your gpu is not recognised, force the script to run anyways.
-`set -g @dracula-ignore-lspci false`
+if your gpu is not recognised, force the script to assume a certain brands.
+```
+set -g @dracula-force-gpu "NVIDIA"
+```
+
+to display the used vram in percent (gigabyte is default unit):
+```
+set -g @dracula-gpu-vram-percent true
+```
+
+vram usage is displayed in gigabyte without decimal places per default. to change that behaviour, use the following options with the respective number of decimal places you'd like to get:
+```
+set -g @dracula-gpu-vram-used-accuracy ".2f"
+set -g @dracula-gpu-vram-total-accuracy ".1f"
+```
+
+to display the power usage in percent (watt is default unit):
+```
+set -g @dracula-gpu-power-percent true
+```
 
+default gpu info labels:
 ```
 set -g @dracula-gpu-usage-label "GPU"
 set -g @dracula-gpu-vram-label "VRAM"
 set -g @dracula-gpu-power-label "GPU"
 ```
 
-TODO:
+possible nerdfont settings for gpu info labels:
+```
+set -g @dracula-gpu-power-label "󰢮 "
+set -g @dracula-gpu-usage-label "󰢮 "
+set -g @dracula-gpu-vram-label "󰢮 "
+```
 
-- switch from `lspci` to `which -s nvidia-smi`
+TODO:
 - add support for amd without testing and clarify that this is an experimental feature! ask someone whos got an amd card to test it.
 
+nerdfont icons to consider:
+```
+"󰢮 "
+```
+
 `set -g @dracula-refresh-rate` affects this widget
 
 ## network

From b6a1b76d75eb3db5720f08976025c44e29491e75 Mon Sep 17 00:00:00 2001
From: Theoreticallyhugo <me@theoreticallyhugo.com>
Date: Fri, 20 Sep 2024 14:51:47 +0200
Subject: [PATCH 09/20] creating basic layout for all options

---
 docs/misc.md | 117 +++++++++++++++++++++++++++++++++++++++------------
 1 file changed, 90 insertions(+), 27 deletions(-)

diff --git a/docs/misc.md b/docs/misc.md
index ac69fab1..21804535 100644
--- a/docs/misc.md
+++ b/docs/misc.md
@@ -1,7 +1,3 @@
-"󰈀 "
-"󰣀 "
-"󱍢 "
-"󰉉 "
 
 ## left icon
 
@@ -22,27 +18,37 @@ besides formats, any other string can be used.
 
 ## continuum
 
+**TODO**
+
+```
 @dracula-continuum-mode
 @dracula-continuum-time-threshold
 @dracula-continuum-first-save
 @resurrect-dir
 @continuum-save-last-timestamp
 @continuum-save-interval
+```
+
+nerdfont icons to consider:
+`󰉉 `
 
 ## cpu_info
 
-Displays cpu usage in percent by default, but can display cpu load on linux, if the following flag is set to true:
-`set -g @dracula-cpu-display-load false`
+Displays cpu usage in percent by default, but can display cpu load on linux:
+`set -g @dracula-cpu-display-load true`
+
 Additionally the label can be set to whatever you'd like.
 `set -g @dracula-cpu-usage-label "CPU"`
-If you're using nerdfonts, try one of the following.
+
+nerdfont icons to consider:
 `   󰍛 󰘚 󰻟 󰻠 `
 
-`set -g @dracula-refresh-rate` affects this widget
+`set -g @dracula-refresh-rate 5` affects this widget
 
 ## gpu_info
 
-currently only works with NVIDIA gpus.
+full support for NVIDIA gpus.
+partial support for apple m-chips
 
 if your gpu is not recognised, force the script to assume a certain brands.
 ```
@@ -83,33 +89,58 @@ TODO:
 - add support for amd without testing and clarify that this is an experimental feature! ask someone whos got an amd card to test it.
 
 nerdfont icons to consider:
-```
-"󰢮 "
-```
+`󰢮  `
 
-`set -g @dracula-refresh-rate` affects this widget
+`set -g @dracula-refresh-rate 5` affects this widget
 
 ## network
 
 **This will only display the wifi you're connected to, if it provides internet access!**
 
+use different hosts to ping in order to check for a wifi or wired connection.
+if you frequently use networks without internet access, you can use local ip-addresses here to still display the connection.
+```
+set -g @dracula-network-hosts "1.1.1.1 8.8.8.8"
+```
+
+possible nerdfont settings for network info:
+```
 set -g @dracula-network-ethernet-label "󰈀 Eth"
 set -g @dracula-network-offline-label "󱍢 "
 set -g @dracula-network-wifi-label " "
-set -g @dracula-network-hosts "1.1.1.1 8.8.8.8"
+```
+
+nerdfont icons to consider:
+```
+ethernet: 󰈀 󰒪 󰒍 󰌗 󰌘
+offline: 󰖪  󱍢
+wifi:      󰖩  󰘊 󰒢
+```
+
+known issues:
+- if for some reason `iw` is only in the path for root and not the normal user, wifi connections will be considered ethernet connections.
 
 ## network bandwidth
 
+**TODO**
+
 tmux show-option -gqv "@dracula-network-bandwidth"
 
 ## network ping
 
-    pingserver=$(get_tmux_option "@dracula-ping-server" "google.com")
-
-RATE=$(get_tmux_option "@dracula-ping-rate" 5)
+to use a custom server:
+```
+set -g @dracula-ping-server "1.1.1.1"
+```
 
+to set the rate at which to ping the server (in seconds):
+```
+set -g @dracula-ping-rate 5
+```
 ## network vpn
 
+**TODO**
+
 set -g @dracula-network-vpn-verbose true
 
 TODO:
@@ -117,32 +148,64 @@ set -g @dracula-network-vpn-label
 
 ## playerctl
 
-RATE=$(get_tmux_option "@dracula-refresh-rate" 5)
-  FORMAT=$(get_tmux_option "@dracula-playerctl-format" "Now playing: {{ artist }} - {{ album }} - {{ title }}")
+to change the display format:
+```
+set -g @dracula-playerctl-format "Now playing: {{ artist }} - {{ album }} - {{ title }}"
+```
 
+`set -g @dracula-refresh-rate 5` affects this widget
 ## ram usage
 
-ram_label=$(get_tmux_option "@dracula-ram-usage-label" "RAM")
+possible nerdfont settings for ram usage:
+```
+set -g @dracula-ram-usage-label " "
+```
+
+nerdfont icons to consider:
+`   󰍛 󰘚 `
 
 ## ssh session
 
+to output nothing (and maybe hide) the widget when not connected via ssh:
+```
 set -g @dracula-show-ssh-only-when-connected true
+```
+
+nerdfont icons to consider:
+`󰣀 `
 
 ## spotify tui
 
-RATE=$(get_tmux_option "@dracula-refresh-rate" 5)
-  FORMAT=$(get_tmux_option "@dracula-spotify-tui-format" "%f %s %t - %a")
-max_len=$(get_tmux_option "@dracula-spotify-tui-max-len" 0)
+to format the display format:
+```
+set -g @dracula-spotify-tui-format "%f %s %t - %a"
+```
+
+to limit the maximum length (0 means unlimited length):
+```
+set -g @dracula-spotify-tui-max-len 30
+```
+
+`set -g @dracula-refresh-rate 5` affects this widget
 
 ## synchronise panes
 
+**TODO**
+
+```
 current_synchronize_panes_status=$(get_tmux_window_option "synchronize-panes" "off")
-  RATE=$(get_tmux_option "@dracula-refresh-rate" 5)
+```
 
+`set -g @dracula-refresh-rate 5` affects this widget
 ## terraform
 
-RATE=$(get_tmux_option "@dracula-refresh-rate" 5)
-
+`set -g @dracula-refresh-rate 5` affects this widget
 ## tmux ram usage
 
-ram_label=$(get_tmux_option "@dracula-tmux-ram-usage-label" "MEM")
+possible nerdfont settings for tmux ram usage:
+```
+@dracula-tmux-ram-usage-label " "
+```
+
+nerdfont icons to consider:
+`   󰍛 󰘚 `

From cf09f59fbae40306210a8d03987f6e501b0ce65f Mon Sep 17 00:00:00 2001
From: Theoreticallyhugo <me@theoreticallyhugo.com>
Date: Sat, 21 Sep 2024 20:31:01 +0200
Subject: [PATCH 10/20] formatting and tidying

---
 docs/misc.md | 67 +++++++++++++++++++++++++++++++---------------------
 1 file changed, 40 insertions(+), 27 deletions(-)

diff --git a/docs/misc.md b/docs/misc.md
index 21804535..38a06bf0 100644
--- a/docs/misc.md
+++ b/docs/misc.md
@@ -1,18 +1,22 @@
 
 ## left icon
 
-The left icon can be set to anything static you'd like.
-However if you use tmux on multiple machines, it may be helpful to display the hostname.
-If you use multiple sessions simultaneously it can be good to name them and have the name in the left icon.
-the following example uses formatting to display "hostname | session_name":
-`set -g @dracula-show-left-icon "#h | #S"`
+- The left icon can be set to anything static you'd like.
+- However if you use tmux on multiple machines, it may be helpful to display the hostname.
+- If you use multiple sessions simultaneously it can be good to name them and have the name in the left icon.
 
+the following example uses formatting to display "hostname | session_name":
+```
+set -g @dracula-show-left-icon "#h | #S"
+```
 formats:
-`#H: Hostname of local host`
-`#h: Hostname of local host (no domain name)`
-`#S: name of session` -> alias trs to tmux rename-session
+```
+#H: Hostname of local host
+#h: Hostname of local host (no domain name)
+#S: name of session -> suggestion: alias trs to tmux rename-session
+```
 more formats can be found here, though those without a shorthand like #H need to be used like #{host}, which is equivalent.
-[tmux(1) - OpenBSD manual pages](https://man.openbsd.org/tmux.1#FORMATS)
+[reference: tmux(1) - OpenBSD manual pages](https://man.openbsd.org/tmux.1#FORMATS)
 
 besides formats, any other string can be used.
 
@@ -30,25 +34,33 @@ besides formats, any other string can be used.
 ```
 
 nerdfont icons to consider:
-`󰉉 `
+```
+󰉉
+```
 
 ## cpu_info
 
 Displays cpu usage in percent by default, but can display cpu load on linux:
-`set -g @dracula-cpu-display-load true`
+```
+set -g @dracula-cpu-display-load true
+```
 
-Additionally the label can be set to whatever you'd like.
-`set -g @dracula-cpu-usage-label "CPU"`
+possible nerdfont settings for cpu usage label:
+```
+set -g @dracula-cpu-usage-label " "
+```
 
 nerdfont icons to consider:
-`   󰍛 󰘚 󰻟 󰻠 `
+```
+   󰍛 󰘚 󰻟 󰻠
+```
 
 `set -g @dracula-refresh-rate 5` affects this widget
 
 ## gpu_info
 
-full support for NVIDIA gpus.
-partial support for apple m-chips
+- full support for NVIDIA gpus.
+- partial support for apple m-chips.
 
 if your gpu is not recognised, force the script to assume a certain brands.
 ```
@@ -71,13 +83,6 @@ to display the power usage in percent (watt is default unit):
 set -g @dracula-gpu-power-percent true
 ```
 
-default gpu info labels:
-```
-set -g @dracula-gpu-usage-label "GPU"
-set -g @dracula-gpu-vram-label "VRAM"
-set -g @dracula-gpu-power-label "GPU"
-```
-
 possible nerdfont settings for gpu info labels:
 ```
 set -g @dracula-gpu-power-label "󰢮 "
@@ -89,7 +94,9 @@ TODO:
 - add support for amd without testing and clarify that this is an experimental feature! ask someone whos got an amd card to test it.
 
 nerdfont icons to consider:
-`󰢮  `
+```
+󰢮
+```
 
 `set -g @dracula-refresh-rate 5` affects this widget
 
@@ -162,7 +169,9 @@ set -g @dracula-ram-usage-label " "
 ```
 
 nerdfont icons to consider:
-`   󰍛 󰘚 `
+```
+   󰍛 󰘚
+```
 
 ## ssh session
 
@@ -172,7 +181,9 @@ set -g @dracula-show-ssh-only-when-connected true
 ```
 
 nerdfont icons to consider:
-`󰣀 `
+```
+󰣀
+```
 
 ## spotify tui
 
@@ -208,4 +219,6 @@ possible nerdfont settings for tmux ram usage:
 ```
 
 nerdfont icons to consider:
-`   󰍛 󰘚 `
+```
+   󰍛 󰘚
+```

From 89f4f942cf9349703f03882593080c2602a79ec5 Mon Sep 17 00:00:00 2001
From: Theoreticallyhugo <me@theoreticallyhugo.com>
Date: Sat, 21 Sep 2024 22:36:30 +0200
Subject: [PATCH 11/20] major layout changes and documentation improvements

---
 docs/README.md         | 373 +++++++++++++++++++++++++++++++++++++++++
 docs/battery.md        |  11 --
 docs/custom_scripts.md |  15 --
 docs/dracula.md        |  28 ----
 docs/misc.md           | 224 -------------------------
 docs/tmux_conf.md      |   1 -
 6 files changed, 373 insertions(+), 279 deletions(-)
 create mode 100644 docs/README.md
 delete mode 100644 docs/battery.md
 delete mode 100644 docs/custom_scripts.md
 delete mode 100644 docs/dracula.md
 delete mode 100644 docs/misc.md
 delete mode 100644 docs/tmux_conf.md

diff --git a/docs/README.md b/docs/README.md
new file mode 100644
index 00000000..7102cddd
--- /dev/null
+++ b/docs/README.md
@@ -0,0 +1,373 @@
+# misc --- sort me **TODO**
+  IFS=' ' read -r -a plugins <<< $(get_tmux_option "@dracula-plugins" "battery network weather")
+set -g @dracula-show-empty-plugins true
+
+set -g @dracula-show-flags false
+set -g @dracula-border-contrast false
+set -g @dracula-refresh-rate 5
+set -g @dracula-time-format ""
+set -g @dracula-show-ssh-session-port false
+set -g @dracula-show-libreview false
+# powerline
+set -g @dracula-show-powerline false
+set -g @dracula-show-left-sep 
+set -g @dracula-show-right-sep 
+# left icon
+- The left icon can be set to anything static you'd like.
+- However if you use tmux on multiple machines, it may be helpful to display the hostname.
+- If you use multiple sessions simultaneously it can be good to name them and have the name in the left icon.
+
+the following example uses formatting to display "hostname | session_name":
+```
+set -g @dracula-show-left-icon "#h | #S"
+```
+formats:
+```
+#H: Hostname of local host
+#h: Hostname of local host (no domain name)
+#S: name of session -> suggestion: alias trs to tmux rename-session
+```
+more formats can be found here, though those without a shorthand like #H need to be used like #{host}, which is equivalent.
+[reference: tmux(1) - OpenBSD manual pages](https://man.openbsd.org/tmux.1#FORMATS)
+
+besides formats, any other string can be used.
+
+additionally the left icons padding can be set like so:
+```
+set -g @dracula-left-icon-padding 1
+```
+# right widgets
+## attached clients
+this widget provides the number of clients attached to the current tmux session.
+
+set the number of clients attached, required to show any output. if less clients are attached, the widget shows no output.
+```
+set -g @dracula-clients-minimum 1
+```
+set the labels used for singular and plural clients.
+```
+set -g @dracula-clients-plural "clients"
+set -g @dracula-clients-singular "client"
+```
+
+`set -g @dracula-refresh-rate 5` affects this widget
+## battery
+this widget provides information about the current charge of the battery, whether it is attached to a powersupply and charging from it, or running off the powersupply without charging. it also detects desktop pcs having no battery.
+
+Display any icon for the battery you'd like with:
+```
+set -g @dracula-battery-label "♥ "
+```
+
+to use nothing but nerdfont icons informing you about the current state, use the following,
+which will display the battery charge and whether its charging (or just drawing from AC) as nerdfont icons.
+```
+set -g @dracula-battery-label false
+set -g @dracula-show-battery-status true
+```
+if you have no battery and would like the widget to hide in that case, set the following:
+```
+set -g @dracula-no-battery-label false
+```
+alternatively, if you have no battery and would like a nerdfont icon to indicate that, consider setting the following:
+```
+set -g @dracula-no-battery-label " "
+```
+## continuum
+**TODO**
+
+```
+@dracula-continuum-mode
+@dracula-continuum-time-threshold
+@dracula-continuum-first-save
+@resurrect-dir
+@continuum-save-last-timestamp
+@continuum-save-interval
+```
+
+nerdfont icons to consider:
+```
+󰉉
+```
+## cpu info
+this widget displays the cpu usage in percent by default, but can display cpu load on linux:
+```
+set -g @dracula-cpu-display-load true
+```
+
+possible nerdfont settings for cpu usage label:
+```
+set -g @dracula-cpu-usage-label " "
+```
+
+nerdfont icons to consider:
+```
+   󰍛 󰘚 󰻟 󰻠
+```
+
+`set -g @dracula-refresh-rate 5` affects this widget
+## current working directory
+this widget displays the path of the current working directory
+## fossil
+**TODO**
+## git
+this widget displays info about the current git repository.
+
+**TODO**
+```
+set -g @dracula-git-disable-status "false"
+set -g @dracula-git-show-current-symbol "✓"
+set -g @dracula-git-show-diff-symbol "!"
+set -g @dracula-git-no-repo-message ""
+set -g @dracula-git-no-untracked-files "false"
+set -g @dracula-git-show-remote-status "false"
+```
+## gpu info
+these widgets display the current computational, ram, and power usage of installed graphics cards.
+
+hardware support:
+- full support for NVIDIA gpus.
+- partial support for apple m-chips.
+
+if your gpu is not recognised, force the script to assume a certain brands.
+```
+set -g @dracula-force-gpu "NVIDIA"
+```
+
+to display the used vram in percent (gigabyte is default unit):
+```
+set -g @dracula-gpu-vram-percent true
+```
+
+vram usage is displayed in gigabyte without decimal places per default. to change that behaviour, use the following options with the respective number of decimal places you'd like to get:
+```
+set -g @dracula-gpu-vram-used-accuracy ".2f"
+set -g @dracula-gpu-vram-total-accuracy ".1f"
+```
+
+to display the power usage in percent (watt is default unit):
+```
+set -g @dracula-gpu-power-percent true
+```
+
+possible nerdfont settings for gpu info labels:
+```
+set -g @dracula-gpu-power-label "󰢮 "
+set -g @dracula-gpu-usage-label "󰢮 "
+set -g @dracula-gpu-vram-label "󰢮 "
+```
+
+TODO:
+- add support for amd without testing and clarify that this is an experimental feature! ask someone whos got an amd card to test it.
+
+nerdfont icons to consider:
+```
+󰢮
+```
+
+`set -g @dracula-refresh-rate 5` affects this widget
+## mercurial
+this widget displays info about the current mercurial repository.
+
+**TODO**
+```
+set -g @dracula-hg-disable-status "false"
+set -g @dracula-hg-show-current-symbol "✓"
+set -g @dracula-hg-show-diff-symbol "!"
+set -g @dracula-hg-no-repo-message ""
+set -g @dracula-hg-no-untracked-files "false"
+```
+## kubernetes context
+set -g @dracula-kubernetes-context-label ""
+set -g @dracula-kubernetes-eks-hide-arn false
+set -g @dracula-kubernetes-eks-extract-account false
+set -g @dracula-kubernetes-hide-user false
+
+hide_arn_from_cluster=$1
+extract_account=$2
+hide_user=$3
+just_current_context=$4
+label=$5
+## libre
+This script retrieves and displays continuous glucose monitoring (CGM) data from the LibreView API.
+It caches the data to minimize API requests and displays the latest glucose level along with a trend indicator in a Tmux status bar.
+## mpc
+this widget displays music information provided by mpc.
+
+to format the display format:
+```
+set -g @dracula-mpc-format "%title% - %artist%"
+```
+
+`set -g @dracula-refresh-rate 5` affects this widget
+## network
+this widget displays one of three states: offline, ethernet connected, or wifi connected.
+however, per default **this will only display the wifi you're connected to, if it provides internet access!**
+
+you can use different hosts to ping in order to check for a wifi or wired connection.
+if you frequently use networks without internet access, you can use local ip-addresses here to still display the connection.
+```
+set -g @dracula-network-hosts "1.1.1.1 8.8.8.8"
+```
+
+possible nerdfont settings for network info:
+```
+set -g @dracula-network-ethernet-label "󰈀 Eth"
+set -g @dracula-network-offline-label "󱍢 "
+set -g @dracula-network-wifi-label " "
+```
+
+nerdfont icons to consider:
+```
+ethernet: 󰈀 󰒪 󰒍 󰌗 󰌘
+offline: 󰖪  󱍢
+wifi:      󰖩  󰘊 󰒢
+```
+
+known issues:
+- if for some reason `iw` is only in the path for root and not the normal user, wifi connections will be considered ethernet connections.
+## network bandwidth
+this widget gives the currently used up and download speeds per second for one interface.
+
+to set a specific network interface you'd like to monitor, used:
+```
+set -g @dracula-network-bandwidth "eno0"
+```
+to display the interface name alongside the speeds, set:
+```
+set -g @dracula-network-bandwidth-show-interface true
+```
+per default, this widget checks the speeds as frequently as it can. to set longer intervals, use the following:
+```
+set -g @dracula-network-bandwidth-interval 5
+```
+## network ping
+this widget displays the current ping to a specific server.
+
+to use a custom server:
+```
+set -g @dracula-ping-server "1.1.1.1"
+```
+
+to set the rate at which to ping the server (in seconds):
+```
+set -g @dracula-ping-rate 5
+```
+## network vpn
+**TODO**
+
+set -g @dracula-network-vpn-verbose true
+
+TODO:
+set -g @dracula-network-vpn-label
+## playerctl
+this widget displays music information provided by playerctl.
+
+to change the display format set:
+```
+set -g @dracula-playerctl-format "Now playing: {{ artist }} - {{ album }} - {{ title }}"
+```
+
+`set -g @dracula-refresh-rate 5` affects this widget
+## ram usage
+this widget displays the currently used ram as GB per GB.
+
+possible nerdfont settings for ram usage:
+```
+set -g @dracula-ram-usage-label " "
+```
+
+nerdfont icons to consider:
+```
+   󰍛 󰘚
+```
+## spotify tui
+this widget displays music information provided by spotify-tui. spotify-tui must be installed to use this widget.
+
+to format the display format:
+```
+set -g @dracula-spotify-tui-format "%f %s %t - %a"
+```
+
+to limit the maximum length (0 means unlimited length):
+```
+set -g @dracula-spotify-tui-max-len 30
+```
+
+`set -g @dracula-refresh-rate 5` affects this widget
+## ssh session
+this widget displays the current username@host combination, both of the local machine as well as when connected via ssh.
+
+to output nothing (and maybe hide the widget) when not connected via ssh:
+```
+set -g @dracula-show-ssh-only-when-connected true
+```
+
+nerdfont icons to consider:
+```
+󰣀
+```
+## synchronise panes
+this widget displays whether the tmux panes are currently synchronised or not.
+
+to change the label:
+```
+set -g @dracula-synchronize-panes-label "Sync"
+```
+
+`set -g @dracula-refresh-rate 5` affects this widget
+## terraform
+**TODO**
+
+```
+set -g @dracula-terraform-label ""
+```
+
+`set -g @dracula-refresh-rate 5` affects this widget
+## time
+**TODO**
+```
+set -g @dracula-military-time false
+set -g @dracula-set-timezone ""
+set -g @dracula-show-timezone true
+set -g @dracula-day-month false
+```
+## tmux ram usage
+this widget displays the ram currently used by tmux.
+
+possible nerdfont settings for tmux ram usage:
+```
+@dracula-tmux-ram-usage-label " "
+```
+
+nerdfont icons to consider:
+```
+   󰍛 󰘚
+```
+## weather
+**TODO**
+
+```
+set -g @dracula-show-fahrenheit true
+set -g @dracula-show-location true
+set -g @dracula-fixed-location
+```
+
+      script="#($current_dir/weather_wrapper.sh $show_fahrenheit $show_location '$fixed_location')"
+## custom scripts
+**TODO**
+
+```
+  for plugin in "${plugins[@]}"; do
+
+    if case $plugin in custom:*) true;; *) false;; esac; then
+      script=${plugin#"custom:"}
+      if [[ -x "${current_dir}/${script}" ]]; then
+        IFS=' ' read -r -a colors <<<$(get_tmux_option "@dracula-custom-plugin-colors" "cyan dark_gray")
+        script="#($current_dir/${script})"
+      else
+        colors[0]="red"
+        colors[1]="dark_gray"
+        script="${script} not found!"
+      fi
+```
diff --git a/docs/battery.md b/docs/battery.md
deleted file mode 100644
index d6d22374..00000000
--- a/docs/battery.md
+++ /dev/null
@@ -1,11 +0,0 @@
-# battery display
-
-Display any icon for the battery you'd like with:
-`set -g @dracula-battery-label "put_your_label_here"`
-
-Alternatively set:
-```
-set -g @dracula-battery-label false
-set -g @dracula-show-battery-status true
-```
-Which will display the battery charge and whether its charging (or just drawing from AC) as nerdfont icons.
diff --git a/docs/custom_scripts.md b/docs/custom_scripts.md
deleted file mode 100644
index 36657200..00000000
--- a/docs/custom_scripts.md
+++ /dev/null
@@ -1,15 +0,0 @@
-# document this
-```
-  for plugin in "${plugins[@]}"; do
-
-    if case $plugin in custom:*) true;; *) false;; esac; then
-      script=${plugin#"custom:"}
-      if [[ -x "${current_dir}/${script}" ]]; then
-        IFS=' ' read -r -a colors <<<$(get_tmux_option "@dracula-custom-plugin-colors" "cyan dark_gray")
-        script="#($current_dir/${script})"
-      else
-        colors[0]="red"
-        colors[1]="dark_gray"
-        script="${script} not found!"
-      fi
-```
diff --git a/docs/dracula.md b/docs/dracula.md
deleted file mode 100644
index 4f466c6b..00000000
--- a/docs/dracula.md
+++ /dev/null
@@ -1,28 +0,0 @@
-  # set configuration option variables
-  show_kubernetes_context_label=$(get_tmux_option "@dracula-kubernetes-context-label" "")
-  eks_hide_arn=$(get_tmux_option "@dracula-kubernetes-eks-hide-arn" false)
-  eks_extract_account=$(get_tmux_option "@dracula-kubernetes-eks-extract-account" false)
-  hide_kubernetes_user=$(get_tmux_option "@dracula-kubernetes-hide-user" false)
-  terraform_label=$(get_tmux_option "@dracula-terraform-label" "")
-  show_fahrenheit=$(get_tmux_option "@dracula-show-fahrenheit" true)
-  show_location=$(get_tmux_option "@dracula-show-location" true)
-  fixed_location=$(get_tmux_option "@dracula-fixed-location")
-  show_powerline=$(get_tmux_option "@dracula-show-powerline" false)
-  show_flags=$(get_tmux_option "@dracula-show-flags" false)
-  show_left_icon=$(get_tmux_option "@dracula-show-left-icon" smiley)
-  show_left_icon_padding=$(get_tmux_option "@dracula-left-icon-padding" 1)
-  show_military=$(get_tmux_option "@dracula-military-time" false)
-  timezone=$(get_tmux_option "@dracula-set-timezone" "")
-  show_timezone=$(get_tmux_option "@dracula-show-timezone" true)
-  show_left_sep=$(get_tmux_option "@dracula-show-left-sep" )
-  show_right_sep=$(get_tmux_option "@dracula-show-right-sep" )
-  show_border_contrast=$(get_tmux_option "@dracula-border-contrast" false)
-  show_day_month=$(get_tmux_option "@dracula-day-month" false)
-  show_refresh=$(get_tmux_option "@dracula-refresh-rate" 5)
-  show_synchronize_panes_label=$(get_tmux_option "@dracula-synchronize-panes-label" "Sync")
-  time_format=$(get_tmux_option "@dracula-time-format" "")
-  show_ssh_session_port=$(get_tmux_option "@dracula-show-ssh-session-port" false)
-  show_libreview=$(get_tmux_option "@dracula-show-libreview" false)
-  IFS=' ' read -r -a plugins <<< $(get_tmux_option "@dracula-plugins" "battery network weather")
-  show_empty_plugins=$(get_tmux_option "@dracula-show-empty-plugins" true)
-
diff --git a/docs/misc.md b/docs/misc.md
deleted file mode 100644
index 38a06bf0..00000000
--- a/docs/misc.md
+++ /dev/null
@@ -1,224 +0,0 @@
-
-## left icon
-
-- The left icon can be set to anything static you'd like.
-- However if you use tmux on multiple machines, it may be helpful to display the hostname.
-- If you use multiple sessions simultaneously it can be good to name them and have the name in the left icon.
-
-the following example uses formatting to display "hostname | session_name":
-```
-set -g @dracula-show-left-icon "#h | #S"
-```
-formats:
-```
-#H: Hostname of local host
-#h: Hostname of local host (no domain name)
-#S: name of session -> suggestion: alias trs to tmux rename-session
-```
-more formats can be found here, though those without a shorthand like #H need to be used like #{host}, which is equivalent.
-[reference: tmux(1) - OpenBSD manual pages](https://man.openbsd.org/tmux.1#FORMATS)
-
-besides formats, any other string can be used.
-
-## continuum
-
-**TODO**
-
-```
-@dracula-continuum-mode
-@dracula-continuum-time-threshold
-@dracula-continuum-first-save
-@resurrect-dir
-@continuum-save-last-timestamp
-@continuum-save-interval
-```
-
-nerdfont icons to consider:
-```
-󰉉
-```
-
-## cpu_info
-
-Displays cpu usage in percent by default, but can display cpu load on linux:
-```
-set -g @dracula-cpu-display-load true
-```
-
-possible nerdfont settings for cpu usage label:
-```
-set -g @dracula-cpu-usage-label " "
-```
-
-nerdfont icons to consider:
-```
-   󰍛 󰘚 󰻟 󰻠
-```
-
-`set -g @dracula-refresh-rate 5` affects this widget
-
-## gpu_info
-
-- full support for NVIDIA gpus.
-- partial support for apple m-chips.
-
-if your gpu is not recognised, force the script to assume a certain brands.
-```
-set -g @dracula-force-gpu "NVIDIA"
-```
-
-to display the used vram in percent (gigabyte is default unit):
-```
-set -g @dracula-gpu-vram-percent true
-```
-
-vram usage is displayed in gigabyte without decimal places per default. to change that behaviour, use the following options with the respective number of decimal places you'd like to get:
-```
-set -g @dracula-gpu-vram-used-accuracy ".2f"
-set -g @dracula-gpu-vram-total-accuracy ".1f"
-```
-
-to display the power usage in percent (watt is default unit):
-```
-set -g @dracula-gpu-power-percent true
-```
-
-possible nerdfont settings for gpu info labels:
-```
-set -g @dracula-gpu-power-label "󰢮 "
-set -g @dracula-gpu-usage-label "󰢮 "
-set -g @dracula-gpu-vram-label "󰢮 "
-```
-
-TODO:
-- add support for amd without testing and clarify that this is an experimental feature! ask someone whos got an amd card to test it.
-
-nerdfont icons to consider:
-```
-󰢮
-```
-
-`set -g @dracula-refresh-rate 5` affects this widget
-
-## network
-
-**This will only display the wifi you're connected to, if it provides internet access!**
-
-use different hosts to ping in order to check for a wifi or wired connection.
-if you frequently use networks without internet access, you can use local ip-addresses here to still display the connection.
-```
-set -g @dracula-network-hosts "1.1.1.1 8.8.8.8"
-```
-
-possible nerdfont settings for network info:
-```
-set -g @dracula-network-ethernet-label "󰈀 Eth"
-set -g @dracula-network-offline-label "󱍢 "
-set -g @dracula-network-wifi-label " "
-```
-
-nerdfont icons to consider:
-```
-ethernet: 󰈀 󰒪 󰒍 󰌗 󰌘
-offline: 󰖪  󱍢
-wifi:      󰖩  󰘊 󰒢
-```
-
-known issues:
-- if for some reason `iw` is only in the path for root and not the normal user, wifi connections will be considered ethernet connections.
-
-## network bandwidth
-
-**TODO**
-
-tmux show-option -gqv "@dracula-network-bandwidth"
-
-## network ping
-
-to use a custom server:
-```
-set -g @dracula-ping-server "1.1.1.1"
-```
-
-to set the rate at which to ping the server (in seconds):
-```
-set -g @dracula-ping-rate 5
-```
-## network vpn
-
-**TODO**
-
-set -g @dracula-network-vpn-verbose true
-
-TODO:
-set -g @dracula-network-vpn-label
-
-## playerctl
-
-to change the display format:
-```
-set -g @dracula-playerctl-format "Now playing: {{ artist }} - {{ album }} - {{ title }}"
-```
-
-`set -g @dracula-refresh-rate 5` affects this widget
-## ram usage
-
-possible nerdfont settings for ram usage:
-```
-set -g @dracula-ram-usage-label " "
-```
-
-nerdfont icons to consider:
-```
-   󰍛 󰘚
-```
-
-## ssh session
-
-to output nothing (and maybe hide) the widget when not connected via ssh:
-```
-set -g @dracula-show-ssh-only-when-connected true
-```
-
-nerdfont icons to consider:
-```
-󰣀
-```
-
-## spotify tui
-
-to format the display format:
-```
-set -g @dracula-spotify-tui-format "%f %s %t - %a"
-```
-
-to limit the maximum length (0 means unlimited length):
-```
-set -g @dracula-spotify-tui-max-len 30
-```
-
-`set -g @dracula-refresh-rate 5` affects this widget
-
-## synchronise panes
-
-**TODO**
-
-```
-current_synchronize_panes_status=$(get_tmux_window_option "synchronize-panes" "off")
-```
-
-`set -g @dracula-refresh-rate 5` affects this widget
-## terraform
-
-`set -g @dracula-refresh-rate 5` affects this widget
-## tmux ram usage
-
-possible nerdfont settings for tmux ram usage:
-```
-@dracula-tmux-ram-usage-label " "
-```
-
-nerdfont icons to consider:
-```
-   󰍛 󰘚
-```
diff --git a/docs/tmux_conf.md b/docs/tmux_conf.md
deleted file mode 100644
index 64fc860a..00000000
--- a/docs/tmux_conf.md
+++ /dev/null
@@ -1 +0,0 @@
-# a sensible tmux config with defaults for a nerdfont user

From bf4d918ca00102ab44903a60896c3c1c581b4cfa Mon Sep 17 00:00:00 2001
From: Theoreticallyhugo <me@theoreticallyhugo.com>
Date: Sat, 21 Sep 2024 22:37:25 +0200
Subject: [PATCH 12/20] changed dir name for clarification

---
 docs/{theming => colour_theming}/README.md     | 0
 docs/{theming => colour_theming}/catppuccin.md | 0
 docs/{theming => colour_theming}/dracula.md    | 0
 docs/{theming => colour_theming}/gruvbox.md    | 0
 4 files changed, 0 insertions(+), 0 deletions(-)
 rename docs/{theming => colour_theming}/README.md (100%)
 rename docs/{theming => colour_theming}/catppuccin.md (100%)
 rename docs/{theming => colour_theming}/dracula.md (100%)
 rename docs/{theming => colour_theming}/gruvbox.md (100%)

diff --git a/docs/theming/README.md b/docs/colour_theming/README.md
similarity index 100%
rename from docs/theming/README.md
rename to docs/colour_theming/README.md
diff --git a/docs/theming/catppuccin.md b/docs/colour_theming/catppuccin.md
similarity index 100%
rename from docs/theming/catppuccin.md
rename to docs/colour_theming/catppuccin.md
diff --git a/docs/theming/dracula.md b/docs/colour_theming/dracula.md
similarity index 100%
rename from docs/theming/dracula.md
rename to docs/colour_theming/dracula.md
diff --git a/docs/theming/gruvbox.md b/docs/colour_theming/gruvbox.md
similarity index 100%
rename from docs/theming/gruvbox.md
rename to docs/colour_theming/gruvbox.md

From c09343a101539be1bcadcdad70c98c927edd48cc Mon Sep 17 00:00:00 2001
From: Theoreticallyhugo <me@theoreticallyhugo.com>
Date: Fri, 11 Oct 2024 16:38:19 +0200
Subject: [PATCH 13/20] moved color theming to respective branch

---
 docs/colour_theming/README.md     |  51 ---------
 docs/colour_theming/catppuccin.md | 174 ------------------------------
 docs/colour_theming/dracula.md    |   0
 docs/colour_theming/gruvbox.md    |   0
 4 files changed, 225 deletions(-)
 delete mode 100644 docs/colour_theming/README.md
 delete mode 100644 docs/colour_theming/catppuccin.md
 delete mode 100644 docs/colour_theming/dracula.md
 delete mode 100644 docs/colour_theming/gruvbox.md

diff --git a/docs/colour_theming/README.md b/docs/colour_theming/README.md
deleted file mode 100644
index 8a10881b..00000000
--- a/docs/colour_theming/README.md
+++ /dev/null
@@ -1,51 +0,0 @@
-# widget color options
-
-set -g @dracula-custom-plugin-colors "cyan dark_gray"
-set -g @dracula-cwd-colors "dark_gray white"
-set -g @dracula-fossil-colors "green dark_gray"
-set -g @dracula-git-colors "green dark_gray"
-set -g @dracula-hg-colors "green dark_gray"
-set -g @dracula-battery-colors "pink dark_gray"
-set -g @dracula-gpu-usage-colors "pink dark_gray"
-set -g @dracula-gpu-ram-usage-colors "cyan dark_gray"
-set -g @dracula-gpu-power-draw-colors "green dark_gray"
-set -g @dracula-cpu-usage-colors "orange dark_gray"
-set -g @dracula-ram-usage-colors "cyan dark_gray"
-set -g @dracula-tmux-ram-usage-colors "cyan dark_gray"
-set -g @dracula-network-colors "cyan dark_gray"
-set -g @dracula-network-bandwidth-colors "cyan dark_gray"
-set -g @dracula-network-ping-colors "cyan dark_gray"
-set -g @dracula-network-vpn-colors "cyan dark_gray"
-set -g @dracula-attached-clients-colors "cyan dark_gray"
-set -g @dracula-mpc-colors "green dark_gray"
-set -g @dracula-spotify-tui-colors "green dark_gray"
-set -g @dracula-playerctl-colors "green dark_gray"
-set -g @dracula-kubernetes-context-colors "cyan dark_gray"
-set -g @dracula-terraform-colors "light_purple dark_gray"
-set -g @dracula-continuum-colors "cyan dark_gray"
-set -g @dracula-weather-colors "orange dark_gray"
-set -g @dracula-time-colors "dark_purple white"
-set -g @dracula-synchronize-panes-colors "cyan dark_gray"
-set -g @dracula-libre-colors "white dark_gray"
-set -g @dracula-ssh-session-colors "green dark_gray"
-
-
-# overriding colors
-if your tmux config is in `~/.config/tmux/`, then consider using the following:
-`set -g @dracula-colors "~/.config/tmux/colors.sh"`
-
-for a quick setup, fill the file with the following contents:
-```
-# simple catppuccin Color Pallette
-pink='#cba6f7'
-orange='#fab387'
-yellow='#f9e2af'
-green='#a6e3a1'
-cyan='#89dceb'
-light_purple='#b4befe'
-white='#cdd6f4'
-dark_gray='#313244'
-red='#f38ba8'
-gray='#45475a'
-dark_purple='#6c7086'
-```
diff --git a/docs/colour_theming/catppuccin.md b/docs/colour_theming/catppuccin.md
deleted file mode 100644
index eecc6540..00000000
--- a/docs/colour_theming/catppuccin.md
+++ /dev/null
@@ -1,174 +0,0 @@
-# drac to cat
-
-if your tmux config is in `~/.config/tmux/`, then consider using the following:
-`set -g @dracula-colors "~/.config/tmux/colors.sh"`
-
-for a quick setup, fill the file with the following contents:
-```
-# simple catppuccin Color Pallette
-pink='#cba6f7'
-orange='#fab387'
-yellow='#f9e2af'
-green='#a6e3a1'
-cyan='#89dceb'
-light_purple='#b4befe'
-white='#cdd6f4'
-dark_gray='#313244'
-red='#f38ba8'
-gray='#45475a'
-dark_purple='#6c7086'
-```
-
-
-alternatively use the full catppuccin color palette and customise the flags accordingly
-
-# catppuccin Color Pallette
-
-# latte
-```
-Rosewater='#dc8a78'
-Flamingo='#dd7878'
-Pink='#ea76cb'
-Mauve='#8839ef'
-Red='#d20f39'
-Maroon='#e64553'
-Peach='#fe640b'
-Yellow='#df8e1d'
-Green='#40a02b'
-Teal='#179299'
-Sky='#04a5e5'
-Sapphire='#209fb5'
-Blue='#1e66f5'
-Lavender='#7287fd'
-Text='#4c4f69'
-Subtext1='#5c5f77'
-Subtext0='#6c6f85'
-Overlay2='#7c7f93'
-Overlay1='#8c8fa1'
-Overlay0='#9ca0b0'
-Surface2='#acb0be'
-Surface1='#bcc0cc'
-Surface0='#ccd0da'
-Base='#eff1f5'
-Mantle='#e6e9ef'
-Crust='#dce0e8'
-```
-
-# frappe
-```
-Rosewater='#f2d5cf'
-Flamingo='#eebebe'
-Pink='#f4b8e4'
-Mauve='#ca9ee6'
-Red='#e78284'
-Maroon='#ea999c'
-Peach='#ef9f76'
-Yellow='#e5c890'
-Green='#a6d189'
-Teal='#81c8be'
-Sky='#99d1db'
-Sapphire='#85c1dc'
-Blue='#8caaee'
-Lavender='#babbf1'
-Text='#c6d0f5'
-Subtext1='#b5bfe2'
-Subtext0='#a5adce'
-Overlay2='#949cbb'
-Overlay1='#838ba7'
-Overlay0='#737994'
-Surface2='#626880'
-Surface1='#51576d'
-Surface0='#414559'
-Base='#303446'
-Mantle='#292c3c'
-Crust='#232634'
-```
-
-# macchiato
-```
-Rosewater='#f4dbd6'
-Flamingo='#f0c6c6'
-Pink='#f5bde6'
-Mauve='#c6a0f6'
-Red='#ed8796'
-Maroon='#ee99a0'
-Peach='#f5a97f'
-Yellow='#eed49f'
-Green='#a6da95'
-Teal='#8bd5ca'
-Sky='#91d7e3'
-Sapphire='#7dc4e4'
-Blue='#8aadf4'
-Lavender='#b7bdf8'
-Text='#cad3f5'
-Subtext1='#b8c0e0'
-Subtext0='#a5adcb'
-Overlay2='#939ab7'
-Overlay1='#8087a2'
-Overlay0='#6e738d'
-Surface2='#5b6078'
-Surface1='#494d64'
-Surface0='#363a4f'
-Base='#24273a'
-Mantle='#1e2030'
-Crust='#181926'
-```
-
-# mocha
-```
-Rosewater='#f5e0dc'
-Flamingo='#f2cdcd'
-Pink='#f5c2e7'
-Mauve='#cba6f7'
-Red='#f38ba8'
-Maroon='#eba0ac'
-Peach='#fab387'
-Yellow='#f9e2af'
-Green='#a6e3a1'
-Teal='#94e2d5'
-Sky='#89dceb'
-Sapphire='#74c7ec'
-Blue='#89b4fa'
-Lavender='#b4befe'
-Text='#cdd6f4'
-Subtext1='#bac2de'
-Subtext0='#a6adc8'
-Overlay2='#9399b2'
-Overlay1='#7f849c'
-Overlay0='#6c7086'
-Surface2='#585b70'
-Surface1='#45475a'
-Surface0='#313244'
-Base='#1e1e2e'
-Mantle='#181825'
-Crust='#11111b'
-```
-
-# TODO: check em all
-set -g "@dracula-cwd-colors" "Surface0 Text"
-set -g "@dracula-fossil-colors" "Green Surface0"
-set -g "@dracula-git-colors" "Green Surface0"
-set -g "@dracula-hg-colors" "Green Surface0"
-set -g "@dracula-battery-colors" "Mauve Surface0"
-set -g "@dracula-gpu-usage-colors" "Mauve Surface0"
-set -g "@dracula-gpu-ram-usage-colors" "Sky Surface0"
-set -g "@dracula-gpu-power-draw-colors" "Green Surface0"
-set -g "@dracula-cpu-usage-colors" "orange Surface0"
-set -g "@dracula-ram-usage-colors" "Sky Surface0"
-set -g "@dracula-tmux-ram-usage-colors" "Sky Surface0"
-set -g "@dracula-network-colors" "Sky Surface0"
-set -g "@dracula-network-bandwidth-colors" "Sky Surface0"
-set -g "@dracula-network-ping-colors" "Sky Surface0"
-set -g "@dracula-network-vpn-colors" "Sky Surface0"
-set -g "@dracula-attached-clients-colors" "Sky Surface0"
-set -g "@dracula-mpc-colors" "Green Surface0"
-set -g "@dracula-spotify-tui-colors" "Green Surface0"
-set -g "@dracula-playerctl-colors" "Green Surface0"
-set -g "@dracula-kubernetes-context-colors" "Sky Surface0"
-set -g "@dracula-terraform-colors" "Lavender Surface0"
-set -g "@dracula-continuum-colors" "Sky Surface0"
-set -g "@dracula-weather-colors" "orange Surface0"
-set -g "@dracula-time-colors" "dark_purple white"
-set -g "@dracula-synchronize-panes-colors" "Sky Surface0"
-set -g "@dracula-libre-colors" "Text Surface0"
-set -g "@dracula-ssh-session-colors" "Green Surface0"
diff --git a/docs/colour_theming/dracula.md b/docs/colour_theming/dracula.md
deleted file mode 100644
index e69de29b..00000000
diff --git a/docs/colour_theming/gruvbox.md b/docs/colour_theming/gruvbox.md
deleted file mode 100644
index e69de29b..00000000

From 313e85858cac9054d08717d1308373446215cb2e Mon Sep 17 00:00:00 2001
From: Theoreticallyhugo <me@theoreticallyhugo.com>
Date: Mon, 21 Oct 2024 14:53:25 +0200
Subject: [PATCH 14/20] change docs structure and add table of contents

---
 docs/CONFIG.md                    | 400 ++++++++++++++++++++++++++++++
 docs/INSTALL.md                   |  43 ++++
 INSTALL.md => docs/OLD_INSTALL.md |   0
 3 files changed, 443 insertions(+)
 create mode 100644 docs/CONFIG.md
 create mode 100644 docs/INSTALL.md
 rename INSTALL.md => docs/OLD_INSTALL.md (100%)

diff --git a/docs/CONFIG.md b/docs/CONFIG.md
new file mode 100644
index 00000000..d1560913
--- /dev/null
+++ b/docs/CONFIG.md
@@ -0,0 +1,400 @@
+### [tmux](https://github.com/tmux/tmux/wiki)
+
+#### Table of Contents
+- [Configuration](#Configuration-up---up)
+- [Status bar options](#status-bar-options---up)
+- [Color theming](/docs/color_theming/README.md)
+- [Attached clients](#attached-clients---up)
+- [Battery](#battery---up)
+- [Continuum](#continuum---up)
+- [CPU info](#cpu-info---up)
+- [Current working directory](#current-working-directory---up)
+- [Fossil](#fossil---up)
+- [Git](#git---up)
+- [GPU info](#gpu-info---up)
+- [Mercurial](#mercurial---up)
+- [Kubernetes context](#kubernetes-context---up)
+- [Libre](#libre---up)
+- [MPC](#mpc---up)
+- [Network](#network---up)
+- [Network bandwidth](#network-bandwidth---up)
+- [Network ping](#network-ping---up)
+- [Network VPN](#network-vpn---up)
+- [Playerctl](#playerctl---up)
+- [RAM usage](#ram-usage---up)
+- [Spotify tui](#spotify-tui---up)
+- [ssh session](#ssh-session---up)
+- [Synchronize panes](#synchronize-panes---up)
+- [Terraform](#terraform---up)
+- [Time](#time---up)
+- [Tmux RAM usage](#tmux-ram-usage---up)
+- [Weather](#weather---up)
+- [Custom scripts](#custom-scripts---up)
+- []()
+#### Configuration - [up](#table-of-contents)
+
+The following configuration works regardless of whether you are using `$HOME/.tmux.conf`, or `$XDG_CONFIG_HOME/tmux/tmux.conf`.
+To enable plugins set up the `@dracula-plugins` option in your `.tmux.conf` file, separate plugin by space.
+The order that you define the plugins will be the order on the status bar left to right.
+
+```bash
+# available plugins: battery, cpu-usage, git, gpu-usage, ram-usage, tmux-ram-usage, network, network-bandwidth, network-ping, ssh-session, attached-clients, network-vpn, weather, time, mpc, spotify-tui, krbtgt, playerctl, kubernetes-context, synchronize-panes
+set -g @dracula-plugins "cpu-usage gpu-usage ram-usage"
+```
+
+For each plugin is possible to customize background and foreground colors
+
+```bash
+# available colors: white, gray, dark_gray, light_purple, dark_purple, cyan, green, orange, red, pink, yellow
+# set -g @dracula-[plugin-name]-colors "[background] [foreground]"
+set -g @dracula-cpu-usage-colors "pink dark_gray"
+```
+
+#### Status bar options - [up](#table-of-contents)
+
+Enable powerline symbols
+
+```bash
+set -g @dracula-show-powerline true
+```
+
+Switch powerline symbols
+
+```bash
+# for left
+set -g @dracula-show-left-sep 
+
+# for right symbol (can set any symbol you like as separator)
+set -g @dracula-show-right-sep 
+```
+
+Enable window flags
+
+```bash
+set -g @dracula-show-flags true
+```
+
+Adjust the refresh rate for the status bar
+
+```bash
+# the default is 5, it can accept any number
+set -g @dracula-refresh-rate 5
+```
+
+Switch the left smiley icon
+
+```bash
+# it can accept `hostname` (full hostname), `session`, `shortname` (short name), `smiley`, `window`, or any character.
+set -g @dracula-show-left-icon session
+```
+
+Add padding to the left smiley icon
+
+```bash
+# default is 1, it can accept any number and 0 disables padding.
+set -g @dracula-left-icon-padding 1
+```
+
+Enable high contrast pane border
+
+```bash
+set -g @dracula-border-contrast true
+```
+
+Hide empty plugins
+
+```bash
+set -g @dracula-show-empty-plugins false
+```
+
+Make the powerline background transparent
+
+```bash
+set -g @dracula-powerline-bg-transparent true
+
+# the left separator symbol is inversed with a transparent background, you can modify it with any symbol you like
+set -g @dracula-inverse-divider 
+```
+
+#### [color theming](/docs/color_theming/README.md) - [up](#table-of-contents)
+
+Each individual widget's foreground and background color can be overridden.
+Additionally, the variables used for storing color values can be overridden and extended.
+This allows for the use of custom themes like catppuccin or gruvbox.
+
+For everything regarding colors, please refer to [the color theming directory](/docs/color_theming/README.md).
+
+#### cpu-usage options - [up](#table-of-contents)
+
+Customize label
+
+```bash
+set -g @dracula-cpu-usage-label "CPU"
+```
+
+Show system load average instead of CPU usage percentage (default)
+
+```bash
+set -g @dracula-cpu-display-load true
+```
+
+CPU usage percentage (default) - in percentage (output: %)
+Load average – is the average system load calculated over a given period of time of 1, 5 and 15 minutes (output: x.x x.x x.x)
+
+#### battery options - [up](#table-of-contents)
+
+Customize label
+
+```bash
+set -g @dracula-battery-label "Battery"
+```
+
+#### gpu-usage options - [up](#table-of-contents)
+
+Note, currently only the Linux NVIDIA Proprietary drivers are supported. Nouveau and AMD Graphics Cards support are still under development.
+
+Customize label
+
+```bash
+set -g @dracula-gpu-usage-label "GPU"
+```
+
+#### ram-usage options - [up](#table-of-contents)
+
+Customize label
+
+```bash
+set -g @dracula-ram-usage-label "RAM"
+```
+
+#### tmux-ram-usage options - [up](#table-of-contents)
+
+Customize label
+
+```bash
+set -g @dracula-tmux-ram-usage-label "MEM"
+```
+
+#### network-bandwidth - [up](#table-of-contents)
+
+You can configure which network interface you want to view the bandwidth,
+Displaying of the interface name, The interval between each bandwidth update.
+The most common interfaces name are `eth0` for a wired connection and `wlan0` for a wireless connection.
+
+```bash
+set -g @dracula-network-bandwidth eth0
+set -g @dracula-network-bandwidth-interval 0
+set -g @dracula-network-bandwidth-show-interface true
+```
+
+#### network-ping options - [up](#table-of-contents)
+
+You can configure which server (hostname, IP) you want to ping and at which rate (in seconds). Default is google.com at every 5 seconds.
+
+```bash
+set -g @dracula-ping-server "google.com"
+set -g @dracula-ping-rate 5
+```
+### ssh-session options
+
+Show SSH session port
+
+```bash
+set -g @dracula-show-ssh-session-port true
+```
+
+#### time options - [up](#table-of-contents)
+
+Disable timezone
+
+```bash
+set -g @dracula-show-timezone false
+```
+
+Swap date to day/month
+
+```bash
+set -g @dracula-day-month true
+```
+
+Enable military time
+
+```bash
+set -g @dracula-military-time true
+```
+
+Set custom time format e.g (2023-01-01 14:00)
+```bash
+set -g @dracula-time-format "%F %R"
+```
+See [[this page]](https://man7.org/linux/man-pages/man1/date.1.html) for other format symbols.
+
+#### git options - [up](#table-of-contents)
+
+Hide details of git changes
+```bash
+set -g @dracula-git-disable-status true
+```
+
+Set symbol to use for when branch is up to date with HEAD
+```bash
+# default is ✓. Avoid using non unicode characters that bash uses like $, * and !
+set -g @dracula-git-show-current-symbol ✓
+```
+
+Set symbol to use for when branch diverges from HEAD
+```bash
+# default is unicode !. Avoid bash special characters
+set -g @dracula-git-show-diff-symbol !
+```
+
+Set symbol or message to use when the current pane has no git repo
+```bash
+# default is unicode no message
+set -g @dracula-git-no-repo-message ""
+```
+
+Hide untracked files from being displayed as local changes
+```bash
+# default is false
+set -g @dracula-git-no-untracked-files true
+```
+
+Show remote tracking branch together with diverge/sync state
+```bash
+# default is false
+set -g @dracula-git-show-remote-status true
+```
+
+#### hg options - [up](#table-of-contents)
+
+Hide details of hg changes
+```bash
+set -g @dracula-hg-disable-status true
+```
+
+Set symbol to use for when branch is up to date with HEAD
+```bash
+#default is ✓.Avoid using non unicode characters that bash uses like $, * and !
+set -g @dracula-hg-show-current-symbol ✓
+```
+
+Set symbol to use for when branch diverges from HEAD
+```bash
+#default is unicode !.Avoid bash special characters
+set -g @dracula-hg-show-diff-symbol !
+```
+
+Set symbol or message to use when the current pane has no hg repo
+```bash
+#default is unicode no message
+set -g @dracula-hg-no-repo-message ""
+```
+
+Hide untracked files from being displayed as local changes
+```bash
+#default is false
+set -g @dracula-hg-no-untracked-files false
+```
+
+#### weather options - [up](#table-of-contents)
+
+Switch from default fahrenheit to celsius
+
+```bash
+set -g @dracula-show-fahrenheit false
+```
+
+Set your location manually
+
+```bash
+set -g @dracula-fixed-location "Some City"
+```
+
+Hide your location
+
+```bash
+set -g @dracula-show-location false
+```
+
+#### synchronize-panes options - [up](#table-of-contents)
+
+Customize label
+
+```bash
+set -g @dracula-synchronize-panes-label "Sync"
+```
+#### attached-clients options - [up](#table-of-contents)
+
+Set the minimum number of clients to show (otherwise, show nothing)
+
+```bash
+set -g @dracula-clients-minimum 1
+```
+
+Set the label when there is one client, or more than one client
+
+```bash
+set -g @dracula-clients-singular client
+set -g @dracula-clients-plural clients
+```
+
+#### Kubernetes options - [up](#table-of-contents)
+
+Add prefix label before the context
+
+```bash
+set -g @dracula-kubernetes-context-label "Some Label"
+```
+
+Hide user from the context string
+
+```
+set -g @dracula-kubernetes-hide-user true
+```
+
+Hide ARN (show only cluster name) - Available for EKS only (only available for cluster names that are ARNs)
+
+```
+set -g @dracula-kubernetes-eks-hide-arn true
+```
+
+Extract the account as a prefix to the cluster name - Available for EKS only (only available for cluster names that are ARNs)
+
+```
+set -g @dracula-kubernetes-eks-extract-account true
+```
+
+#### Kerberos TGT options - [up](#table-of-contents)
+
+Set the principal to check the TGT expiration date for (with or without the REALM)
+
+```
+set -g @dracula-krbtgt-principal "principal"
+```
+
+#### continuum options - [up](#table-of-contents)
+
+Set the output mode. Options are:
+- **countdown**: Show a T- countdown to the next save (default)
+- **time**: Show the time since the last save
+- **alert**: Hide output if no save has been performed recently
+- **interval**: Show the continuum save interval
+
+```bash
+set -g @dracula-continuum-mode countdown
+```
+
+Show if the last save was performed less than 60 seconds ago (default threshold is 15 seconds)
+
+```bash
+set -g @dracula-continuum-time-threshold 60
+```
+
+#### Playerctl format - [up](#table-of-contents)
+
+Set the playerctl metadata format
+
+```
+set -g @dracula-playerctl-format "►  {{ artist }} - {{ title }}"
+```
diff --git a/docs/INSTALL.md b/docs/INSTALL.md
new file mode 100644
index 00000000..d42cff58
--- /dev/null
+++ b/docs/INSTALL.md
@@ -0,0 +1,43 @@
+### [tmux](https://github.com/tmux/tmux/wiki)
+
+#### Install using [tpm](https://github.com/tmux-plugins/tpm)
+
+If you are a tpm user, you can install the theme and keep up to date by adding the following to your .tmux.conf file:
+
+	set -g @plugin 'dracula/tmux'
+
+Add any configuration options below this line in your tmux config.
+
+#### Install with [Nix](https://nixos.org)
+
+If you're using [home-manager](https://github.com/nix-community/home-manager), an example config would look similar to this:
+Then run `home-manager switch`, the `Activating theme` section doesn't apply here.
+
+```nix
+programs.tmux = {
+	enable = true;
+	clock24 = true;
+	plugins = with pkgs.tmuxPlugins; [
+		sensible
+		yank
+		{
+			plugin = dracula;
+			extraConfig = ''
+				set -g @dracula-show-battery false
+				set -g @dracula-show-powerline true
+				set -g @dracula-refresh-rate 10
+			'';
+		}
+	];
+
+	extraConfig = ''
+		set -g mouse on
+	'';
+};
+```
+
+#### Activating theme
+
+1. Make sure  `run -b '~/.tmux/plugins/tpm/tpm'` is at the bottom of your .tmux.conf
+2. Run tmux
+3. Use the tpm install command: `prefix + I` (default prefix is ctrl+b)
diff --git a/INSTALL.md b/docs/OLD_INSTALL.md
similarity index 100%
rename from INSTALL.md
rename to docs/OLD_INSTALL.md

From 2c2068049b58af03e3c12b97265bd9daa058fa21 Mon Sep 17 00:00:00 2001
From: Theoreticallyhugo <me@theoreticallyhugo.com>
Date: Thu, 24 Oct 2024 11:33:20 +0200
Subject: [PATCH 15/20] adding undocumented plugins

---
 docs/CONFIG.md | 449 ++++++++++++++++++++++++++++++++++---------------
 1 file changed, 318 insertions(+), 131 deletions(-)

diff --git a/docs/CONFIG.md b/docs/CONFIG.md
index d1560913..2e69188e 100644
--- a/docs/CONFIG.md
+++ b/docs/CONFIG.md
@@ -1,37 +1,40 @@
-### [tmux](https://github.com/tmux/tmux/wiki)
+## [tmux](https://github.com/tmux/tmux/wiki)
 
-#### Table of Contents
+### Table of Contents
 - [Configuration](#Configuration-up---up)
 - [Status bar options](#status-bar-options---up)
 - [Color theming](/docs/color_theming/README.md)
-- [Attached clients](#attached-clients---up)
-- [Battery](#battery---up)
-- [Continuum](#continuum---up)
-- [CPU info](#cpu-info---up)
-- [Current working directory](#current-working-directory---up)
-- [Fossil](#fossil---up)
-- [Git](#git---up)
-- [GPU info](#gpu-info---up)
-- [Mercurial](#mercurial---up)
-- [Kubernetes context](#kubernetes-context---up)
-- [Libre](#libre---up)
-- [MPC](#mpc---up)
-- [Network](#network---up)
-- [Network bandwidth](#network-bandwidth---up)
-- [Network ping](#network-ping---up)
-- [Network VPN](#network-vpn---up)
-- [Playerctl](#playerctl---up)
-- [RAM usage](#ram-usage---up)
-- [Spotify tui](#spotify-tui---up)
-- [ssh session](#ssh-session---up)
-- [Synchronize panes](#synchronize-panes---up)
-- [Terraform](#terraform---up)
-- [Time](#time---up)
-- [Tmux RAM usage](#tmux-ram-usage---up)
-- [Weather](#weather---up)
-- [Custom scripts](#custom-scripts---up)
-- []()
-#### Configuration - [up](#table-of-contents)
+- Plugins
+  - [attached-clients](#attached-clients---up)
+  - [battery](#battery---up)
+  - [continuum](#continuum---up)
+  - [cpu-usage](#cpu-info---up)
+  - [cwd](#current-working-directory---up)
+  - [fossil](#fossil---up)
+  - [git](#git---up)
+  - [GPU Info (gpu-usage, gpu-ram-usage, gpu-power-draw)](#gpu-info---up)
+  - [hg](#mercurial---up)
+  - [Kerberos TGT (krbtgt)](#Kerberos-TGT---up)
+  - [kubernetes-context](#kubernetes-context---up)
+  - [libreview](#libre---up)
+  - [mpc](#mpc---up)
+  - [network](#network---up)
+  - [network-bandwidth](#network-bandwidth---up)
+  - [network-ping](#network-ping---up)
+  - [network-vpn](#network-vpn---up)
+  - [playerctl](#playerctl---up)
+  - [ram-usage](#ram-usage---up)
+  - [rpi-temp](#rpi-temp---up)
+  - [spotify-tui](#spotify-tui---up)
+  - [ssh-session](#ssh-session---up)
+  - [synchronize-panes](#synchronize-panes---up)
+  - [terraform](#terraform---up)
+  - [time](#time---up)
+  - [tmux-ram-usage](#tmux-ram-usage---up)
+  - [weather](#weather---up)
+  - [custom:](#custom-scripts---up)
+
+### Configuration - [up](#table-of-contents)
 
 The following configuration works regardless of whether you are using `$HOME/.tmux.conf`, or `$XDG_CONFIG_HOME/tmux/tmux.conf`.
 To enable plugins set up the `@dracula-plugins` option in your `.tmux.conf` file, separate plugin by space.
@@ -50,7 +53,7 @@ For each plugin is possible to customize background and foreground colors
 set -g @dracula-cpu-usage-colors "pink dark_gray"
 ```
 
-#### Status bar options - [up](#table-of-contents)
+### Status bar options - [up](#table-of-contents)
 
 Enable powerline symbols
 
@@ -116,7 +119,7 @@ set -g @dracula-powerline-bg-transparent true
 set -g @dracula-inverse-divider 
 ```
 
-#### [color theming](/docs/color_theming/README.md) - [up](#table-of-contents)
+### [color theming](/docs/color_theming/README.md) - [up](#table-of-contents)
 
 Each individual widget's foreground and background color can be overridden.
 Additionally, the variables used for storing color values can be overridden and extended.
@@ -124,112 +127,101 @@ This allows for the use of custom themes like catppuccin or gruvbox.
 
 For everything regarding colors, please refer to [the color theming directory](/docs/color_theming/README.md).
 
-#### cpu-usage options - [up](#table-of-contents)
+### Plugins
+#### attached-clients options - [up](#table-of-contents)
+This widget provides the number of clients attached to the current tmux session.
 
-Customize label
+Set the minimum number of clients to show (otherwise, show nothing)
 
 ```bash
-set -g @dracula-cpu-usage-label "CPU"
+set -g @dracula-clients-minimum 1
 ```
 
-Show system load average instead of CPU usage percentage (default)
+Set the label when there is one client, or more than one client
 
 ```bash
-set -g @dracula-cpu-display-load true
+set -g @dracula-clients-singular client
+set -g @dracula-clients-plural clients
 ```
 
-CPU usage percentage (default) - in percentage (output: %)
-Load average – is the average system load calculated over a given period of time of 1, 5 and 15 minutes (output: x.x x.x x.x)
-
 #### battery options - [up](#table-of-contents)
+This widget provides information about the current charge of the battery, whether it is attached to a powersupply and charging from it, or running off the powersupply without charging. it also detects desktop pcs having no battery.
 
-Customize label
-
+Display any icon for the battery you'd like with:
 ```bash
-set -g @dracula-battery-label "Battery"
+set -g @dracula-battery-label "♥ "
 ```
 
-#### gpu-usage options - [up](#table-of-contents)
-
-Note, currently only the Linux NVIDIA Proprietary drivers are supported. Nouveau and AMD Graphics Cards support are still under development.
-
-Customize label
+to use nothing but nerdfont icons informing you about the current state, use the following,
+which will display the battery charge and whether its charging (or just drawing from AC) as nerdfont icons.
 
 ```bash
-set -g @dracula-gpu-usage-label "GPU"
+set -g @dracula-battery-label false
+set -g @dracula-show-battery-status true
 ```
 
-#### ram-usage options - [up](#table-of-contents)
-
-Customize label
+if you have no battery and would like the widget to hide in that case, set the following:
 
 ```bash
-set -g @dracula-ram-usage-label "RAM"
+set -g @dracula-no-battery-label false
 ```
 
-#### tmux-ram-usage options - [up](#table-of-contents)
-
-Customize label
+alternatively, if you have no battery and would like a nerdfont icon to indicate that, consider setting the following:
 
 ```bash
-set -g @dracula-tmux-ram-usage-label "MEM"
+set -g @dracula-no-battery-label " "
 ```
 
-#### network-bandwidth - [up](#table-of-contents)
+#### continuum options - [up](#table-of-contents)
 
-You can configure which network interface you want to view the bandwidth,
-Displaying of the interface name, The interval between each bandwidth update.
-The most common interfaces name are `eth0` for a wired connection and `wlan0` for a wireless connection.
+Set the output mode. Options are:
+- **countdown**: Show a T- countdown to the next save (default)
+- **time**: Show the time since the last save
+- **alert**: Hide output if no save has been performed recently
+- **interval**: Show the continuum save interval
 
 ```bash
-set -g @dracula-network-bandwidth eth0
-set -g @dracula-network-bandwidth-interval 0
-set -g @dracula-network-bandwidth-show-interface true
+set -g @dracula-continuum-mode countdown
 ```
 
-#### network-ping options - [up](#table-of-contents)
-
-You can configure which server (hostname, IP) you want to ping and at which rate (in seconds). Default is google.com at every 5 seconds.
+Show if the last save was performed less than 60 seconds ago (default threshold is 15 seconds)
 
 ```bash
-set -g @dracula-ping-server "google.com"
-set -g @dracula-ping-rate 5
+set -g @dracula-continuum-time-threshold 60
 ```
-### ssh-session options
-
-Show SSH session port
 
+Other options.
 ```bash
-set -g @dracula-show-ssh-session-port true
+@dracula-continuum-first-save
+@resurrect-dir
+@continuum-save-last-timestamp
+@continuum-save-interval
 ```
 
-#### time options - [up](#table-of-contents)
-
-Disable timezone
-
+#### cpu-usage options - [up](#table-of-contents)
+This widget displays the cpu usage in percent by default, but can display cpu load on linux.
+Load average – is the average system load calculated over a given period of time of 1, 5 and 15 minutes (output: x.x x.x x.x)
 ```bash
-set -g @dracula-show-timezone false
+set -g @dracula-cpu-display-load true
 ```
 
-Swap date to day/month
-
+possible nerdfont settings for cpu usage label:
 ```bash
-set -g @dracula-day-month true
+set -g @dracula-cpu-usage-label " "
 ```
 
-Enable military time
-
+nerdfont icons to consider:
 ```bash
-set -g @dracula-military-time true
+   󰍛 󰘚 󰻟 󰻠
 ```
 
-Set custom time format e.g (2023-01-01 14:00)
-```bash
-set -g @dracula-time-format "%F %R"
-```
-See [[this page]](https://man7.org/linux/man-pages/man1/date.1.html) for other format symbols.
-
+`set -g @dracula-refresh-rate 5` affects this widget
+#### Current working directory - [up](#table-of-contents)
+This widget displays the path of the current working directory.
+#### Fossil - [up](#table-of-contents)
+**TODO**
 #### git options - [up](#table-of-contents)
+This widget displays info about the current git repository.
 
 Hide details of git changes
 ```bash
@@ -266,7 +258,50 @@ Show remote tracking branch together with diverge/sync state
 set -g @dracula-git-show-remote-status true
 ```
 
-#### hg options - [up](#table-of-contents)
+#### gpu-usage options - [up](#table-of-contents)
+These widgets display the current computational, ram, and power usage of installed graphics cards.
+
+hardware support:
+- full support for NVIDIA gpus on linux.
+- partial support for apple m-chips on MacOS.
+- support for amd and intel is underway
+
+If your gpu is not recognised, force the script to assume a certain brands.
+```bash
+set -g @dracula-force-gpu "NVIDIA"
+```
+
+To display the used vram in percent (gigabyte is default unit):
+```bash
+set -g @dracula-gpu-vram-percent true
+```
+
+Vram usage is displayed in gigabyte without decimal places per default. To change that behaviour, use the following options with the respective number of decimal places you'd like to get:
+```bash
+set -g @dracula-gpu-vram-used-accuracy ".2f"
+set -g @dracula-gpu-vram-total-accuracy ".1f"
+```
+
+To display the power usage in percent (watt is default unit):
+```bash
+set -g @dracula-gpu-power-percent true
+```
+
+Possible nerdfont settings for gpu info labels:
+```bash
+set -g @dracula-gpu-power-label "󰢮 "
+set -g @dracula-gpu-usage-label "󰢮 "
+set -g @dracula-gpu-vram-label "󰢮 "
+```
+
+nerdfont icons to consider:
+```bash
+󰢮
+```
+
+`set -g @dracula-refresh-rate 5` affects this widget
+#### Mercurial options - [up](#table-of-contents)
+This widget displays info about the current mercurial repository.
 
 Hide details of hg changes
 ```bash
@@ -297,104 +332,256 @@ Hide untracked files from being displayed as local changes
 set -g @dracula-hg-no-untracked-files false
 ```
 
-#### weather options - [up](#table-of-contents)
+#### Kerberos TGT options - [up](#table-of-contents)
 
-Switch from default fahrenheit to celsius
+Set the principal to check the TGT expiration date for (with or without the REALM)
+
+```
+set -g @dracula-krbtgt-principal "principal"
+```
+
+#### Kubernetes options - [up](#table-of-contents)
+
+Add prefix label before the context
 
 ```bash
-set -g @dracula-show-fahrenheit false
+set -g @dracula-kubernetes-context-label "Some Label"
 ```
 
-Set your location manually
+Hide user from the context string
+
+```
+set -g @dracula-kubernetes-hide-user true
+```
+
+Hide ARN (show only cluster name) - Available for EKS only (only available for cluster names that are ARNs)
+
+```
+set -g @dracula-kubernetes-eks-hide-arn true
+```
+
+Extract the account as a prefix to the cluster name - Available for EKS only (only available for cluster names that are ARNs)
+
+```
+set -g @dracula-kubernetes-eks-extract-account true
+```
+
+#### libre - [up](#table-of-contents)
+This script retrieves and displays continuous glucose monitoring (CGM) data from the LibreView API.
+It caches the data to minimize API requests and displays the latest glucose level along with a trend indicator in a Tmux status bar.
+#### MPC - [up](#table-of-contents)
+This widget displays music information provided by mpc.
 
+To format the display format:
 ```bash
-set -g @dracula-fixed-location "Some City"
+set -g @dracula-mpc-format "%title% - %artist%"
 ```
 
-Hide your location
+`set -g @dracula-refresh-rate 5` affects this widget
+#### network - [up](#table-of-contents)
+This widget displays one of three states: offline, ethernet connected, or wifi connected.
+however, per default **this will only display the wifi you're connected to, if it provides internet access!**
 
+You can use different hosts to ping in order to check for a wifi or wired connection.
+If you frequently use networks without internet access, you can use local ip-addresses here to still display the connection.
 ```bash
-set -g @dracula-show-location false
+set -g @dracula-network-hosts "1.1.1.1 8.8.8.8"
 ```
 
-#### synchronize-panes options - [up](#table-of-contents)
+Possible nerdfont settings for network info:
+```bash
+set -g @dracula-network-ethernet-label "󰈀 Eth"
+set -g @dracula-network-offline-label "󱍢 "
+set -g @dracula-network-wifi-label " "
+```
+
+Nerdfont icons to consider:
+```
+ethernet: 󰈀 󰒪 󰒍 󰌗 󰌘
+offline: 󰖪  󱍢
+wifi:      󰖩  󰘊 󰒢
+```
 
-Customize label
+Known issues:
+- If for some reason `iw` is only in the path for root and not the normal user, wifi connections will be considered ethernet connections.
+#### network-bandwidth - [up](#table-of-contents)
+This widget gives the currently used up and download speeds per second for one interface.
 
+The most common interfaces name are `eth0` for a wired connection and `wlan0` for a wireless connection.
+To set a specific network interface you'd like to monitor, used:
 ```bash
-set -g @dracula-synchronize-panes-label "Sync"
+set -g @dracula-network-bandwidth "eno0"
+```
+To display the interface name alongside the speeds, set:
+```bash
+set -g @dracula-network-bandwidth-show-interface true
+```
+Per default, this widget checks the speeds as frequently as it can. to set longer intervals, use the following:
+```bash
+set -g @dracula-network-bandwidth-interval 5
 ```
-#### attached-clients options - [up](#table-of-contents)
 
-Set the minimum number of clients to show (otherwise, show nothing)
+#### network-ping options - [up](#table-of-contents)
+This widget displays the current ping to a specific server.
+
+You can configure which server (hostname, IP) you want to ping and at which rate (in seconds). Default is google.com at every 5 seconds.
 
 ```bash
-set -g @dracula-clients-minimum 1
+set -g @dracula-ping-server "google.com"
+set -g @dracula-ping-rate 5
 ```
 
-Set the label when there is one client, or more than one client
+#### network vpn - [up](#table-of-contents)
+**TODO**
+
+set -g @dracula-network-vpn-verbose true
+
+TODO:
+set -g @dracula-network-vpn-label
+#### Playerctl format - [up](#table-of-contents)
+This widget displays playerctl info.
 
+Set the playerctl metadata format like so:
 ```bash
-set -g @dracula-clients-singular client
-set -g @dracula-clients-plural clients
+set -g @dracula-playerctl-format "►  {{ artist }} - {{ title }}"
 ```
 
-#### Kubernetes options - [up](#table-of-contents)
+#### ram-usage options - [up](#table-of-contents)
+This widget displays the currently used ram as GB per GB.
 
-Add prefix label before the context
+Possible nerdfont settings for ram usage:
+```bash
+set -g @dracula-ram-usage-label " "
+```
 
+Nerdfont icons to consider:
+```
+   󰍛 󰘚
+```
+#### rpi-temp - [up](#table-of-contents)
+**TODO**
+#### spotify tui - [up](#table-of-contents)
+This widget displays music information provided by spotify-tui. Spotify-tui must be installed to use this widget.
+
+To format the display format:
 ```bash
-set -g @dracula-kubernetes-context-label "Some Label"
+set -g @dracula-spotify-tui-format "%f %s %t - %a"
 ```
 
-Hide user from the context string
+To limit the maximum length (0 means unlimited length):
+```bash
+set -g @dracula-spotify-tui-max-len 30
+```
 
+`set -g @dracula-refresh-rate 5` affects this widget
+#### ssh-session options - [up](#table-of-contents)
+This widget displays the current username@host combination, both of the local machine as well as when connected via ssh.
+
+To output nothing (and maybe hide the widget) when not connected via ssh:
+```bash
+set -g @dracula-show-ssh-only-when-connected true
 ```
-set -g @dracula-kubernetes-hide-user true
+
+Show SSH session port:
+```bash
+set -g @dracula-show-ssh-session-port true
 ```
 
-Hide ARN (show only cluster name) - Available for EKS only (only available for cluster names that are ARNs)
+nerdfont icons to consider:
+```
+󰣀
+```
+#### synchronize-panes options - [up](#table-of-contents)
+This widget displays whether the tmux panes are currently synchronised or not.
 
+To change the label:
+```bash
+set -g @dracula-synchronize-panes-label "Sync"
 ```
-set -g @dracula-kubernetes-eks-hide-arn true
+
+`set -g @dracula-refresh-rate 5` affects this widget
+#### terraform - [up](#table-of-contents)
+**TODO**
+
+```
+set -g @dracula-terraform-label ""
 ```
 
-Extract the account as a prefix to the cluster name - Available for EKS only (only available for cluster names that are ARNs)
+`set -g @dracula-refresh-rate 5` affects this widget
+#### time options - [up](#table-of-contents)
+This widget displays current date and time.
+
+Disable timezone
 
+```bash
+set -g @dracula-show-timezone false
 ```
-set -g @dracula-kubernetes-eks-extract-account true
+
+Swap date to day/month
+
+```bash
+set -g @dracula-day-month true
 ```
 
-#### Kerberos TGT options - [up](#table-of-contents)
+Enable military time
 
-Set the principal to check the TGT expiration date for (with or without the REALM)
+```bash
+set -g @dracula-military-time true
+```
 
+Set custom time format e.g (2023-01-01 14:00)
+```bash
+set -g @dracula-time-format "%F %R"
 ```
-set -g @dracula-krbtgt-principal "principal"
+See [[this page]](https://man7.org/linux/man-pages/man1/date.1.html) for other format symbols.
+
+#### tmux-ram-usage options - [up](#table-of-contents)
+This widget displays the ram currently used by tmux.
+
+Possible nerdfont settings for tmux ram usage:
+```
+@dracula-tmux-ram-usage-label " "
 ```
 
-#### continuum options - [up](#table-of-contents)
+Nerdfont icons to consider:
+```
+   󰍛 󰘚
+```
+#### weather options - [up](#table-of-contents)
+Show weather information for given location.
 
-Set the output mode. Options are:
-- **countdown**: Show a T- countdown to the next save (default)
-- **time**: Show the time since the last save
-- **alert**: Hide output if no save has been performed recently
-- **interval**: Show the continuum save interval
+Switch from default fahrenheit to celsius
 
 ```bash
-set -g @dracula-continuum-mode countdown
+set -g @dracula-show-fahrenheit false
 ```
 
-Show if the last save was performed less than 60 seconds ago (default threshold is 15 seconds)
+Set your location manually
 
 ```bash
-set -g @dracula-continuum-time-threshold 60
+set -g @dracula-fixed-location "Some City"
 ```
 
-#### Playerctl format - [up](#table-of-contents)
+Hide your location
 
-Set the playerctl metadata format
+```bash
+set -g @dracula-show-location false
+```
+
+#### custom scripts - [up](#table-of-contents)
+**TODO**
 
 ```
-set -g @dracula-playerctl-format "►  {{ artist }} - {{ title }}"
+  for plugin in "${plugins[@]}"; do
+
+    if case $plugin in custom:*) true;; *) false;; esac; then
+      script=${plugin#"custom:"}
+      if [[ -x "${current_dir}/${script}" ]]; then
+        IFS=' ' read -r -a colors <<<$(get_tmux_option "@dracula-custom-plugin-colors" "cyan dark_gray")
+        script="#($current_dir/${script})"
+      else
+        colors[0]="red"
+        colors[1]="dark_gray"
+        script="${script} not found!"
+      fi
 ```

From b21822d17fe2901321b8163d74a9f81557d350a5 Mon Sep 17 00:00:00 2001
From: Theoreticallyhugo <me@theoreticallyhugo.com>
Date: Thu, 24 Oct 2024 11:44:04 +0200
Subject: [PATCH 16/20] setting table of contents and headlines to match

---
 docs/CONFIG.md | 67 ++++++++++++++++++++++++++------------------------
 1 file changed, 35 insertions(+), 32 deletions(-)

diff --git a/docs/CONFIG.md b/docs/CONFIG.md
index 2e69188e..d716a5ba 100644
--- a/docs/CONFIG.md
+++ b/docs/CONFIG.md
@@ -1,22 +1,22 @@
 ## [tmux](https://github.com/tmux/tmux/wiki)
 
 ### Table of Contents
-- [Configuration](#Configuration-up---up)
+- [Configuration](#Configuration---up)
 - [Status bar options](#status-bar-options---up)
 - [Color theming](/docs/color_theming/README.md)
-- Plugins
+- [Plugins](#Plugins)
   - [attached-clients](#attached-clients---up)
   - [battery](#battery---up)
   - [continuum](#continuum---up)
-  - [cpu-usage](#cpu-info---up)
-  - [cwd](#current-working-directory---up)
+  - [cpu-usage](#cpu-usage---up)
+  - [cwd](#cwd---up)
   - [fossil](#fossil---up)
   - [git](#git---up)
   - [GPU Info (gpu-usage, gpu-ram-usage, gpu-power-draw)](#gpu-info---up)
-  - [hg](#mercurial---up)
+  - [hg](#hg---up)
   - [Kerberos TGT (krbtgt)](#Kerberos-TGT---up)
   - [kubernetes-context](#kubernetes-context---up)
-  - [libreview](#libre---up)
+  - [libreview](#libreview---up)
   - [mpc](#mpc---up)
   - [network](#network---up)
   - [network-bandwidth](#network-bandwidth---up)
@@ -32,7 +32,7 @@
   - [time](#time---up)
   - [tmux-ram-usage](#tmux-ram-usage---up)
   - [weather](#weather---up)
-  - [custom:](#custom-scripts---up)
+  - [custom:script-name](#custom:script-name---up)
 
 ### Configuration - [up](#table-of-contents)
 
@@ -119,7 +119,7 @@ set -g @dracula-powerline-bg-transparent true
 set -g @dracula-inverse-divider 
 ```
 
-### [color theming](/docs/color_theming/README.md) - [up](#table-of-contents)
+### [Color Theming](/docs/color_theming/README.md) - [up](#table-of-contents)
 
 Each individual widget's foreground and background color can be overridden.
 Additionally, the variables used for storing color values can be overridden and extended.
@@ -128,7 +128,7 @@ This allows for the use of custom themes like catppuccin or gruvbox.
 For everything regarding colors, please refer to [the color theming directory](/docs/color_theming/README.md).
 
 ### Plugins
-#### attached-clients options - [up](#table-of-contents)
+#### attached-clients - [up](#table-of-contents)
 This widget provides the number of clients attached to the current tmux session.
 
 Set the minimum number of clients to show (otherwise, show nothing)
@@ -144,7 +144,7 @@ set -g @dracula-clients-singular client
 set -g @dracula-clients-plural clients
 ```
 
-#### battery options - [up](#table-of-contents)
+#### battery - [up](#table-of-contents)
 This widget provides information about the current charge of the battery, whether it is attached to a powersupply and charging from it, or running off the powersupply without charging. it also detects desktop pcs having no battery.
 
 Display any icon for the battery you'd like with:
@@ -172,7 +172,7 @@ alternatively, if you have no battery and would like a nerdfont icon to indicate
 set -g @dracula-no-battery-label " "
 ```
 
-#### continuum options - [up](#table-of-contents)
+#### continuum - [up](#table-of-contents)
 
 Set the output mode. Options are:
 - **countdown**: Show a T- countdown to the next save (default)
@@ -198,7 +198,7 @@ Other options.
 @continuum-save-interval
 ```
 
-#### cpu-usage options - [up](#table-of-contents)
+#### cpu-usage - [up](#table-of-contents)
 This widget displays the cpu usage in percent by default, but can display cpu load on linux.
 Load average – is the average system load calculated over a given period of time of 1, 5 and 15 minutes (output: x.x x.x x.x)
 ```bash
@@ -216,11 +216,11 @@ nerdfont icons to consider:
 ```
 
 `set -g @dracula-refresh-rate 5` affects this widget
-#### Current working directory - [up](#table-of-contents)
+#### cwd - [up](#table-of-contents)
 This widget displays the path of the current working directory.
-#### Fossil - [up](#table-of-contents)
+#### fossil - [up](#table-of-contents)
 **TODO**
-#### git options - [up](#table-of-contents)
+#### git - [up](#table-of-contents)
 This widget displays info about the current git repository.
 
 Hide details of git changes
@@ -258,7 +258,9 @@ Show remote tracking branch together with diverge/sync state
 set -g @dracula-git-show-remote-status true
 ```
 
-#### gpu-usage options - [up](#table-of-contents)
+#### gpu-info - [up](#table-of-contents)
+**gpu-usage, gpu-ram-usage, gpu-power-draw**
+
 These widgets display the current computational, ram, and power usage of installed graphics cards.
 
 hardware support:
@@ -300,7 +302,7 @@ nerdfont icons to consider:
 ```
 
 `set -g @dracula-refresh-rate 5` affects this widget
-#### Mercurial options - [up](#table-of-contents)
+#### hg - [up](#table-of-contents)
 This widget displays info about the current mercurial repository.
 
 Hide details of hg changes
@@ -332,7 +334,8 @@ Hide untracked files from being displayed as local changes
 set -g @dracula-hg-no-untracked-files false
 ```
 
-#### Kerberos TGT options - [up](#table-of-contents)
+#### Kerberos TGT - [up](#table-of-contents)
+**krbtgt**
 
 Set the principal to check the TGT expiration date for (with or without the REALM)
 
@@ -340,7 +343,7 @@ Set the principal to check the TGT expiration date for (with or without the REAL
 set -g @dracula-krbtgt-principal "principal"
 ```
 
-#### Kubernetes options - [up](#table-of-contents)
+#### kubernetes-context - [up](#table-of-contents)
 
 Add prefix label before the context
 
@@ -366,10 +369,10 @@ Extract the account as a prefix to the cluster name - Available for EKS only (on
 set -g @dracula-kubernetes-eks-extract-account true
 ```
 
-#### libre - [up](#table-of-contents)
+#### libreview - [up](#table-of-contents)
 This script retrieves and displays continuous glucose monitoring (CGM) data from the LibreView API.
 It caches the data to minimize API requests and displays the latest glucose level along with a trend indicator in a Tmux status bar.
-#### MPC - [up](#table-of-contents)
+#### mpc - [up](#table-of-contents)
 This widget displays music information provided by mpc.
 
 To format the display format:
@@ -421,7 +424,7 @@ Per default, this widget checks the speeds as frequently as it can. to set longe
 set -g @dracula-network-bandwidth-interval 5
 ```
 
-#### network-ping options - [up](#table-of-contents)
+#### network-ping - [up](#table-of-contents)
 This widget displays the current ping to a specific server.
 
 You can configure which server (hostname, IP) you want to ping and at which rate (in seconds). Default is google.com at every 5 seconds.
@@ -431,14 +434,14 @@ set -g @dracula-ping-server "google.com"
 set -g @dracula-ping-rate 5
 ```
 
-#### network vpn - [up](#table-of-contents)
+#### network-vpn - [up](#table-of-contents)
 **TODO**
 
 set -g @dracula-network-vpn-verbose true
 
 TODO:
 set -g @dracula-network-vpn-label
-#### Playerctl format - [up](#table-of-contents)
+#### playerctl - [up](#table-of-contents)
 This widget displays playerctl info.
 
 Set the playerctl metadata format like so:
@@ -446,7 +449,7 @@ Set the playerctl metadata format like so:
 set -g @dracula-playerctl-format "►  {{ artist }} - {{ title }}"
 ```
 
-#### ram-usage options - [up](#table-of-contents)
+#### ram-usage - [up](#table-of-contents)
 This widget displays the currently used ram as GB per GB.
 
 Possible nerdfont settings for ram usage:
@@ -460,7 +463,7 @@ Nerdfont icons to consider:
 ```
 #### rpi-temp - [up](#table-of-contents)
 **TODO**
-#### spotify tui - [up](#table-of-contents)
+#### spotify-tui - [up](#table-of-contents)
 This widget displays music information provided by spotify-tui. Spotify-tui must be installed to use this widget.
 
 To format the display format:
@@ -474,7 +477,7 @@ set -g @dracula-spotify-tui-max-len 30
 ```
 
 `set -g @dracula-refresh-rate 5` affects this widget
-#### ssh-session options - [up](#table-of-contents)
+#### ssh-session - [up](#table-of-contents)
 This widget displays the current username@host combination, both of the local machine as well as when connected via ssh.
 
 To output nothing (and maybe hide the widget) when not connected via ssh:
@@ -491,7 +494,7 @@ nerdfont icons to consider:
 ```
 󰣀
 ```
-#### synchronize-panes options - [up](#table-of-contents)
+#### synchronize-panes - [up](#table-of-contents)
 This widget displays whether the tmux panes are currently synchronised or not.
 
 To change the label:
@@ -508,7 +511,7 @@ set -g @dracula-terraform-label ""
 ```
 
 `set -g @dracula-refresh-rate 5` affects this widget
-#### time options - [up](#table-of-contents)
+#### time - [up](#table-of-contents)
 This widget displays current date and time.
 
 Disable timezone
@@ -535,7 +538,7 @@ set -g @dracula-time-format "%F %R"
 ```
 See [[this page]](https://man7.org/linux/man-pages/man1/date.1.html) for other format symbols.
 
-#### tmux-ram-usage options - [up](#table-of-contents)
+#### tmux-ram-usage - [up](#table-of-contents)
 This widget displays the ram currently used by tmux.
 
 Possible nerdfont settings for tmux ram usage:
@@ -547,7 +550,7 @@ Nerdfont icons to consider:
 ```
    󰍛 󰘚
 ```
-#### weather options - [up](#table-of-contents)
+#### weather - [up](#table-of-contents)
 Show weather information for given location.
 
 Switch from default fahrenheit to celsius
@@ -568,7 +571,7 @@ Hide your location
 set -g @dracula-show-location false
 ```
 
-#### custom scripts - [up](#table-of-contents)
+#### custom:script-name - [up](#table-of-contents)
 **TODO**
 
 ```

From d497de00f1305e2045a29cb59172ab572df1937b Mon Sep 17 00:00:00 2001
From: Theoreticallyhugo <me@theoreticallyhugo.com>
Date: Thu, 24 Oct 2024 11:54:03 +0200
Subject: [PATCH 17/20] increasing headline size

---
 docs/CONFIG.md | 70 +++++++++++++++++++++++++-------------------------
 1 file changed, 35 insertions(+), 35 deletions(-)

diff --git a/docs/CONFIG.md b/docs/CONFIG.md
index d716a5ba..7de09863 100644
--- a/docs/CONFIG.md
+++ b/docs/CONFIG.md
@@ -1,6 +1,6 @@
-## [tmux](https://github.com/tmux/tmux/wiki)
+# [tmux](https://github.com/tmux/tmux/wiki)
 
-### Table of Contents
+## Table of Contents
 - [Configuration](#Configuration---up)
 - [Status bar options](#status-bar-options---up)
 - [Color theming](/docs/color_theming/README.md)
@@ -32,9 +32,9 @@
   - [time](#time---up)
   - [tmux-ram-usage](#tmux-ram-usage---up)
   - [weather](#weather---up)
-  - [custom:script-name](#custom:script-name---up)
+  - [custom:script-name](#customscript-name---up)
 
-### Configuration - [up](#table-of-contents)
+## Configuration - [up](#table-of-contents)
 
 The following configuration works regardless of whether you are using `$HOME/.tmux.conf`, or `$XDG_CONFIG_HOME/tmux/tmux.conf`.
 To enable plugins set up the `@dracula-plugins` option in your `.tmux.conf` file, separate plugin by space.
@@ -53,7 +53,7 @@ For each plugin is possible to customize background and foreground colors
 set -g @dracula-cpu-usage-colors "pink dark_gray"
 ```
 
-### Status bar options - [up](#table-of-contents)
+## Status bar options - [up](#table-of-contents)
 
 Enable powerline symbols
 
@@ -119,7 +119,7 @@ set -g @dracula-powerline-bg-transparent true
 set -g @dracula-inverse-divider 
 ```
 
-### [Color Theming](/docs/color_theming/README.md) - [up](#table-of-contents)
+## [Color Theming](/docs/color_theming/README.md) - [up](#table-of-contents)
 
 Each individual widget's foreground and background color can be overridden.
 Additionally, the variables used for storing color values can be overridden and extended.
@@ -127,8 +127,8 @@ This allows for the use of custom themes like catppuccin or gruvbox.
 
 For everything regarding colors, please refer to [the color theming directory](/docs/color_theming/README.md).
 
-### Plugins
-#### attached-clients - [up](#table-of-contents)
+## Plugins
+### attached-clients - [up](#table-of-contents)
 This widget provides the number of clients attached to the current tmux session.
 
 Set the minimum number of clients to show (otherwise, show nothing)
@@ -144,7 +144,7 @@ set -g @dracula-clients-singular client
 set -g @dracula-clients-plural clients
 ```
 
-#### battery - [up](#table-of-contents)
+### battery - [up](#table-of-contents)
 This widget provides information about the current charge of the battery, whether it is attached to a powersupply and charging from it, or running off the powersupply without charging. it also detects desktop pcs having no battery.
 
 Display any icon for the battery you'd like with:
@@ -172,7 +172,7 @@ alternatively, if you have no battery and would like a nerdfont icon to indicate
 set -g @dracula-no-battery-label " "
 ```
 
-#### continuum - [up](#table-of-contents)
+### continuum - [up](#table-of-contents)
 
 Set the output mode. Options are:
 - **countdown**: Show a T- countdown to the next save (default)
@@ -198,7 +198,7 @@ Other options.
 @continuum-save-interval
 ```
 
-#### cpu-usage - [up](#table-of-contents)
+### cpu-usage - [up](#table-of-contents)
 This widget displays the cpu usage in percent by default, but can display cpu load on linux.
 Load average – is the average system load calculated over a given period of time of 1, 5 and 15 minutes (output: x.x x.x x.x)
 ```bash
@@ -216,11 +216,11 @@ nerdfont icons to consider:
 ```
 
 `set -g @dracula-refresh-rate 5` affects this widget
-#### cwd - [up](#table-of-contents)
+### cwd - [up](#table-of-contents)
 This widget displays the path of the current working directory.
-#### fossil - [up](#table-of-contents)
+### fossil - [up](#table-of-contents)
 **TODO**
-#### git - [up](#table-of-contents)
+### git - [up](#table-of-contents)
 This widget displays info about the current git repository.
 
 Hide details of git changes
@@ -258,7 +258,7 @@ Show remote tracking branch together with diverge/sync state
 set -g @dracula-git-show-remote-status true
 ```
 
-#### gpu-info - [up](#table-of-contents)
+### gpu-info - [up](#table-of-contents)
 **gpu-usage, gpu-ram-usage, gpu-power-draw**
 
 These widgets display the current computational, ram, and power usage of installed graphics cards.
@@ -302,7 +302,7 @@ nerdfont icons to consider:
 ```
 
 `set -g @dracula-refresh-rate 5` affects this widget
-#### hg - [up](#table-of-contents)
+### hg - [up](#table-of-contents)
 This widget displays info about the current mercurial repository.
 
 Hide details of hg changes
@@ -334,7 +334,7 @@ Hide untracked files from being displayed as local changes
 set -g @dracula-hg-no-untracked-files false
 ```
 
-#### Kerberos TGT - [up](#table-of-contents)
+### Kerberos TGT - [up](#table-of-contents)
 **krbtgt**
 
 Set the principal to check the TGT expiration date for (with or without the REALM)
@@ -343,7 +343,7 @@ Set the principal to check the TGT expiration date for (with or without the REAL
 set -g @dracula-krbtgt-principal "principal"
 ```
 
-#### kubernetes-context - [up](#table-of-contents)
+### kubernetes-context - [up](#table-of-contents)
 
 Add prefix label before the context
 
@@ -369,10 +369,10 @@ Extract the account as a prefix to the cluster name - Available for EKS only (on
 set -g @dracula-kubernetes-eks-extract-account true
 ```
 
-#### libreview - [up](#table-of-contents)
+### libreview - [up](#table-of-contents)
 This script retrieves and displays continuous glucose monitoring (CGM) data from the LibreView API.
 It caches the data to minimize API requests and displays the latest glucose level along with a trend indicator in a Tmux status bar.
-#### mpc - [up](#table-of-contents)
+### mpc - [up](#table-of-contents)
 This widget displays music information provided by mpc.
 
 To format the display format:
@@ -381,7 +381,7 @@ set -g @dracula-mpc-format "%title% - %artist%"
 ```
 
 `set -g @dracula-refresh-rate 5` affects this widget
-#### network - [up](#table-of-contents)
+### network - [up](#table-of-contents)
 This widget displays one of three states: offline, ethernet connected, or wifi connected.
 however, per default **this will only display the wifi you're connected to, if it provides internet access!**
 
@@ -407,7 +407,7 @@ wifi:      󰖩  󰘊 󰒢
 
 Known issues:
 - If for some reason `iw` is only in the path for root and not the normal user, wifi connections will be considered ethernet connections.
-#### network-bandwidth - [up](#table-of-contents)
+### network-bandwidth - [up](#table-of-contents)
 This widget gives the currently used up and download speeds per second for one interface.
 
 The most common interfaces name are `eth0` for a wired connection and `wlan0` for a wireless connection.
@@ -424,7 +424,7 @@ Per default, this widget checks the speeds as frequently as it can. to set longe
 set -g @dracula-network-bandwidth-interval 5
 ```
 
-#### network-ping - [up](#table-of-contents)
+### network-ping - [up](#table-of-contents)
 This widget displays the current ping to a specific server.
 
 You can configure which server (hostname, IP) you want to ping and at which rate (in seconds). Default is google.com at every 5 seconds.
@@ -434,14 +434,14 @@ set -g @dracula-ping-server "google.com"
 set -g @dracula-ping-rate 5
 ```
 
-#### network-vpn - [up](#table-of-contents)
+### network-vpn - [up](#table-of-contents)
 **TODO**
 
 set -g @dracula-network-vpn-verbose true
 
 TODO:
 set -g @dracula-network-vpn-label
-#### playerctl - [up](#table-of-contents)
+### playerctl - [up](#table-of-contents)
 This widget displays playerctl info.
 
 Set the playerctl metadata format like so:
@@ -449,7 +449,7 @@ Set the playerctl metadata format like so:
 set -g @dracula-playerctl-format "►  {{ artist }} - {{ title }}"
 ```
 
-#### ram-usage - [up](#table-of-contents)
+### ram-usage - [up](#table-of-contents)
 This widget displays the currently used ram as GB per GB.
 
 Possible nerdfont settings for ram usage:
@@ -461,9 +461,9 @@ Nerdfont icons to consider:
 ```
    󰍛 󰘚
 ```
-#### rpi-temp - [up](#table-of-contents)
+### rpi-temp - [up](#table-of-contents)
 **TODO**
-#### spotify-tui - [up](#table-of-contents)
+### spotify-tui - [up](#table-of-contents)
 This widget displays music information provided by spotify-tui. Spotify-tui must be installed to use this widget.
 
 To format the display format:
@@ -477,7 +477,7 @@ set -g @dracula-spotify-tui-max-len 30
 ```
 
 `set -g @dracula-refresh-rate 5` affects this widget
-#### ssh-session - [up](#table-of-contents)
+### ssh-session - [up](#table-of-contents)
 This widget displays the current username@host combination, both of the local machine as well as when connected via ssh.
 
 To output nothing (and maybe hide the widget) when not connected via ssh:
@@ -494,7 +494,7 @@ nerdfont icons to consider:
 ```
 󰣀
 ```
-#### synchronize-panes - [up](#table-of-contents)
+### synchronize-panes - [up](#table-of-contents)
 This widget displays whether the tmux panes are currently synchronised or not.
 
 To change the label:
@@ -503,7 +503,7 @@ set -g @dracula-synchronize-panes-label "Sync"
 ```
 
 `set -g @dracula-refresh-rate 5` affects this widget
-#### terraform - [up](#table-of-contents)
+### terraform - [up](#table-of-contents)
 **TODO**
 
 ```
@@ -511,7 +511,7 @@ set -g @dracula-terraform-label ""
 ```
 
 `set -g @dracula-refresh-rate 5` affects this widget
-#### time - [up](#table-of-contents)
+### time - [up](#table-of-contents)
 This widget displays current date and time.
 
 Disable timezone
@@ -538,7 +538,7 @@ set -g @dracula-time-format "%F %R"
 ```
 See [[this page]](https://man7.org/linux/man-pages/man1/date.1.html) for other format symbols.
 
-#### tmux-ram-usage - [up](#table-of-contents)
+### tmux-ram-usage - [up](#table-of-contents)
 This widget displays the ram currently used by tmux.
 
 Possible nerdfont settings for tmux ram usage:
@@ -550,7 +550,7 @@ Nerdfont icons to consider:
 ```
    󰍛 󰘚
 ```
-#### weather - [up](#table-of-contents)
+### weather - [up](#table-of-contents)
 Show weather information for given location.
 
 Switch from default fahrenheit to celsius
@@ -571,7 +571,7 @@ Hide your location
 set -g @dracula-show-location false
 ```
 
-#### custom:script-name - [up](#table-of-contents)
+### custom:script-name - [up](#table-of-contents)
 **TODO**
 
 ```

From fd6ed80d79b5cb78f6a8dbb952d14dace44cb180 Mon Sep 17 00:00:00 2001
From: Theoreticallyhugo <me@theoreticallyhugo.com>
Date: Thu, 24 Oct 2024 15:50:44 +0200
Subject: [PATCH 18/20] tidying docs

---
 docs/CONFIG.md      |  93 ++++++----
 docs/OLD_INSTALL.md | 410 --------------------------------------------
 docs/README.md      | 373 ----------------------------------------
 3 files changed, 58 insertions(+), 818 deletions(-)
 delete mode 100644 docs/OLD_INSTALL.md
 delete mode 100644 docs/README.md

diff --git a/docs/CONFIG.md b/docs/CONFIG.md
index 7de09863..b5504261 100644
--- a/docs/CONFIG.md
+++ b/docs/CONFIG.md
@@ -3,6 +3,8 @@
 ## Table of Contents
 - [Configuration](#Configuration---up)
 - [Status bar options](#status-bar-options---up)
+  - [Powerline](#powerline---up)
+  - [Left Icon](#left-icon---up)
 - [Color theming](/docs/color_theming/README.md)
 - [Plugins](#Plugins)
   - [attached-clients](#attached-clients---up)
@@ -24,10 +26,10 @@
   - [network-vpn](#network-vpn---up)
   - [playerctl](#playerctl---up)
   - [ram-usage](#ram-usage---up)
-  - [rpi-temp](#rpi-temp---up)
   - [spotify-tui](#spotify-tui---up)
   - [ssh-session](#ssh-session---up)
   - [synchronize-panes](#synchronize-panes---up)
+  - [sys-temp](#sys-temp---up)
   - [terraform](#terraform---up)
   - [time](#time---up)
   - [tmux-ram-usage](#tmux-ram-usage---up)
@@ -39,38 +41,23 @@
 The following configuration works regardless of whether you are using `$HOME/.tmux.conf`, or `$XDG_CONFIG_HOME/tmux/tmux.conf`.
 To enable plugins set up the `@dracula-plugins` option in your `.tmux.conf` file, separate plugin by space.
 The order that you define the plugins will be the order on the status bar left to right.
+The name of the plugin used in the [table of contents](#table-of-contents), as well as each plugins headline, is the name to be used in the `@dracula-plugins` option.
 
 ```bash
-# available plugins: battery, cpu-usage, git, gpu-usage, ram-usage, tmux-ram-usage, network, network-bandwidth, network-ping, ssh-session, attached-clients, network-vpn, weather, time, mpc, spotify-tui, krbtgt, playerctl, kubernetes-context, synchronize-panes
 set -g @dracula-plugins "cpu-usage gpu-usage ram-usage"
 ```
 
-For each plugin is possible to customize background and foreground colors
+For each plugin is possible to customize background and foreground colors.
+For more fine-grained color customization please reference [Color theming](/docs/color_theming/README.md).
 
 ```bash
-# available colors: white, gray, dark_gray, light_purple, dark_purple, cyan, green, orange, red, pink, yellow
+# per default available colors: white, gray, dark_gray, light_purple, dark_purple, cyan, green, orange, red, pink, yellow
 # set -g @dracula-[plugin-name]-colors "[background] [foreground]"
 set -g @dracula-cpu-usage-colors "pink dark_gray"
 ```
 
 ## Status bar options - [up](#table-of-contents)
 
-Enable powerline symbols
-
-```bash
-set -g @dracula-show-powerline true
-```
-
-Switch powerline symbols
-
-```bash
-# for left
-set -g @dracula-show-left-sep 
-
-# for right symbol (can set any symbol you like as separator)
-set -g @dracula-show-right-sep 
-```
-
 Enable window flags
 
 ```bash
@@ -84,30 +71,33 @@ Adjust the refresh rate for the status bar
 set -g @dracula-refresh-rate 5
 ```
 
-Switch the left smiley icon
+Enable high contrast pane border
 
 ```bash
-# it can accept `hostname` (full hostname), `session`, `shortname` (short name), `smiley`, `window`, or any character.
-set -g @dracula-show-left-icon session
+set -g @dracula-border-contrast true
 ```
 
-Add padding to the left smiley icon
+Hide empty plugins
 
 ```bash
-# default is 1, it can accept any number and 0 disables padding.
-set -g @dracula-left-icon-padding 1
+set -g @dracula-show-empty-plugins false
 ```
 
-Enable high contrast pane border
+### Powerline - [up](#table-of-contents)
+Enable powerline symbols
 
 ```bash
-set -g @dracula-border-contrast true
+set -g @dracula-show-powerline true
 ```
 
-Hide empty plugins
+Switch powerline symbols
 
 ```bash
-set -g @dracula-show-empty-plugins false
+# for left
+set -g @dracula-show-left-sep 
+
+# for right symbol (can set any symbol you like as separator)
+set -g @dracula-show-right-sep 
 ```
 
 Make the powerline background transparent
@@ -119,6 +109,37 @@ set -g @dracula-powerline-bg-transparent true
 set -g @dracula-inverse-divider 
 ```
 
+### Left Icon - [up](#table-of-contents)
+- The left icon can be set to anything static you'd like.
+- However if you use tmux on multiple machines, it may be helpful to display the hostname.
+- If you use multiple sessions simultaneously it can be good to name them and have the name in the left icon.
+
+the following example uses formatting to display `"hostname | session_name"`:
+
+```bash
+set -g @dracula-show-left-icon "#h | #S"
+```
+
+formats:
+
+```bash
+#H: Hostname of local host
+#h: Hostname of local host (no domain name)
+#S: name of session -> suggestion: alias trs to tmux rename-session
+#W: current Window
+```
+
+more formats can be found here, though those without a shorthand like #H need to be used like #{host}, which is equivalent.
+[reference: tmux(1) - OpenBSD manual pages](https://man.openbsd.org/tmux.1#FORMATS)
+
+besides formats, any other string can be used.
+
+additionally the left icons padding can be set like so:
+```bash
+# default is 1, it can accept any number and 0 disables padding.
+set -g @dracula-left-icon-padding 1
+```
+
 ## [Color Theming](/docs/color_theming/README.md) - [up](#table-of-contents)
 
 Each individual widget's foreground and background color can be overridden.
@@ -435,12 +456,13 @@ set -g @dracula-ping-rate 5
 ```
 
 ### network-vpn - [up](#table-of-contents)
-**TODO**
+This widget displays whether a vpn is connected.
 
+These options are not available yet.
+```bash
 set -g @dracula-network-vpn-verbose true
-
-TODO:
 set -g @dracula-network-vpn-label
+```
 ### playerctl - [up](#table-of-contents)
 This widget displays playerctl info.
 
@@ -461,8 +483,6 @@ Nerdfont icons to consider:
 ```
    󰍛 󰘚
 ```
-### rpi-temp - [up](#table-of-contents)
-**TODO**
 ### spotify-tui - [up](#table-of-contents)
 This widget displays music information provided by spotify-tui. Spotify-tui must be installed to use this widget.
 
@@ -503,6 +523,9 @@ set -g @dracula-synchronize-panes-label "Sync"
 ```
 
 `set -g @dracula-refresh-rate 5` affects this widget
+### sys-temp - [up](#table-of-contents)
+This widget displays the system temperature.
+
 ### terraform - [up](#table-of-contents)
 **TODO**
 
diff --git a/docs/OLD_INSTALL.md b/docs/OLD_INSTALL.md
deleted file mode 100644
index f789fc87..00000000
--- a/docs/OLD_INSTALL.md
+++ /dev/null
@@ -1,410 +0,0 @@
-### [tmux](https://github.com/tmux/tmux/wiki)
-
-#### Install using [tpm](https://github.com/tmux-plugins/tpm)
-
-If you are a tpm user, you can install the theme and keep up to date by adding the following to your .tmux.conf file:
-
-	set -g @plugin 'dracula/tmux'
-
-Add any configuration options below this line in your tmux config.
-
-#### Install with [Nix](https://nixos.org)
-
-If you're using [home-manager](https://github.com/nix-community/home-manager), an example config would look similar to this:
-Then run `home-manager switch`, the `Activating theme` section doesn't apply here.
-
-```nix
-programs.tmux = {
-	enable = true;
-	clock24 = true;
-	plugins = with pkgs.tmuxPlugins; [
-		sensible
-		yank
-		{
-			plugin = dracula;
-			extraConfig = ''
-				set -g @dracula-show-battery false
-				set -g @dracula-show-powerline true
-				set -g @dracula-refresh-rate 10
-			'';
-		}
-	];
-
-	extraConfig = ''
-		set -g mouse on
-	'';
-};
-```
-
-#### Activating theme
-
-1. Make sure  `run -b '~/.tmux/plugins/tpm/tpm'` is at the bottom of your .tmux.conf
-2. Run tmux
-3. Use the tpm install command: `prefix + I` (default prefix is ctrl+b)
-
-#### Configuration
-
-To enable plugins set up the `@dracula-plugins` option in your `.tmux.conf` file, separate plugin by space.
-The order that you define the plugins will be the order on the status bar left to right.
-
-```bash
-# available plugins: battery, cpu-usage, git, gpu-usage, ram-usage, tmux-ram-usage, network, network-bandwidth, network-ping, ssh-session, attached-clients, network-vpn, weather, time, mpc, spotify-tui, krbtgt, playerctl, kubernetes-context, synchronize-panes
-set -g @dracula-plugins "cpu-usage gpu-usage ram-usage"
-```
-
-For each plugin is possible to customize background and foreground colors
-
-```bash
-# available colors: white, gray, dark_gray, light_purple, dark_purple, cyan, green, orange, red, pink, yellow
-# set -g @dracula-[plugin-name]-colors "[background] [foreground]"
-set -g @dracula-cpu-usage-colors "pink dark_gray"
-```
-
-#### Status bar options
-
-Enable powerline symbols
-
-```bash
-set -g @dracula-show-powerline true
-```
-
-Switch powerline symbols
-
-```bash
-# for left
-set -g @dracula-show-left-sep 
-
-# for right symbol (can set any symbol you like as separator)
-set -g @dracula-show-right-sep 
-```
-
-Enable window flags
-
-```bash
-set -g @dracula-show-flags true
-```
-
-Adjust the refresh rate for the status bar
-
-```bash
-# the default is 5, it can accept any number
-set -g @dracula-refresh-rate 5
-```
-
-Switch the left smiley icon
-
-```bash
-# it can accept `hostname` (full hostname), `session`, `shortname` (short name), `smiley`, `window`, or any character.
-set -g @dracula-show-left-icon session
-```
-
-Add padding to the left smiley icon
-
-```bash
-# default is 1, it can accept any number and 0 disables padding.
-set -g @dracula-left-icon-padding 1
-```
-
-Enable high contrast pane border
-
-```bash
-set -g @dracula-border-contrast true
-```
-
-Hide empty plugins
-
-```bash
-set -g @dracula-show-empty-plugins false
-```
-
-Make the powerline background transparent
-
-```bash
-set -g @dracula-powerline-bg-transparent true
-
-# the left separator symbol is inversed with a transparent background, you can modify it with any symbol you like
-set -g @dracula-inverse-divider 
-```
-
-#### [color theming](/docs/color_theming/README.md)
-
-Each individual widget's foreground and background color can be overridden.
-Additionally, the variables used for storing color values can be overridden and extended.
-This allows for the use of custom themes like catppuccin or gruvbox.
-
-For everything regarding colors, please refer to [the color theming directory](/docs/color_theming/README.md).
-
-#### cpu-usage options
-
-Customize label
-
-```bash
-set -g @dracula-cpu-usage-label "CPU"
-```
-
-Show system load average instead of CPU usage percentage (default)
-
-```bash
-set -g @dracula-cpu-display-load true
-```
-
-CPU usage percentage (default) - in percentage (output: %)
-Load average – is the average system load calculated over a given period of time of 1, 5 and 15 minutes (output: x.x x.x x.x)
-
-#### battery options
-
-Customize label
-
-```bash
-set -g @dracula-battery-label "Battery"
-```
-
-#### gpu-usage options
-
-Note, currently only the Linux NVIDIA Proprietary drivers are supported. Nouveau and AMD Graphics Cards support are still under development.
-
-Customize label
-
-```bash
-set -g @dracula-gpu-usage-label "GPU"
-```
-
-#### ram-usage options
-
-Customize label
-
-```bash
-set -g @dracula-ram-usage-label "RAM"
-```
-
-#### tmux-ram-usage options
-
-Customize label
-
-```bash
-set -g @dracula-tmux-ram-usage-label "MEM"
-```
-
-#### network-bandwidth
-
-You can configure which network interface you want to view the bandwidth,
-Displaying of the interface name, The interval between each bandwidth update.
-The most common interfaces name are `eth0` for a wired connection and `wlan0` for a wireless connection.
-
-```bash
-set -g @dracula-network-bandwidth eth0
-set -g @dracula-network-bandwidth-interval 0
-set -g @dracula-network-bandwidth-show-interface true
-```
-
-#### network-ping options
-
-You can configure which server (hostname, IP) you want to ping and at which rate (in seconds). Default is google.com at every 5 seconds.
-
-```bash
-set -g @dracula-ping-server "google.com"
-set -g @dracula-ping-rate 5
-```
-### ssh-session options
-
-Show SSH session port
-
-```bash
-set -g @dracula-show-ssh-session-port true
-```
-
-#### time options
-
-Disable timezone
-
-```bash
-set -g @dracula-show-timezone false
-```
-
-Swap date to day/month
-
-```bash
-set -g @dracula-day-month true
-```
-
-Enable military time
-
-```bash
-set -g @dracula-military-time true
-```
-
-Set custom time format e.g (2023-01-01 14:00)
-```bash
-set -g @dracula-time-format "%F %R"
-```
-See [[this page]](https://man7.org/linux/man-pages/man1/date.1.html) for other format symbols.
-
-#### git options
-
-Hide details of git changes
-```bash
-set -g @dracula-git-disable-status true
-```
-
-Set symbol to use for when branch is up to date with HEAD
-```bash
-# default is ✓. Avoid using non unicode characters that bash uses like $, * and !
-set -g @dracula-git-show-current-symbol ✓
-```
-
-Set symbol to use for when branch diverges from HEAD
-```bash
-# default is unicode !. Avoid bash special characters
-set -g @dracula-git-show-diff-symbol !
-```
-
-Set symbol or message to use when the current pane has no git repo
-```bash
-# default is unicode no message
-set -g @dracula-git-no-repo-message ""
-```
-
-Hide untracked files from being displayed as local changes
-```bash
-# default is false
-set -g @dracula-git-no-untracked-files true
-```
-
-Show remote tracking branch together with diverge/sync state
-```bash
-# default is false
-set -g @dracula-git-show-remote-status true
-```
-
-#### hg options
-
-Hide details of hg changes
-```bash
-set -g @dracula-hg-disable-status true
-```
-
-Set symbol to use for when branch is up to date with HEAD
-```bash
-#default is ✓.Avoid using non unicode characters that bash uses like $, * and !
-set -g @dracula-hg-show-current-symbol ✓
-```
-
-Set symbol to use for when branch diverges from HEAD
-```bash
-#default is unicode !.Avoid bash special characters
-set -g @dracula-hg-show-diff-symbol !
-```
-
-Set symbol or message to use when the current pane has no hg repo
-```bash
-#default is unicode no message
-set -g @dracula-hg-no-repo-message ""
-```
-
-Hide untracked files from being displayed as local changes
-```bash
-#default is false
-set -g @dracula-hg-no-untracked-files false
-```
-
-#### weather options
-
-Switch from default fahrenheit to celsius
-
-```bash
-set -g @dracula-show-fahrenheit false
-```
-
-Set your location manually
-
-```bash
-set -g @dracula-fixed-location "Some City"
-```
-
-Hide your location
-
-```bash
-set -g @dracula-show-location false
-```
-
-#### synchronize-panes options
-
-Customize label
-
-```bash
-set -g @dracula-synchronize-panes-label "Sync"
-```
-#### attached-clients options
-
-Set the minimum number of clients to show (otherwise, show nothing)
-
-```bash
-set -g @dracula-clients-minimum 1
-```
-
-Set the label when there is one client, or more than one client
-
-```bash
-set -g @dracula-clients-singular client
-set -g @dracula-clients-plural clients
-```
-
-#### Kubernetes options
-
-Add prefix label before the context
-
-```bash
-set -g @dracula-kubernetes-context-label "Some Label"
-```
-
-Hide user from the context string
-
-```
-set -g @dracula-kubernetes-hide-user true
-```
-
-Hide ARN (show only cluster name) - Available for EKS only (only available for cluster names that are ARNs)
-
-```
-set -g @dracula-kubernetes-eks-hide-arn true
-```
-
-Extract the account as a prefix to the cluster name - Available for EKS only (only available for cluster names that are ARNs)
-
-```
-set -g @dracula-kubernetes-eks-extract-account true
-```
-
-### Kerberos TGT options
-
-Set the principal to check the TGT expiration date for (with or without the REALM)
-
-```
-set -g @dracula-krbtgt-principal "principal"
-```
-
-#### continuum options
-
-Set the output mode. Options are:
-- **countdown**: Show a T- countdown to the next save (default)
-- **time**: Show the time since the last save
-- **alert**: Hide output if no save has been performed recently
-- **interval**: Show the continuum save interval
-
-```bash
-set -g @dracula-continuum-mode countdown
-```
-
-Show if the last save was performed less than 60 seconds ago (default threshold is 15 seconds)
-
-```bash
-set -g @dracula-continuum-time-threshold 60
-```
-
-#### Playerctl format
-
-Set the playerctl metadata format
-
-```
-set -g @dracula-playerctl-format "►  {{ artist }} - {{ title }}"
-```
diff --git a/docs/README.md b/docs/README.md
deleted file mode 100644
index 7102cddd..00000000
--- a/docs/README.md
+++ /dev/null
@@ -1,373 +0,0 @@
-# misc --- sort me **TODO**
-  IFS=' ' read -r -a plugins <<< $(get_tmux_option "@dracula-plugins" "battery network weather")
-set -g @dracula-show-empty-plugins true
-
-set -g @dracula-show-flags false
-set -g @dracula-border-contrast false
-set -g @dracula-refresh-rate 5
-set -g @dracula-time-format ""
-set -g @dracula-show-ssh-session-port false
-set -g @dracula-show-libreview false
-# powerline
-set -g @dracula-show-powerline false
-set -g @dracula-show-left-sep 
-set -g @dracula-show-right-sep 
-# left icon
-- The left icon can be set to anything static you'd like.
-- However if you use tmux on multiple machines, it may be helpful to display the hostname.
-- If you use multiple sessions simultaneously it can be good to name them and have the name in the left icon.
-
-the following example uses formatting to display "hostname | session_name":
-```
-set -g @dracula-show-left-icon "#h | #S"
-```
-formats:
-```
-#H: Hostname of local host
-#h: Hostname of local host (no domain name)
-#S: name of session -> suggestion: alias trs to tmux rename-session
-```
-more formats can be found here, though those without a shorthand like #H need to be used like #{host}, which is equivalent.
-[reference: tmux(1) - OpenBSD manual pages](https://man.openbsd.org/tmux.1#FORMATS)
-
-besides formats, any other string can be used.
-
-additionally the left icons padding can be set like so:
-```
-set -g @dracula-left-icon-padding 1
-```
-# right widgets
-## attached clients
-this widget provides the number of clients attached to the current tmux session.
-
-set the number of clients attached, required to show any output. if less clients are attached, the widget shows no output.
-```
-set -g @dracula-clients-minimum 1
-```
-set the labels used for singular and plural clients.
-```
-set -g @dracula-clients-plural "clients"
-set -g @dracula-clients-singular "client"
-```
-
-`set -g @dracula-refresh-rate 5` affects this widget
-## battery
-this widget provides information about the current charge of the battery, whether it is attached to a powersupply and charging from it, or running off the powersupply without charging. it also detects desktop pcs having no battery.
-
-Display any icon for the battery you'd like with:
-```
-set -g @dracula-battery-label "♥ "
-```
-
-to use nothing but nerdfont icons informing you about the current state, use the following,
-which will display the battery charge and whether its charging (or just drawing from AC) as nerdfont icons.
-```
-set -g @dracula-battery-label false
-set -g @dracula-show-battery-status true
-```
-if you have no battery and would like the widget to hide in that case, set the following:
-```
-set -g @dracula-no-battery-label false
-```
-alternatively, if you have no battery and would like a nerdfont icon to indicate that, consider setting the following:
-```
-set -g @dracula-no-battery-label " "
-```
-## continuum
-**TODO**
-
-```
-@dracula-continuum-mode
-@dracula-continuum-time-threshold
-@dracula-continuum-first-save
-@resurrect-dir
-@continuum-save-last-timestamp
-@continuum-save-interval
-```
-
-nerdfont icons to consider:
-```
-󰉉
-```
-## cpu info
-this widget displays the cpu usage in percent by default, but can display cpu load on linux:
-```
-set -g @dracula-cpu-display-load true
-```
-
-possible nerdfont settings for cpu usage label:
-```
-set -g @dracula-cpu-usage-label " "
-```
-
-nerdfont icons to consider:
-```
-   󰍛 󰘚 󰻟 󰻠
-```
-
-`set -g @dracula-refresh-rate 5` affects this widget
-## current working directory
-this widget displays the path of the current working directory
-## fossil
-**TODO**
-## git
-this widget displays info about the current git repository.
-
-**TODO**
-```
-set -g @dracula-git-disable-status "false"
-set -g @dracula-git-show-current-symbol "✓"
-set -g @dracula-git-show-diff-symbol "!"
-set -g @dracula-git-no-repo-message ""
-set -g @dracula-git-no-untracked-files "false"
-set -g @dracula-git-show-remote-status "false"
-```
-## gpu info
-these widgets display the current computational, ram, and power usage of installed graphics cards.
-
-hardware support:
-- full support for NVIDIA gpus.
-- partial support for apple m-chips.
-
-if your gpu is not recognised, force the script to assume a certain brands.
-```
-set -g @dracula-force-gpu "NVIDIA"
-```
-
-to display the used vram in percent (gigabyte is default unit):
-```
-set -g @dracula-gpu-vram-percent true
-```
-
-vram usage is displayed in gigabyte without decimal places per default. to change that behaviour, use the following options with the respective number of decimal places you'd like to get:
-```
-set -g @dracula-gpu-vram-used-accuracy ".2f"
-set -g @dracula-gpu-vram-total-accuracy ".1f"
-```
-
-to display the power usage in percent (watt is default unit):
-```
-set -g @dracula-gpu-power-percent true
-```
-
-possible nerdfont settings for gpu info labels:
-```
-set -g @dracula-gpu-power-label "󰢮 "
-set -g @dracula-gpu-usage-label "󰢮 "
-set -g @dracula-gpu-vram-label "󰢮 "
-```
-
-TODO:
-- add support for amd without testing and clarify that this is an experimental feature! ask someone whos got an amd card to test it.
-
-nerdfont icons to consider:
-```
-󰢮
-```
-
-`set -g @dracula-refresh-rate 5` affects this widget
-## mercurial
-this widget displays info about the current mercurial repository.
-
-**TODO**
-```
-set -g @dracula-hg-disable-status "false"
-set -g @dracula-hg-show-current-symbol "✓"
-set -g @dracula-hg-show-diff-symbol "!"
-set -g @dracula-hg-no-repo-message ""
-set -g @dracula-hg-no-untracked-files "false"
-```
-## kubernetes context
-set -g @dracula-kubernetes-context-label ""
-set -g @dracula-kubernetes-eks-hide-arn false
-set -g @dracula-kubernetes-eks-extract-account false
-set -g @dracula-kubernetes-hide-user false
-
-hide_arn_from_cluster=$1
-extract_account=$2
-hide_user=$3
-just_current_context=$4
-label=$5
-## libre
-This script retrieves and displays continuous glucose monitoring (CGM) data from the LibreView API.
-It caches the data to minimize API requests and displays the latest glucose level along with a trend indicator in a Tmux status bar.
-## mpc
-this widget displays music information provided by mpc.
-
-to format the display format:
-```
-set -g @dracula-mpc-format "%title% - %artist%"
-```
-
-`set -g @dracula-refresh-rate 5` affects this widget
-## network
-this widget displays one of three states: offline, ethernet connected, or wifi connected.
-however, per default **this will only display the wifi you're connected to, if it provides internet access!**
-
-you can use different hosts to ping in order to check for a wifi or wired connection.
-if you frequently use networks without internet access, you can use local ip-addresses here to still display the connection.
-```
-set -g @dracula-network-hosts "1.1.1.1 8.8.8.8"
-```
-
-possible nerdfont settings for network info:
-```
-set -g @dracula-network-ethernet-label "󰈀 Eth"
-set -g @dracula-network-offline-label "󱍢 "
-set -g @dracula-network-wifi-label " "
-```
-
-nerdfont icons to consider:
-```
-ethernet: 󰈀 󰒪 󰒍 󰌗 󰌘
-offline: 󰖪  󱍢
-wifi:      󰖩  󰘊 󰒢
-```
-
-known issues:
-- if for some reason `iw` is only in the path for root and not the normal user, wifi connections will be considered ethernet connections.
-## network bandwidth
-this widget gives the currently used up and download speeds per second for one interface.
-
-to set a specific network interface you'd like to monitor, used:
-```
-set -g @dracula-network-bandwidth "eno0"
-```
-to display the interface name alongside the speeds, set:
-```
-set -g @dracula-network-bandwidth-show-interface true
-```
-per default, this widget checks the speeds as frequently as it can. to set longer intervals, use the following:
-```
-set -g @dracula-network-bandwidth-interval 5
-```
-## network ping
-this widget displays the current ping to a specific server.
-
-to use a custom server:
-```
-set -g @dracula-ping-server "1.1.1.1"
-```
-
-to set the rate at which to ping the server (in seconds):
-```
-set -g @dracula-ping-rate 5
-```
-## network vpn
-**TODO**
-
-set -g @dracula-network-vpn-verbose true
-
-TODO:
-set -g @dracula-network-vpn-label
-## playerctl
-this widget displays music information provided by playerctl.
-
-to change the display format set:
-```
-set -g @dracula-playerctl-format "Now playing: {{ artist }} - {{ album }} - {{ title }}"
-```
-
-`set -g @dracula-refresh-rate 5` affects this widget
-## ram usage
-this widget displays the currently used ram as GB per GB.
-
-possible nerdfont settings for ram usage:
-```
-set -g @dracula-ram-usage-label " "
-```
-
-nerdfont icons to consider:
-```
-   󰍛 󰘚
-```
-## spotify tui
-this widget displays music information provided by spotify-tui. spotify-tui must be installed to use this widget.
-
-to format the display format:
-```
-set -g @dracula-spotify-tui-format "%f %s %t - %a"
-```
-
-to limit the maximum length (0 means unlimited length):
-```
-set -g @dracula-spotify-tui-max-len 30
-```
-
-`set -g @dracula-refresh-rate 5` affects this widget
-## ssh session
-this widget displays the current username@host combination, both of the local machine as well as when connected via ssh.
-
-to output nothing (and maybe hide the widget) when not connected via ssh:
-```
-set -g @dracula-show-ssh-only-when-connected true
-```
-
-nerdfont icons to consider:
-```
-󰣀
-```
-## synchronise panes
-this widget displays whether the tmux panes are currently synchronised or not.
-
-to change the label:
-```
-set -g @dracula-synchronize-panes-label "Sync"
-```
-
-`set -g @dracula-refresh-rate 5` affects this widget
-## terraform
-**TODO**
-
-```
-set -g @dracula-terraform-label ""
-```
-
-`set -g @dracula-refresh-rate 5` affects this widget
-## time
-**TODO**
-```
-set -g @dracula-military-time false
-set -g @dracula-set-timezone ""
-set -g @dracula-show-timezone true
-set -g @dracula-day-month false
-```
-## tmux ram usage
-this widget displays the ram currently used by tmux.
-
-possible nerdfont settings for tmux ram usage:
-```
-@dracula-tmux-ram-usage-label " "
-```
-
-nerdfont icons to consider:
-```
-   󰍛 󰘚
-```
-## weather
-**TODO**
-
-```
-set -g @dracula-show-fahrenheit true
-set -g @dracula-show-location true
-set -g @dracula-fixed-location
-```
-
-      script="#($current_dir/weather_wrapper.sh $show_fahrenheit $show_location '$fixed_location')"
-## custom scripts
-**TODO**
-
-```
-  for plugin in "${plugins[@]}"; do
-
-    if case $plugin in custom:*) true;; *) false;; esac; then
-      script=${plugin#"custom:"}
-      if [[ -x "${current_dir}/${script}" ]]; then
-        IFS=' ' read -r -a colors <<<$(get_tmux_option "@dracula-custom-plugin-colors" "cyan dark_gray")
-        script="#($current_dir/${script})"
-      else
-        colors[0]="red"
-        colors[1]="dark_gray"
-        script="${script} not found!"
-      fi
-```

From 8885d0161697d399a1f4452c9a1679ad95ad75df Mon Sep 17 00:00:00 2001
From: Theoreticallyhugo <me@theoreticallyhugo.com>
Date: Thu, 24 Oct 2024 16:00:44 +0200
Subject: [PATCH 19/20] clarification on the names of plugins

---
 docs/CONFIG.md | 23 ++++-------------------
 1 file changed, 4 insertions(+), 19 deletions(-)

diff --git a/docs/CONFIG.md b/docs/CONFIG.md
index b5504261..84b0b3fb 100644
--- a/docs/CONFIG.md
+++ b/docs/CONFIG.md
@@ -280,9 +280,8 @@ set -g @dracula-git-show-remote-status true
 ```
 
 ### gpu-info - [up](#table-of-contents)
-**gpu-usage, gpu-ram-usage, gpu-power-draw**
-
 These widgets display the current computational, ram, and power usage of installed graphics cards.
+They are split into widgets with the names: `gpu-usage, gpu-ram-usage, gpu-power-draw`.
 
 hardware support:
 - full support for NVIDIA gpus on linux.
@@ -356,7 +355,7 @@ set -g @dracula-hg-no-untracked-files false
 ```
 
 ### Kerberos TGT - [up](#table-of-contents)
-**krbtgt**
+This widgets name is `krbtgt`.
 
 Set the principal to check the TGT expiration date for (with or without the REALM)
 
@@ -595,19 +594,5 @@ set -g @dracula-show-location false
 ```
 
 ### custom:script-name - [up](#table-of-contents)
-**TODO**
-
-```
-  for plugin in "${plugins[@]}"; do
-
-    if case $plugin in custom:*) true;; *) false;; esac; then
-      script=${plugin#"custom:"}
-      if [[ -x "${current_dir}/${script}" ]]; then
-        IFS=' ' read -r -a colors <<<$(get_tmux_option "@dracula-custom-plugin-colors" "cyan dark_gray")
-        script="#($current_dir/${script})"
-      else
-        colors[0]="red"
-        colors[1]="dark_gray"
-        script="${script} not found!"
-      fi
-```
+For testing/ running custom plugins, put the bash script into the scripts directory of dracula/tmux plugin.
+Additionally, in the `@dracula-plugins` option, add the script as `custom:name-of-script.sh`.

From 234244a18051f078f9c8afbc3598f468e42c5ec3 Mon Sep 17 00:00:00 2001
From: Theoreticallyhugo <me@theoreticallyhugo.com>
Date: Thu, 24 Oct 2024 16:08:56 +0200
Subject: [PATCH 20/20] add links to docs in readme

---
 README.md | 8 ++++++--
 1 file changed, 6 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index 55022bbe..b4080d95 100644
--- a/README.md
+++ b/README.md
@@ -6,11 +6,15 @@
 
 ## Install
 
-All instructions can be found at [draculatheme.com/tmux](https://draculatheme.com/tmux).
+All instructions can be found [in the docs](/docs/INSTALL.md).
 
 ## Configuration
 
-Configuration and options can be found at [draculatheme.com/tmux](https://draculatheme.com/tmux).
+Configuration and options can be found [in the docs](/docs/CONFIG.md).
+
+## Color Theming
+
+In depth configuration of Colors and alternative themes can be found [in the docs](/docs/color_theming/README.md)
 
 ## Features