mirror of
https://github.com/TECHNOFAB11/tmux2k.git
synced 2025-12-12 08:00:08 +01:00
155 lines
4.8 KiB
Markdown
155 lines
4.8 KiB
Markdown
<div align = "center">
|
|
|
|
<h1><a href="https://2kabhishek.github.io/tmux2k">tmux2k</a></h1>
|
|
|
|
<a href="https://github.com/2KAbhishek/tmux2k/blob/main/LICENSE">
|
|
<img alt="License" src="https://img.shields.io/github/license/2kabhishek/tmux2k?style=flat&color=eee&label="> </a>
|
|
|
|
<a href="https://github.com/2KAbhishek/tmux2k/graphs/contributors">
|
|
<img alt="People" src="https://img.shields.io/github/contributors/2kabhishek/tmux2k?style=flat&color=ffaaf2&label=People"> </a>
|
|
|
|
<a href="https://github.com/2KAbhishek/tmux2k/stargazers">
|
|
<img alt="Stars" src="https://img.shields.io/github/stars/2kabhishek/tmux2k?style=flat&color=98c379&label=Stars"></a>
|
|
|
|
<a href="https://github.com/2KAbhishek/tmux2k/network/members">
|
|
<img alt="Forks" src="https://img.shields.io/github/forks/2kabhishek/tmux2k?style=flat&color=66a8e0&label=Forks"> </a>
|
|
|
|
<a href="https://github.com/2KAbhishek/tmux2k/watchers">
|
|
<img alt="Watches" src="https://img.shields.io/github/watchers/2kabhishek/tmux2k?style=flat&color=f5d08b&label=Watches"> </a>
|
|
|
|
<a href="https://github.com/2KAbhishek/tmux2k/pulse">
|
|
<img alt="Last Updated" src="https://img.shields.io/github/last-commit/2kabhishek/tmux2k?style=flat&color=e06c75&label="> </a>
|
|
|
|
<h3>Power & Pizzazz for tmux 🥊💅</h3>
|
|
|
|
<figure>
|
|
<img src= "images/screenshot-full.png" alt="tmux2k Demo">
|
|
<br/>
|
|
<figcaption>tmux2k full screenshot</figcaption>
|
|
</figure>
|
|
|
|
<figure>
|
|
<img src= "images/screenshot.png" alt="tmux2k Demo">
|
|
<br/>
|
|
<figcaption>tmux2k statusbar screenshot</figcaption>
|
|
</figure>
|
|
|
|
</div>
|
|
|
|
## 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
|
|
|
|
## Prerequisites
|
|
|
|
Before you begin, ensure you have met the following requirements:
|
|
|
|
- You have installed the latest version of `tmux`.
|
|
- [tpm](https://github.com/tmux-plugins/tpm) for managing `tmux` plugins.
|
|
- A [patched nerd font](https://www.nerdfonts.com/) 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:
|
|
|
|
```bash
|
|
set -g @plugin '2kabhishek/tmux2k'
|
|
|
|
```
|
|
|
|
Add any configuration options below this line in your tmux config.
|
|
|
|
### Activating 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
|
|
|
|
```bash
|
|
# Tmux 2K default configs
|
|
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
|
|
|
|
set -g @tmux2k-[plugin-name]-colors "[background] [foreground]"
|
|
set -g @tmux2k-cpu-colors "blue dark_gray"
|
|
|
|
# it can accept `session`, 'window`, or any string
|
|
set -g @tmux2k-start-icon ""
|
|
|
|
# network interface to watch
|
|
set -g @tmux2k-network-name "en0"/"wlo1" (Mac/Linux)
|
|
|
|
# update powerline symbols
|
|
set -g @tmux2k-show-powerline true
|
|
set -g @tmux2k-left-sep ""
|
|
set -g @tmux2k-right-sep ""
|
|
|
|
# change refresh rate
|
|
set -g @tmux2k-refresh-rate 5
|
|
|
|
```
|
|
|
|
## 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](https://github.com/dracula/tmux).
|
|
|
|
## What's next
|
|
|
|
### To-Do
|
|
|
|
You tell me!
|
|
|
|
### 🧰 Tooling
|
|
|
|
- [dots2k](https://github.com/2kabhishek/dots2k) — Dev Environment
|
|
- [nvim2k](https://github.com/2kabhishek/nvim2k) — Personalized Editor
|
|
- [sway2k](https://github.com/2kabhishek/sway2k) — Desktop Environment
|
|
- [qute2k](https://github.com/2kabhishek/qute2k) — Personalized Browser
|
|
|
|
### 🔍 More Info
|
|
|
|
- [tmux-tea](https://github.com/2kabhishek/tmux-tea) — Simple and powerful tmux session manager
|
|
- [tmux-tilit](https://github.com/2kabhishek/tmux-tilit) — Turns tmux into a terminal window manager
|
|
|
|
<div align="center">
|
|
|
|
<strong>⭐ hit the star button if you found this useful ⭐</strong><br>
|
|
|
|
<a href="https://github.com/2KAbhishek/tmux2k">Source</a>
|
|
| <a href="https://2kabhishek.github.io/blog" target="_blank">Blog </a>
|
|
| <a href="https://twitter.com/2kabhishek" target="_blank">Twitter </a>
|
|
| <a href="https://linkedin.com/in/2kabhishek" target="_blank">LinkedIn </a>
|
|
| <a href="https://2kabhishek.github.io/links" target="_blank">More Links </a>
|
|
| <a href="https://2kabhishek.github.io/projects" target="_blank">Other Projects </a>
|
|
|
|
</div>
|