Merge pull request #14 from 2KAbhishek/more-themes

Add more themes

Author: 2KAbhishek

README.md

@@ -36,76 +36,103 @@ tmux2k is a highly customizable framework designed to enhance your tmux status b
 
 ### 🎨 Available Themes:
 
-- default (`set @tmux2k-theme 'default'`)
-  ![default](./images/default.png)
-- default icons only (`set @tmux2k-icons-only true`)
-  ![default-icons](./images/default-icons.png)
-- default no powerline (`set @tmux2k-show-powerline false`)
-  ![default-no-powerline](./images/default-no-powerline.png)
-- catppuccin
-  ![catppuccin](./images/catppuccin.png)
-  ![catppuccin-icons](./images/catppuccin-icons.png)
-- gruvbox
-  ![gruvbox](./images/gruvbox.png)
-  ![gruvbox-icons](./images/gruvbox-icons.png)
-- onedark
-  ![onedark](./images/onedark.png)
-  ![onedark-icons](./images/onedark-icons.png)
+- default ![default](./images/default.png)
+- default icons ![default-icons](./images/default-icons.png)
+- catppuccin ![catppuccin](./images/catppuccin.png)
+- catppuccin icons ![catppuccin-icons](./images/catppuccin-icons.png)
+- gruvbox ![gruvbox](./images/gruvbox.png)
+- gruvbox icons ![gruvbox-icons](./images/gruvbox-icons.png)
+- monokai ![monokai](./images/monokai.png)
+- monokai icons ![monokai-icons](./images/monokai-icons.png)
+- onedark ![onedark](./images/onedark.png)
+- onedark icons ![onedark-icons](./images/onedark-icons.png)
+- duo ![duo](./images/duo.png)
+- duo icons ![duo-icons](./images/duo-icons.png)
+- duo blue ![duo-blue](./images/duo-blue.png)
+- default no powerline ![default-no-powerline](./images/default-no-powerline.png)
+
+To use themes:
 
-### 🧩 Available Plugins
-
-- `battery`: Show battery stats and percentage
-- `git`: Show Git branch and status information
-- `cpu`: Show CPU usage information
-- `gpu`: Show GPU usage information
-- `ram`: Show RAM usage information
-- `network`: Show network status and statistics
-- `bandwidth`: Show network bandwidth usage
-- `ping`: Show network ping statistics
-- `time`: Show current time and date
-- `weather`: Show weather information
-- `wimdow`: tmux window list
+```bash
+# use a theme
+set -g @tmux2k-theme 'onedark'
 
-### 🪆 Add New Plugins
+# to show icons only
+set -g @tmux2k-icons-only true
 
-To add a new plugin, add a script to the [scripts](./scripts) folder that prints something to the console.
+# to customize duo bg and fg
+set -g @tmux2k-duo-fg "#1688f0" # this will get you duo blue shown above
+set -g @tmux2k-duo-bg "#000000" # this will set the bg for duo theme
 
-> The plugin name and script file name must match e.g: plugin named `foo` should have a file called `scripts/foo.sh`
+# to set powerline symbols
+set -g @tmux2k-right-sep  # alternate right status bar sep
+set -g @tmux2k-win-right-sep  # alternate window right sep
 
-## ⚡ Setup
+# to not show powerline
+set -g @tmux2k-show-powerline false
 
-### ⚙️ Requirements
+# set start icon, accpets: `session`, 'window`, or any string
+set -g @tmux2k-start-icon ""
+```
 
-Before you begin, ensure you have met the following requirements:
+#### 🖌️ Customize Theme Colors
 
-- You have installed the latest version of `tmux`.
-- bash 5.2 or newer, mac users can install it using `brew install bash`
-- [tpm](https://github.com/tmux-plugins/tpm) for managing `tmux` plugins.
-- A [patched nerd font](https://www.nerdfonts.com/) for `powerline` and glyphs support.
+##### Available Colors:
 
-### 💻 Installation
+- `text`: Default text color. Default: `#282a36`
+- `bg_main`: Background color for main sections. Default: `#15152a`
+- `bg_alt`: Background color for alternate sections. Default: `#45455a`
+- `black`: Black color. Default: `#0a0a0f`
+- `white`: White color. Default: `#d5d5da`
+- `red`: Red color. Default: `#ff001f`
+- `light_red`: Light red color. Default: `#ff0055`
+- `green`: Green color. Default: `#3dd50a`
+- `light_green`: Light green color. Default: `#ccffcc`
+- `blue`: Blue color. Default: `#1688f0`
+- `light_blue`: Light blue color. Default: `#11dddd`
+- `yellow`: Yellow color. Default: `#ffb86c`
+- `light_yellow`: Light yellow color. Default: `#ffd21a`
+- `purple`: Purple color. Default: `#bf58ff`
+- `light_purple`: Light purple color. Default: `#ff65c6`
 
-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:
+To customize theme colors:
 
 ```bash
-set -g @plugin '2kabhishek/tmux2k'
-
+set -g @tmux2k-text '#cdcdcd' # change text to white
+set -g @tmux2k-bg-main '#ffffff' # change bg to white
+set -g @tmux2k-yellow '#f8c800' # change yellow color
 ```
 
