Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jimeh/tmux-themepack
A pack of various Tmux themes.
https://github.com/jimeh/tmux-themepack
Last synced: 6 days ago
JSON representation
A pack of various Tmux themes.
- Host: GitHub
- URL: https://github.com/jimeh/tmux-themepack
- Owner: jimeh
- Created: 2013-10-05T18:27:29.000Z (about 11 years ago)
- Default Branch: master
- Last Pushed: 2024-05-31T21:02:12.000Z (7 months ago)
- Last Synced: 2024-11-20T22:50:25.412Z (22 days ago)
- Language: Go
- Size: 121 KB
- Stars: 1,679
- Watchers: 35
- Forks: 202
- Open Issues: 29
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
- awesome-starred-test - jimeh/tmux-themepack - A pack of various Tmux themes. (Go)
- awesome-tmux - tmux-themepack
- awesome-hacking-lists - jimeh/tmux-themepack - A pack of various Tmux themes. (Go)
README
# Tmux Themepack
A pack of various themes for Tmux for 2.6 or later.
## Installation
### Install manually
1. Clone repo to local machine:
git clone https://github.com/jimeh/tmux-themepack.git ~/.tmux-themepack
2. Source desired theme in your `~/.tmux.conf`:
source-file "${HOME}/.tmux-themepack/powerline/default/green.tmuxtheme"
In some linux distributions you might have to remove the quotation marks
from the `source-file` command to avoid a `no such file or directory` error:
source-file ${HOME}/.tmux-themepack/powerline/default/green.tmuxtheme
### Install using [Tmux Plugin Manager](https://github.com/tmux-plugins/tpm)
1. Add plugin to the list of TPM plugins in `.tmux.conf`:
set -g @plugin 'jimeh/tmux-themepack'
2. Press `prefix + I` to fetch the plugin and source it. The plugin should now
be working.
Choose which theme is loaded by setting the `@themepack` option in your
`.tmux.conf`:
- `set -g @themepack 'basic'` (default)
- `set -g @themepack 'powerline/block/blue'`
- `set -g @themepack 'powerline/block/cyan'`
- `set -g @themepack 'powerline/default/green'`
- `set -g @themepack 'powerline/double/magenta'`
- `...`
## Themes
### Basic Themes
**Default (`default`):**
**Basic (`basic`):**
### Powerline Themes
Inspired by the [Powerline][] VIM plugin, and requires the use of a powerline
compatible font in your terminal. You can find a number of such fonts in the
[powerline-fonts][] project.
If your preferred font isn't available there, please refer to Powerline's
documentation on [Font Patching][] to patch the font yourself.
[powerline]: https://github.com/Lokaltog/powerline
[powerline-fonts]: https://github.com/Lokaltog/powerline-fonts
[font patching]: https://powerline.readthedocs.org/en/latest/fontpatching.html#font-patching
**Powerline Blue (`powerline/default/blue`):**
**Powerline Cyan (`powerline/default/cyan`):**
**Powerline Gray (`powerline/default/gray`):**
**Powerline Green (`powerline/default/green`):**
**Powerline Magenta (`powerline/default/magenta`):**
**Powerline Orange (`powerline/default/orange`):**
**Powerline Purple (`powerline/default/purple`):**
**Powerline Red (`powerline/default/red`):**
**Powerline Yellow (`powerline/default/yellow`):**
#### Block
Currently selected window is indicated by a colored block.
**Powerline Blue Block (`powerline/block/blue`):**
**Powerline Cyan Block (`powerline/block/cyan`):**
**Powerline Gray Block (`powerline/block/gray`):**
**Powerline Green Block (`powerline/block/green`):**
**Powerline Magenta Block (`powerline/block/magenta`):**
**Powerline Orange Block (`powerline/block/orange`):**
**Powerline Purple Block (`powerline/block/purple`):**
**Powerline Red Block (`powerline/block/red`):**
**Powerline Yellow Block (`powerline/block/yellow`):**
#### Double
Both left and right far sides of the statusbar are colored, rather than just the
left side.
**Powerline Double Blue (`powerline/double/blue`):**
**Powerline Double Cyan (`powerline/double/cyan`):**
**Powerline Double Green (`powerline/double/green`):**
**Powerline Double Magenta (`powerline/double/magenta`):**
**Powerline Double Orange (`powerline/double/orange`):**
**Powerline Double Purple (`powerline/double/purple`):**
**Powerline Double Red (`powerline/double/red`):**
**Powerline Double Yellow (`powerline/double/yellow`):**
## Customizing
All themes are built with overridable custom @-prefixed Tmux options, which
means that any part of a theme can be easily customized.
To customize a theme, simply look at the source to see the list of Tmux options
with names beginning with a `@`, and simply set the desired option in your
`tmux.conf` before the theme is loaded.
## Development / Contributing
If you want to contribute a theme, please have them use custom @-prefixed Tmux
options like existing themes, so they can be customized the same way.
New themes should be created under the `src` folder with a `.tmuxtheme`
extension. Please have a look at existing themes to see how files can be
included and shared between themes.
To build all themes, just run `make build` from the root of the project.
All themes also have unit tests which can be found under the `test`
directory. They are written in [Go](https://golang.org/), but hopefully easy to
understand. To run all tests, just run `make test` from the root of the project.
## License
```
DO WHAT THE FUCK YOU WANT TO PUBLIC LICENSE
Version 2, December 2004
Copyright (C) 2013 Jim Myhrberg
Everyone is permitted to copy and distribute verbatim or modified
copies of this license document, and changing it is allowed as long
as the name is changed.
DO WHAT THE FUCK YOU WANT TO PUBLIC LICENSE
TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
0. You just DO WHAT THE FUCK YOU WANT TO.
```