tmux2k/README.md

tmux2k

Power & Pizzazz for tmux 🥊💅

tmux2k full screenshot

tmux2k statusbar screenshot

What is this

tmux2k is a tmux plugin for that adds powerline support and pretty colors to your tmux status bar.

Features

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

Add New Plugins

To add a new plugin, add a script to the scripts folder that prints something to the console.

The plugin name and script file name must match e.g: plugin named foo should have a file called scripts/foo.sh

Prerequisites

Before you begin, ensure you have met the following requirements:

• You have installed the latest version of tmux.
• tpm for managing tmux plugins.
• A patched nerd font for powerline and glyphs support.

Installing tmux2k

Using 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 '2kabhishek/tmux2k'

Add any configuration options below this line in your tmux config.

Using tmux2k

• Make sure run -b ~/.tmux/plugins/tpm/tpm is at the bottom of your .tmux.conf
• Run tmux
• Use the tpm install command: prefix + I (default prefix is ctrl+b)

Configuring tmux2k

# Left and right status bar plugins
set -g @tmux2k-left-plugins "git cpu ram"
set -g @tmux2k-right-plugins "battery network time"

#
set -g @tmux2k-show-fahrenheit false
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
set -g @tmux2k-show-powerline false # disable powerline

# change refresh rate
set -g @tmux2k-refresh-rate 5

# 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

# to customize plugin colors
set -g @tmux2k-[plugin-name]-colors "[background] [foreground]"
set -g @tmux2k-cpu-colors "blue dark_gray"

You may have to restart tmux for some changes to reflect

Colors

Available Colors:

• 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

How it was built

tmux2k was built using neovim, shellcheck, nerd-fonts.

What I learned

• Learned a lot about the tmux and tpm ecosystem.
• Did some fancy shell scripting.

Inspiration

tmux2k was inspired by dracula/tmux.

What's next

To-Do

You tell me!

🧰 Tooling

• dots2k — Dev Environment
• nvim2k — Personalized Editor
• sway2k — Desktop Environment
• qute2k — Personalized Browser

🔍 More Info

• tmux-tea — Simple and powerful tmux session manager
• tmux-tilit — Turns tmux into a terminal window manager

⭐ hit the star button if you found this useful ⭐

Source | Blog | Twitter | LinkedIn | More Links | Other Projects