tmux-kanagawa/README.md


# Kanagawa for [tmux](https://github.com/tmux/tmux/wiki)

[Kanagawa](https://github.com/rebelot/kanagawa.nvim/tree/master) theme for TMUX with silent colors.

Forked from [dracula/tmux](https://github.com/dracula/tmux).

![Screenshot](./screenshot.png)

## Install
To activate the theme add the following line to your `.tmux.conf`.

    set -g @plugin 'Nybkox/tmux-kanagawa'
For advanced instructions look at [INSTALL.md](https://github.com/Nybkox/tmux-kanagawa/blob/master/INSTALL.md) or check official instructions of [dracula/tmux](https://draculatheme.com/tmux).  Just replace all `dracula` occurrences with `kanagawa`.

## Configuration

Configuration and options can be found at [draculatheme.com/tmux](https://draculatheme.com/tmux).
Just replace all `dracula` occurrences with `kanagawa`.

## Features

- Support for powerline
- Day, date, time, timezone
- 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
- Git branch and status
- Battery percentage and AC power connection status
- Refresh rate control
- CPU usage (percentage or load average)
- RAM usage (system and/or tmux server)
- GPU usage
- Custom status texts from external scripts
- GPU VRAM usage
- GPU power draw
- Color code based on whether a prefix is active or not
- List of windows with the current window highlighted
- When prefix is enabled, a smiley face turns from green to yellow
- When charging, 'AC' is displayed
- If forecast information is available, a ☀, ☁, ☂, or ❄ unicode character corresponding with the forecast is displayed alongside the temperature
- Info if the Panes are synchronized
- Spotify playback (needs the tool spotify-tui installed)
- 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

## Known issues
You may need to manually give permission to plugin's scripts.
```bash
cd ~/.tmux/plugins/tmux-kanagawa
chmod u+x kanagawa.tmux
chmod u+x ./**/*.sh
```

## Compatibility

Compatible with macOS and Linux. Tested on tmux 3.1b
FreeBSD compatibility is in development

## License

[MIT License](./LICENSE)
chore: update README.md 2023-12-23 09:55:14 +01:00
chore: update readme 2023-12-21 03:34:50 +01:00			`# Kanagawa for [tmux](https://github.com/tmux/tmux/wiki)`
changed readme 2020-03-31 08:46:17 +02:00
chore: update readme 2023-12-21 03:34:50 +01:00			`[Kanagawa](https://github.com/rebelot/kanagawa.nvim/tree/master) theme for TMUX with silent colors.`

			`Forked from [dracula/tmux](https://github.com/dracula/tmux).`
Standardize README 2020-04-08 02:08:54 +02:00
			`![Screenshot](./screenshot.png)`

changed readme 2020-03-31 08:46:17 +02:00			`## Install`
chore: update README.md 2023-12-23 09:55:14 +01:00			To activate the theme add the following line to your `.tmux.conf`.
changed readme 2020-03-31 08:46:17 +02:00
chore: update README.md 2023-12-23 09:55:14 +01:00			`set -g @plugin 'Nybkox/tmux-kanagawa'`
			For advanced instructions look at [INSTALL.md](https://github.com/Nybkox/tmux-kanagawa/blob/master/INSTALL.md) or check official instructions of [dracula/tmux](https://draculatheme.com/tmux). Just replace all `dracula` occurrences with `kanagawa`.
Standardize README 2020-04-08 02:08:54 +02:00
moved config instructions to INSTALL.md 2020-04-21 02:56:46 +02:00			`## Configuration`

			`Configuration and options can be found at [draculatheme.com/tmux](https://draculatheme.com/tmux).`
chore: update readme 2023-12-21 03:34:50 +01:00			Just replace all `dracula` occurrences with `kanagawa`.
moved config instructions to INSTALL.md 2020-04-21 02:56:46 +02:00
changed readme 2020-03-31 08:46:17 +02:00			`## Features`

:memo: Update readme 2022-03-21 02:37:01 +01:00			`- Support for powerline`
			`- Day, date, time, timezone`
			`- Current location based on network with temperature and forecast icon (if available)`
			`- Network connection status, bandwidth and SSID`
docs: Add documentation for ssh-session plugin 2023-10-12 00:10:36 +02:00			`- SSH session user, hostname and port of active tmux pane`
:memo: Update readme 2022-03-21 02:37:01 +01:00			`- Git branch and status`
			`- Battery percentage and AC power connection status`
			`- Refresh rate control`
			`- CPU usage (percentage or load average)`
Add tmux-ram-usage feature to README.md 2023-06-17 23:17:43 +02:00			`- RAM usage (system and/or tmux server)`
:memo: Update readme 2022-03-21 02:37:01 +01:00			`- GPU usage`
Add 'custom' status plugin to get status texts from external scripts. 2022-07-10 19:51:32 +02:00			`- Custom status texts from external scripts`
add new features to README.md 2023-04-26 16:52:25 +02:00			`- GPU VRAM usage`
			`- GPU power draw`
Update README.md Grammatical changes 2023-10-02 18:07:35 +02:00			`- Color code based on whether a prefix is active or not`
			`- List of windows with the current window highlighted`
			`- When prefix is enabled, a smiley face turns from green to yellow`
:memo: Update readme 2022-03-21 02:37:01 +01:00			`- When charging, 'AC' is displayed`
			`- If forecast information is available, a ☀, ☁, ☂, or ❄ unicode character corresponding with the forecast is displayed alongside the temperature`
Merge branch 'master' into synchronize-panes 2022-10-28 22:03:06 +02:00			`- Info if the Panes are synchronized`
Merge branch 'master' into spotify-tui 2022-10-28 22:12:51 +02:00			`- Spotify playback (needs the tool spotify-tui installed)`
feat: Added MPC documentation 2023-10-19 12:35:49 +02:00			`- Music Player Daemon status (needs the tool mpc installed)`
feat: Added playerctl plugin 2024-04-03 12:27:48 +02:00			`- Playerctl, get current track metadata`
Merge branch 'master' into kubernetes-context 2022-10-28 22:04:49 +02:00			`- Current kubernetes context`
Add tmux-continuum feature to README.md 2023-06-17 23:28:39 +02:00			`- Countdown to tmux-continuum save`
Add cwd.sh to display the tmux pane's current working directory, updated README to reflect change 2023-04-08 02:40:53 +02:00			`- Current working directory of tmux pane`
changed readme 2020-03-31 08:46:17 +02:00
chore: update README.md 2023-12-23 11:08:39 +01:00			`## Known issues`
			`You may need to manually give permission to plugin's scripts.`
			```bash
			`cd ~/.tmux/plugins/tmux-kanagawa`
			`chmod u+x kanagawa.tmux`
			`chmod u+x ./*/.sh`
			```

changed readme 2020-03-31 08:46:17 +02:00			`## Compatibility`

Bump Tested tmux version and adding FreeBSD update 2020-09-07 00:39:32 +02:00			`Compatible with macOS and Linux. Tested on tmux 3.1b`
			`FreeBSD compatibility is in development`
[Feature] Provides ability to disable weather fetching and display Personally, displying the weather doesn't have a lot of use for me but additionally I ran into an issue where the API you are using ratelimited call from my IP address, I guess because it was overfetching. This doesn't fix the ratelimited issue, but instead at least gives people the ability to turn the feature off. Test Plan: In `~/.tmux.conf` set the following: ``` set -g @plugin 'tmux-plugins/tpm' set -g @dracula-show-weather false set -g @plugin 'camspiers/tmux' run -b '~/.local/share/tmux/plugins/tpm/tpm' ``` Ensure that weather module no longer loads. In `~/.tmux.conf` set the following: ``` set -g @plugin 'tmux-plugins/tpm' set -g @dracula-show-weather true set -g @plugin 'camspiers/tmux' run -b '~/.local/share/tmux/plugins/tpm/tpm' ``` Ensure that weather module does stil load. 2020-04-10 03:29:29 +02:00
changed readme 2020-03-31 08:46:17 +02:00			`## License`

Update README.md 2020-04-07 19:40:31 +02:00			`[MIT License](./LICENSE)`