Merge branch 'master' into current-window-status-colors

Author: Theoreticallyhugo

.github/workflows/check-syntax.yml

@@ -4,7 +4,7 @@ on: [push, pull_request]
 
 jobs:
   test:
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-latest
     steps:
     - name: checkout
       uses: actions/checkout@master

.gitignore

@@ -1 +1,2 @@
 data/weather.txt
+tmux.conf

INSTALL.md

@@ -44,232 +44,4 @@ programs.tmux = {
 
 #### Configuration
 
-To enable plugins set up the `@dracula-plugins` option in you `.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, network, network-bandwidth, network-ping, attached-clients, network-vpn, weather, time, spotify-tui, kubernetes-context
-
-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 seperator)
-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 `session`, `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
-```
-
-#### 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"
-```
-
-#### 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
-```
-
-#### 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
-```
-
-#### 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
-```
-
-#### 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
-```
-
-#### 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
-```
+The configuration options are documented on [our GitHub](https://github.com/dracula/tmux/blob/master/docs/CONFIG.md)

README.md

@@ -6,35 +6,50 @@
 
 ## Install
 
-All instructions can be found at [draculatheme.com/tmux](https://draculatheme.com/tmux).
+All instructions can be found [in the 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
 
 - 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
+- Network connection status, bandwidth, SSID and public IP (requires `curl`)
 - 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
-- GPU usage
+- CPU architecture
+- RAM usage (system and/or tmux server)
 - Custom status texts from external scripts
-- GPU VRAM usage
-- GPU power draw
-- Color code based on if prefix is active or not
-- List of windows with current window highlighted
-- When prefix is enabled smiley face turns from green to yellow
-- When charging, 'AC' is displayed
+- GPU stats
+    - usage, power draw, and VRAM usage for NVIDIA on Linux, with partial support for amd/ intel
+    - 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
 - If forecast information is available, a ☀, ☁, ☂, or ❄ unicode character corresponding with the forecast is displayed alongside the temperature
-- Spotify playback (needs the tool spotify-tui installed)
+- Read system temperature
+- Read system uptime
+- Info if the Panes are synchronized
+- Spotify playback (needs the tool spotify-tui installed). max-len can be configured.
+- Music Player Daemon status (needs the tool mpc installed)
+- Playerctl, get current track metadata
 - Current kubernetes context
+- Countdown to tmux-continuum save
 - Current working directory of tmux pane
+- Kerberos TGT expiration date
+- Show your Libre Freestyle 3 readings [Setup instructions](./scripts/libre.sh)
 
 ## Compatibility
 
@@ -45,9 +60,9 @@ FreeBSD compatibility is in development
 
 This theme is maintained by the following person(s) and a bunch of [awesome contributors](https://github.com/dracula/tmux/graphs/contributors).
 
-| [![Dane Williams](https://avatars2.githubusercontent.com/u/22798229?s=70&v=4",)](https://github.com/danerwilliams) | [![Ethan Edwards](https://avatars1.githubusercontent.com/u/60861925?s=70&v=4)](https://github.com/ethancedwards8) |
-| ------------------------------------------------------------------------------------------------------------------ | ----------------------------------------------------------------------------------------------------------------- |
-| [Dane Williams](https://github.com/danerwilliams)                                                                  | [Ethan Edwards](https://github.com/ethancedwards8)                                                                |
+| [![Ethan Edwards](https://avatars1.githubusercontent.com/u/60861925?s=70&v=4)](https://github.com/ethancedwards8) | [![Hugo Meinhof](https://avatars.githubusercontent.com/u/19731833?s=70&v=4)](https://github.com/theoreticallyhugo) | [![Dane Williams](https://avatars2.githubusercontent.com/u/22798229?s=70&v=4)](https://github.com/danerwilliams) |
+|-------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------|
+| [Ethan Edwards](https://github.com/ethancedwards8)                                                                | [Hugo Meinhof](https://github.com/theoreticallyhugo)                                                               | [Dane Williams](https://github.com/danerwilliams)                                                                |
 
 ## Community