Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/eddyekofo94/bogster.nvim
Another Neovim colorscheme
https://github.com/eddyekofo94/bogster.nvim
Last synced: 4 months ago
JSON representation
Another Neovim colorscheme
- Host: GitHub
- URL: https://github.com/eddyekofo94/bogster.nvim
- Owner: eddyekofo94
- License: mit
- Created: 2021-07-04T01:22:51.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2021-07-06T23:48:11.000Z (over 3 years ago)
- Last Synced: 2024-05-05T15:37:19.524Z (7 months ago)
- Language: Lua
- Size: 516 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 🏙Bogster
A dark and light Neovim theme written in Lua ported from the Vim [bogster](https://github.com/wojciechkepka/bogster) theme. Includes extra themes for Kitty, Alacritty, iTerm and Fish.
## ✨ Features
- supports the latest Neovim 5.0 features like TreeSitter and LSP
- minimal inactive statusline
- vim terminal colors
- darker background for sidebar-like windows
- color configs for [Kitty](https://sw.kovidgoyal.net/kitty/conf.html?highlight=include), [Alacritty](https://github.com/alacritty/alacritty) and [Fish Shell](https://fishshell.com/)
- **lualine** theme
### Plugin Support
- [TreeSitter](https://github.com/nvim-treesitter/nvim-treesitter)
- [LSP Diagnostics](https://neovim.io/doc/user/lsp.html)
- [LSP Trouble](https://github.com/folke/lsp-trouble.nvim)
- [LSP Saga](https://github.com/glepnir/lspsaga.nvim)
- [Git Signs](https://github.com/lewis6991/gitsigns.nvim)
- [Git Gutter](https://github.com/airblade/vim-gitgutter)
- [Telescope](https://github.com/nvim-telescope/telescope.nvim)
- [NvimTree](https://github.com/kyazdani42/nvim-tree.lua)
- [WhichKey](https://github.com/liuchengxu/vim-which-key)
- [Indent Blankline](https://github.com/lukas-reineke/indent-blankline.nvim)
- [Dashboard](https://github.com/glepnir/dashboard-nvim)
- [BufferLine](https://github.com/akinsho/nvim-bufferline.lua)
- [Lualine](https://github.com/hoob3rt/lualine.nvim)
- [Lightline](https://github.com/itchyny/lightline.vim)
- [Neogit](https://github.com/TimUntersberger/neogit)
- [vim-sneak](https://github.com/justinmk/vim-sneak)
- [Fern](https://github.com/lambdalisue/fern.vim)
## ⚡️ Requirements
- Neovim >= 0.5.0
## 📦 Installation
Install the theme with your preferred package manager:
[vim-plug](https://github.com/junegunn/vim-plug)
```vim
Plug 'eddyekofo94/bogster.nvim'
```
[packer](https://github.com/wbthomason/packer.nvim)
```lua
use 'eddyekofo94/bogster.nvim'
```
## 🚀 Usage
Enable the colorscheme:
```vim
" Vim Script
colorscheme bogster
```
```lua
-- Lua
vim.cmd[[colorscheme bogster]]
```
To enable the `bogster` theme for `Lualine`, simply specify it in your lualine settings:
```lua
require('lualine').setup {
options = {
-- ... your lualine config
theme = 'bogster'
-- ... your lualine config
}
}
```
To enable the `bogster` colorscheme for `Lightline`:
```vim
" Vim Script
let g:lightline = {'colorscheme': 'bogster'}
```
## ⚙️ Configuration
> ❗️ configuration needs to be set **BEFORE** loading the color scheme with `colorscheme bogster`
| Option | Default | Description |
| ----------------------------------- | --------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| bogster_terminal_colors | `true` | Configure the colors used when opening a `:terminal` in Neovim |
| bogster_italic_comments | `true` | Make comments italic |
| bogster_italic_keywords | `true` | Make keywords italic |
| bogster_italic_functions | `false` | Make functions italic |
| bogster_italic_variables | `false` | Make variables and identifiers italic |
| bogster_transparent | `false` | Enable this to disable setting the background color |
| bogster_hide_inactive_statusline | `false` | Enabling this option, will hide inactive statuslines and replace them with a thin border instead. Should work with the standard **StatusLine** and **LuaLine**. |
| bogster_sidebars | `{}` | Set a darker background on sidebar-like windows. For example: `["qf", "vista_kind", "terminal", "packer"]` |
| bogster_dark_sidebar | `true` | Sidebar like windows like `NvimTree` get a darker background |
| bogster_dark_float | `true` | Float windows like the lsp diagnostics windows get a darker background. |
| bogster_colors | `{}` | You can override specific color groups to use other groups or a hex color |
| bogster_lualine_bold | `false` | When `true`, section headers in the lualine theme will be bold |
```lua
-- Example config in Lua
vim.g.bogster_italic_functions = true
vim.g.bogster_sidebars = { "qf", "vista_kind", "terminal", "packer" }
-- Change the "hint" color to the "orange" color, and make the "error" color bright red
vim.g.bogster_colors = { hint = "orange", error = "#ff0000" }
-- Load the colorscheme
vim.cmd[[colorscheme bogster]]
```
```vim
" Example config in VimScript
let g:bogster_italic_functions = 1
let g:bogster_sidebars = [ "qf", "vista_kind", "terminal", "packer" ]
" Load the colorscheme
colorscheme bogster
```
### Making `undercurls` work properly in **Tmux**
To have undercurls show up and in color, add the following to your **Tmux** config file:
```sh
# Undercurl
set -g default-terminal "${TERM}"
set -as terminal-overrides ',*:Smulx=\E[4::%p1%dm' # undercurl support
set -as terminal-overrides ',*:Setulc=\E[58::2::%p1%{65536}%/%d::%p1%{256}%/%{255}%&%d::%p1%{255}%&%d%;m' # underscore colours - needs tmux-3.0
```
## 🍭 Extras
Extra color configs for **Kitty**, **Alacritty**, **Fish**, **WezTerm** and **iTerm** can be found in [extras](extras/). To use them, refer to their respective documentation.
## 🔥 Contributing
Pull requests are welcome. For the `extras`, we use a simple template system that can be used to generate themes for the different styles.
How to add a new extra template:
1. create a file like `lua/bogster/extra/cool-app.lua`
2. add the name and output file extension to the `extras` table in `lua/bogster/extra/init.lua`
3. in the root directory, run `$ lua lua/bogster/extra/init.lua` to generate / update extra themes
4. commit the newly created themes under `extra/`