Skip to content

Commit 094b1e9

Browse files
TheoreticallyhugoTheoreticallyhugo
committed
adding installation instructions and documentation for theming in general as well as cat and gruv
1 parent 88c61b3 commit 094b1e9

File tree

4 files changed

+337
-0
lines changed

4 files changed

+337
-0
lines changed

‎INSTALL.md‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -126,6 +126,14 @@ set -g @dracula-powerline-bg-transparent true
126126
set -g @dracula-inverse-divider 
127127
```
128128

129+
#### [color theming](https://github.com/dracula/tmux/blob/master/docs/color_theming/README.md)
130+
131+
Each individual widget's foreground and background color can be overridden.
132+
Additionally, the variables used for storing color values can be overridden and extended.
133+
This allows for the use of custom themes like catppuccin or gruvbox.
134+
135+
For everything regarding colors, please refer to [the color theming directory](https://github.com/dracula/tmux/blob/master/docs/color_theming/README.md).
136+
129137
#### cpu-usage options
130138

131139
Customize label

‎docs/color_theming/README.md‎

Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
# overriding widget colors
2+
widget color options with default values - sorted alphabetically:
3+
```
4+
set -g @dracula-attached-clients-colors "cyan dark_gray"
5+
set -g @dracula-battery-colors "pink dark_gray"
6+
set -g @dracula-continuum-colors "cyan dark_gray"
7+
set -g @dracula-cpu-usage-colors "orange dark_gray"
8+
set -g @dracula-custom-plugin-colors "cyan dark_gray"
9+
set -g @dracula-cwd-colors "dark_gray white"
10+
set -g @dracula-fossil-colors "green dark_gray"
11+
set -g @dracula-git-colors "green dark_gray"
12+
set -g @dracula-gpu-power-draw-colors "green dark_gray"
13+
set -g @dracula-gpu-ram-usage-colors "cyan dark_gray"
14+
set -g @dracula-gpu-usage-colors "pink dark_gray"
15+
set -g @dracula-hg-colors "green dark_gray"
16+
set -g @dracula-kubernetes-context-colors "cyan dark_gray"
17+
set -g @dracula-libre-colors "white dark_gray"
18+
set -g @dracula-mpc-colors "green dark_gray"
19+
set -g @dracula-network-bandwidth-colors "cyan dark_gray"
20+
set -g @dracula-network-colors "cyan dark_gray"
21+
set -g @dracula-network-ping-colors "cyan dark_gray"
22+
set -g @dracula-network-vpn-colors "cyan dark_gray"
23+
set -g @dracula-playerctl-colors "green dark_gray"
24+
set -g @dracula-ram-usage-colors "cyan dark_gray"
25+
set -g @dracula-spotify-tui-colors "green dark_gray"
26+
set -g @dracula-ssh-session-colors "green dark_gray"
27+
set -g @dracula-synchronize-panes-colors "cyan dark_gray"
28+
set -g @dracula-terraform-colors "light_purple dark_gray"
29+
set -g @dracula-time-colors "dark_purple white"
30+
set -g @dracula-tmux-ram-usage-colors "cyan dark_gray"
31+
set -g @dracula-weather-colors "orange dark_gray"
32+
```
33+
34+
# overriding color variables
35+
this requires an extra `.sh` file which specifies color variables and their respective values. it can be used to override and also extend the dracula color pallette.
36+
37+
if your tmux config is in `~/.config/tmux/`, then consider putting the color variables into `~/.config/tmux/colors.sh`, with the matching option `set -g @dracula-colors "~/.config/tmux/colors.sh"` in your tmux config.
38+
alternatively, if your tmux config is `~/.tmux.conf`, then consider putting the color variables into `~/.tmux_colors.sh`, with the matching option `set -g @dracula-colors "~/.tmux_colors.sh"` in your tmux config.
39+
40+
for a quick setup, fill the file with the following contents:
41+
```
42+
# Dracula Color Pallette
43+
white="#f8f8f2"
44+
gray="#44475a"
45+
dark_gray="#282a36"
46+
light_purple="#bd93f9"
47+
dark_purple="#6272a4"
48+
cyan="#8be9fd"
49+
green="#50fa7b"
50+
orange="#ffb86c"
51+
red="#ff5555"
52+
pink="#ff79c6"
53+
yellow="#f1fa8c"
54+
```
55+
## plug and play themes
56+
as part of this directory there are some plug and play themes with explanations on how to use them:
57+
- [catppuccin](https://github.com/dracula/tmux/blob/master/docs/color_theming/catppuccin.md)
58+
- [gruvbox](https://github.com/dracula/tmux/blob/master/docs/color_theming/gruvbox.md)

‎docs/color_theming/catppuccin.md‎

Lines changed: 174 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,174 @@
1+
# drac to cat
2+
3+
4+
for a quick setup, fill the file with the following contents:
5+
```
6+
# simple catppuccin Color Pallette
7+
pink='#cba6f7'
8+
orange='#fab387'
9+
yellow='#f9e2af'
10+
green='#a6e3a1'
11+
cyan='#89dceb'
12+
light_purple='#b4befe'
13+
white='#cdd6f4'
14+
dark_gray='#313244'
15+
red='#f38ba8'
16+
gray='#45475a'
17+
dark_purple='#6c7086'
18+
```
19+
20+
21+
alternatively use the full catppuccin color palette and customise the flags accordingly
22+
23+
# catppuccin Color Pallette
24+
25+
# latte
26+
```
27+
Rosewater='#dc8a78'
28+
Flamingo='#dd7878'
29+
Pink='#ea76cb'
30+
Mauve='#8839ef'
31+
Red='#d20f39'
32+
Maroon='#e64553'
33+
Peach='#fe640b'
34+
Yellow='#df8e1d'
35+
Green='#40a02b'
36+
Teal='#179299'
37+
Sky='#04a5e5'
38+
Sapphire='#209fb5'
39+
Blue='#1e66f5'
40+
Lavender='#7287fd'
41+
Text='#4c4f69'
42+
Subtext1='#5c5f77'
43+
Subtext0='#6c6f85'
44+
Overlay2='#7c7f93'
45+
Overlay1='#8c8fa1'
46+
Overlay0='#9ca0b0'
47+
Surface2='#acb0be'
48+
Surface1='#bcc0cc'
49+
Surface0='#ccd0da'
50+
Base='#eff1f5'
51+
Mantle='#e6e9ef'
52+
Crust='#dce0e8'
53+
```
54+
55+
# frappe
56+
```
57+
Rosewater='#f2d5cf'
58+
Flamingo='#eebebe'
59+
Pink='#f4b8e4'
60+
Mauve='#ca9ee6'
61+
Red='#e78284'
62+
Maroon='#ea999c'
63+
Peach='#ef9f76'
64+
Yellow='#e5c890'
65+
Green='#a6d189'
66+
Teal='#81c8be'
67+
Sky='#99d1db'
68+
Sapphire='#85c1dc'
69+
Blue='#8caaee'
70+
Lavender='#babbf1'
71+
Text='#c6d0f5'
72+
Subtext1='#b5bfe2'
73+
Subtext0='#a5adce'
74+
Overlay2='#949cbb'
75+
Overlay1='#838ba7'
76+
Overlay0='#737994'
77+
Surface2='#626880'
78+
Surface1='#51576d'
79+
Surface0='#414559'
80+
Base='#303446'
81+
Mantle='#292c3c'
82+
Crust='#232634'
83+
```
84+
85+
# macchiato
86+
```
87+
Rosewater='#f4dbd6'
88+
Flamingo='#f0c6c6'
89+
Pink='#f5bde6'
90+
Mauve='#c6a0f6'
91+
Red='#ed8796'
92+
Maroon='#ee99a0'
93+
Peach='#f5a97f'
94+
Yellow='#eed49f'
95+
Green='#a6da95'
96+
Teal='#8bd5ca'
97+
Sky='#91d7e3'
98+
Sapphire='#7dc4e4'
99+
Blue='#8aadf4'
100+
Lavender='#b7bdf8'
101+
Text='#cad3f5'
102+
Subtext1='#b8c0e0'
103+
Subtext0='#a5adcb'
104+
Overlay2='#939ab7'
105+
Overlay1='#8087a2'
106+
Overlay0='#6e738d'
107+
Surface2='#5b6078'
108+
Surface1='#494d64'
109+
Surface0='#363a4f'
110+
Base='#24273a'
111+
Mantle='#1e2030'
112+
Crust='#181926'
113+
```
114+
115+
# mocha
116+
```
117+
Rosewater='#f5e0dc'
118+
Flamingo='#f2cdcd'
119+
Pink='#f5c2e7'
120+
Mauve='#cba6f7'
121+
Red='#f38ba8'
122+
Maroon='#eba0ac'
123+
Peach='#fab387'
124+
Yellow='#f9e2af'
125+
Green='#a6e3a1'
126+
Teal='#94e2d5'
127+
Sky='#89dceb'
128+
Sapphire='#74c7ec'
129+
Blue='#89b4fa'
130+
Lavender='#b4befe'
131+
Text='#cdd6f4'
132+
Subtext1='#bac2de'
133+
Subtext0='#a6adc8'
134+
Overlay2='#9399b2'
135+
Overlay1='#7f849c'
136+
Overlay0='#6c7086'
137+
Surface2='#585b70'
138+
Surface1='#45475a'
139+
Surface0='#313244'
140+
Base='#1e1e2e'
141+
Mantle='#181825'
142+
Crust='#11111b'
143+
```
144+
145+
# TODO: check em all
146+
```
147+
set -g "@dracula-cwd-colors" "Surface0 Text"
148+
set -g "@dracula-fossil-colors" "Green Surface0"
149+
set -g "@dracula-git-colors" "Green Surface0"
150+
set -g "@dracula-hg-colors" "Green Surface0"
151+
set -g "@dracula-battery-colors" "Mauve Surface0"
152+
set -g "@dracula-gpu-usage-colors" "Mauve Surface0"
153+
set -g "@dracula-gpu-ram-usage-colors" "Sky Surface0"
154+
set -g "@dracula-gpu-power-draw-colors" "Green Surface0"
155+
set -g "@dracula-cpu-usage-colors" "orange Surface0"
156+
set -g "@dracula-ram-usage-colors" "Sky Surface0"
157+
set -g "@dracula-tmux-ram-usage-colors" "Sky Surface0"
158+
set -g "@dracula-network-colors" "Sky Surface0"
159+
set -g "@dracula-network-bandwidth-colors" "Sky Surface0"
160+
set -g "@dracula-network-ping-colors" "Sky Surface0"
161+
set -g "@dracula-network-vpn-colors" "Sky Surface0"
162+
set -g "@dracula-attached-clients-colors" "Sky Surface0"
163+
set -g "@dracula-mpc-colors" "Green Surface0"
164+
set -g "@dracula-spotify-tui-colors" "Green Surface0"
165+
set -g "@dracula-playerctl-colors" "Green Surface0"
166+
set -g "@dracula-kubernetes-context-colors" "Sky Surface0"
167+
set -g "@dracula-terraform-colors" "Lavender Surface0"
168+
set -g "@dracula-continuum-colors" "Sky Surface0"
169+
set -g "@dracula-weather-colors" "orange Surface0"
170+
set -g "@dracula-time-colors" "dark_purple white"
171+
set -g "@dracula-synchronize-panes-colors" "Sky Surface0"
172+
set -g "@dracula-libre-colors" "Text Surface0"
173+
set -g "@dracula-ssh-session-colors" "Green Surface0"
174+
```

‎docs/color_theming/gruvbox.md‎

Lines changed: 97 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,97 @@
1+
# drac to gruv
2+
3+
**TODO**
4+
for a quick setup, fill the file with the following contents:
5+
```
6+
# simple catppuccin Color Pallette
7+
pink='#'
8+
orange='#'
9+
yellow='#'
10+
green='#'
11+
cyan='#'
12+
light_purple='#'
13+
white='#'
14+
dark_gray='#'
15+
red='#'
16+
gray='#'
17+
dark_purple='#'
18+
```
19+
20+
21+
alternatively use the full gruvbox color palette and customise the flags accordingly
22+
23+
# GruvBox Color Pallette
24+
## dark
25+
```
26+
# === colors ===
27+
# --- muted ---
28+
muted_back="#282828"
29+
muted_red="#CC241D"
30+
muted_green="#98971A"
31+
muted_yellow="#D79921"
32+
muted_blue="#458588"
33+
muted_purple="#B16286"
34+
muted_aqua="#689D6A"
35+
muted_orange="#D65D0E"
36+
muted_fore="#A89984"
37+
# --- strong ---
38+
strong_back="#928374"
39+
strong_red="#FB4934"
40+
strong_green="#B8BB26"
41+
strong_yellow="#FABD2F"
42+
strong_blue="#83A598"
43+
strong_purple="#D3869B"
44+
strong_aqua="#8EC07C"
45+
strong_orange="#FE8019"
46+
strong_fore="#EBDBB2"
47+
# === backgrounds ===
48+
back_0_hard="#1D2021"
49+
back_0_soft="#32302F"
50+
back_1="#3C3836"
51+
back_2="#504945"
52+
back_3="#665C54"
53+
back_4="#7C6F64"
54+
fore_0_hard="#FBF1C7"
55+
fore_0_soft="#FBF1C7"
56+
fore_1="#EBDBB2"
57+
fore_2="#D5C4A1"
58+
fore_3="#BDAE93"
59+
fore_4="#A89984"
60+
```
61+
## light
62+
```
63+
# === colors ===
64+
# --- muted ---
65+
muted_back="#FBF1C7"
66+
muted_red="#CC241D"
67+
muted_green="#98971A"
68+
muted_yellow="#D79921"
69+
muted_blue="#458588"
70+
muted_purple="#B16286"
71+
muted_aqua="#689D6A"
72+
muted_orange="#D65D0E"
73+
muted_fore="#7C6F64"
74+
# --- strong ---
75+
strong_back="#928374"
76+
strong_red="#9d0006"
77+
strong_green="#79740E"
78+
strong_yellow="#B57614"
79+
strong_blue="#076678"
80+
strong_purple="#8F3F71"
81+
strong_aqua="#427B58"
82+
strong_orange="#AF3A03"
83+
strong_fore="#3C3836"
84+
# === backgrounds ===
85+
back_0_hard="#F9F5D7"
86+
back_0_soft="#F2E5BC"
87+
back_1="#EBDBB2"
88+
back_2="#D5C4A1"
89+
back_3="#BDAE93"
90+
back_4="#A89984"
91+
fore_0_hard="#282828"
92+
fore_0_soft="#282828"
93+
fore_1="#3C3836"
94+
fore_2="#504945"
95+
fore_3="#665C54"
96+
fore_4="#7C6F64"
97+
```

0 commit comments

Comments
 (0)