Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/psliwka/termcolors.nvim
generate colors for your terminal from any Neovim colorscheme π
https://github.com/psliwka/termcolors.nvim
kitty kitty-terminal neovim neovim-plugin terminal terminal-emulator
Last synced: about 2 months ago
JSON representation
generate colors for your terminal from any Neovim colorscheme π
- Host: GitHub
- URL: https://github.com/psliwka/termcolors.nvim
- Owner: psliwka
- License: mit
- Created: 2021-12-26T21:29:45.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2024-02-23T22:33:35.000Z (7 months ago)
- Last Synced: 2024-06-25T22:41:51.231Z (3 months ago)
- Topics: kitty, kitty-terminal, neovim, neovim-plugin, terminal, terminal-emulator
- Language: Lua
- Homepage:
- Size: 191 KB
- Stars: 36
- Watchers: 2
- Forks: 3
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Termcolors.nvim β generate colors for your terminal from any Neovim colorscheme :rainbow:
This Neovim plugin generates color schemes for terminal emulators. It is
primarily meant to help Neovim colorscheme creators to easily provide
good-looking matching terminal colorschemes as extras. It can also be used by
end users, to create an appropriate config for their terminal in case the
colorscheme of their choice does not come with such extra themes on its own. Is
your editor already pretty, but your terminal seems off? You might want to give
_termcolors.nvim_ a try!
 _termcolors.nvim output,
additionally colorized by [colorizer.lua]_
[colorizer.lua]: https://github.com/norcalli/nvim-colorizer.lua
## Installation
Install the plugin using your favorite plugin manager, for example [vim-plug]:
```
Plug 'psliwka/termcolors.nvim'
```
Alternatively, you may run this plugin without installing. For details, see the
[Using standalone](#using-standalone) section.
## Using as plugin
1. Configure Neovim to use colorsheme of your choice
2. Ensure your `'background'` is set correctly (i.e. is set to `dark` or `light`
to match your actual colorscheme background)
3. Run `:TermcolorsShow` command and copy resulting code to your terminal's
config file
4. Restart your terminal, or tell it to reload its config file (e.g.
`ctrl+cmd+.` for kitty)
## Using standalone
As this plugin is rarely needed in your daily work (you usually use it once,
when you switch your colorscheme and/or terminal program), it usually makes
sense to run in directly from the repository, without cluttering your
`init.lua`. To do so:
1. Clone this repository and `cd` into it
2. Run `make `, for example `make kitty`
3. Update your terminal configuration as described in the previous section
## Advanced Configuration
In order to configure Termcolors for your specific usage you can call
```
require'termcolors'.setup {
-- If you write your own plugin, you can declare it here so Termcolors
-- is aware of it
--
-- Otherwise you don't need to specify this option at all
plugins = {
["my_custom_plugin_name"] = require'path_to_your_plugin_module'
},
-- The name of the default plugin you wish to use.
-- If not specified, it'll be set to `kitty`
default_plugin = "my_custom_plugin_name"
}
```
## Plugins
Termcolors ships with three plugins:
* kitty
* alacritty
* termux
To call the generator for a sepecific plugin you can run
`:TermcolorsShow ` and it'll generate output for the terminal that
plugin is for.
Calling `:TermcolorsShow` without an argument will instead use the configured
default plugin to generate output
## Development status
Right now, this project is in its infancy. It supports the following terminal
emulators:
- [kitty](https://github.com/kovidgoyal/kitty)
- [alacritty](https://github.com/alacritty/alacritty)
- [termux](https://termux.dev)
Additionally, its heuristics for detecting proper colors for various terminal
elements may not work for all colorschemes. So far, it has been tested and
confirmed to work for the following themes:
- [doom-one.nvim](https://github.com/NTBBloodbath/doom-one.nvim)
These two lists will hopefully expand in the future. Feel encouraged to submit
PRs! :wink:
## Credits
Created by [Piotr Εliwka](https://github.com/psliwka).
Some color processing code (for generating pretty terminal's tabline background)
has been taken from [bufferline.nvim].
[bufferline.nvim]: https://github.com/akinsho/bufferline.nvim
## License
[MIT](LICENSE)