-- Run `tmux`
-- Use the `tpm` install command: prefix + I (default prefix is `ctrl+b`)
+> You may have to restart `tmux` for some changes to reflect
 
-You can also directly clone the repo to your `~/.tmux/plugins/` folder.
+### 🧩 Available Plugins
 
-## 🚀 Usage
+- `battery`: Show battery stats and percentage
+- `git`: Show Git branch and status information
+- `cpu`: Show CPU usage information
+- `gpu`: Show GPU usage information
+- `ram`: Show RAM usage information
+- `network`: Show network status and statistics
+- `bandwidth`: Show network bandwidth usage
+- `ping`: Show network ping statistics
+- `time`: Show current time and date
+- `weather`: Show weather information
+- `wimdow`: tmux window list
 
-tmux2k to should automatically start after installation. Here's how you can customize it's features
+To use plugins:
 
 ```bash
-# Left and right status bar plugins
+# set the left and right plugin sections
 set -g @tmux2k-left-plugins "git cpu ram"
 set -g @tmux2k-right-plugins "battery network time"
 
+# to customize plugin colors
+set -g @tmux2k-[plugin-name]-colors "[background] [foreground]"
+set -g @tmux2k-cpu-colors "red black" # set cpu plugin bg to red, fg to black
+
+# to enable compact window list size
+set -g @tmux2k-compact-windows true
+
 # change refresh rate
 set -g @tmux2k-refresh-rate 5
 
@@ -115,70 +142,50 @@ set -g @tmux2k-show-fahrenheit false
 # 24 hour time
 set -g @tmux2k-military-time true
 
-# it can accept `session`, 'window`, or any string
-set -g @tmux2k-start-icon ""
-
 # network interface to watch
 set -g @tmux2k-network-name "wlo1"
+```
 
-# update powerline symbols
-set -g @tmux2k-right-sep  # alternate right status bar sep
-set -g @tmux2k-win-right-sep  # alternate window right sep
+#### 🪆 Add New Plugins
 
-# to disable powerline
-set -g @tmux2k-show-powerline false
+To add a new plugin, add a script to the [scripts](./scripts) folder that prints something to the console.
 
-# to customize theme
-set -g @tmux2k-theme 'onedark'
+> The plugin name and script file name must match e.g: plugin named `foo` should have a file called `scripts/foo.sh`
 
-# to show icons only
-set -g @tmux2k-icons-only true
+## ⚡ Setup
 
-# to enable compact window tab size
-set -g @tmux2k-compact-windows true
+### ⚙️ Requirements
 
-# to customize colors
-set -g @tmux2k-text '#cdcdcd' # change text to white
-set -g @tmux2k-bg-main '#ffffff' # change bg to white
-set -g @tmux2k-yellow '#f8c800' # change yellow color
+Before you begin, ensure you have met the following requirements:
 
-# to customize plugin colors
-set -g @tmux2k-[plugin-name]-colors "[background] [foreground]"
-set -g @tmux2k-cpu-colors "blue dark_gray"
-```
+- You have installed the latest version of `tmux`.
+- bash 5.2 or newer, mac users can install it using `brew install bash`
+- [tpm](https://github.com/tmux-plugins/tpm) for managing `tmux` plugins.
+- A [patched nerd font](https://www.nerdfonts.com/) for `powerline` and glyphs support.
 
-> You may have to restart `tmux` for some changes to reflect
+### 💻 Installation
 
-### 🖌️ Customize Colors
+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:
 
-#### Available Colors:
+```bash
+set -g @plugin '2kabhishek/tmux2k'
 
-- `text`: Default text color. Default: `#282a36`
-- `bg_main`: Background color for main sections. Default: `#15152a`
-- `bg_alt`: Background color for alternate sections. Default: `#45455a`
-- `black`: Black color. Default: `#0a0a0f`
-- `white`: White color. Default: `#d5d5da`
-- `red`: Red color. Default: `#ff001f`
-- `light_red`: Light red color. Default: `#ff0055`
-- `green`: Green color. Default: `#3dd50a`
-- `light_green`: Light green color. Default: `#ccffcc`
-- `blue`: Blue color. Default: `#1688f0`
-- `light_blue`: Light blue color. Default: `#11dddd`
-- `yellow`: Yellow color. Default: `#ffb86c`
-- `light_yellow`: Light yellow color. Default: `#ffd21a`
-- `purple`: Purple color. Default: `#bf58ff`
-- `light_purple`: Light purple color. Default: `#ff65c6`
+```
+
+- Run `tmux`
+- Use the `tpm` install command: prefix + I (default prefix is `ctrl+b`)
+
+You can also directly clone the repo to your `~/.tmux/plugins/` folder.
 
 ## 🏗️ What's Next
 
-- [ ] [Windows compatibility #8](https://github.com/2KAbhishek/tmux2k/issues/8)
-- [ ] [Theming support #9](https://github.com/2KAbhishek/tmux2k/issues/9)
+- You tell me!
 
 ## 🧑‍💻 Behind The Code
 
 ### 🌈 Inspiration
 
-I came across [dracula/tmux](https://github.com/dracula/tmux) sometime back but it didn't have everything I wanted.
+I came across [dracula/tmux](https://github.com/dracula/tmux) sometime back and I wanted to create a more customizable and easy to expand solution.
 
 ### 💡 Challenges/Learnings