https://github.com/typicode/bg.nvim

Automatically sync your terminal background with your colorscheme 🎆
https://github.com/typicode/bg.nvim

alacritty background background-color border colorscheme foot kitty-terminal lua neovim neovim-colorscheme neovim-plugin nvim terminal theme wezterm

Last synced: 2 days ago
JSON representation

Automatically sync your terminal background with your colorscheme 🎆

• Host: GitHub
• URL: https://github.com/typicode/bg.nvim
• Owner: typicode
• License: mit
• Created: 2023-01-04T05:26:48.000Z (almost 2 years ago)
• Default Branch: main
• Last Pushed: 2024-11-11T11:54:48.000Z (5 days ago)
• Last Synced: 2024-11-11T12:38:00.756Z (5 days ago)
• Topics: alacritty, background, background-color, border, colorscheme, foot, kitty-terminal, lua, neovim, neovim-colorscheme, neovim-plugin, nvim, terminal, theme, wezterm
• Language: Lua
• Homepage:
• Size: 17.6 KB
• Stars: 105
• Watchers: 3
• Forks: 7
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

README

        
# bg.nvim 🎆

> `bg.nvim` automatically syncs terminal background and cursor with any neovim colorscheme.

## Example

_Changing colorscheme with and without `bg.nvim`_

| -           |     | bg.nvim  |

| ----------- | --- | -------- |

| ![without2] | →   | ![with2] |

| ![without1] | →   | ![with1] |

[without2]: https://user-images.githubusercontent.com/5502029/211707779-f2ca5cc8-7b0f-4644-ad07-2f1faccf38b7.png

[without1]: https://user-images.githubusercontent.com/5502029/211707727-5713022d-93bc-4795-beb1-ede0d4b86839.png

[with2]: https://user-images.githubusercontent.com/5502029/211707792-ab1230ad-85b4-4b29-b956-25e5aebaa5bb.png

[with1]: https://user-images.githubusercontent.com/5502029/211707740-aceadea4-a710-4f88-9975-0244d6ef1eda.png

## Install

```lua

{ "typicode/bg.nvim", lazy = false }

```

## How it works

`bg.nvim` uses escape sequences to change your terminal background and cursor whenever you change your colorscheme. When neovim exits, it will restore the original colors.

Supported by modern terminals (alacritty, foot, gnome-terminal, kitty, wezterm, ...).

For reset colors support, [st](https://st.suckless.org/) needs to be [patched](https://pastebin.com/raw/3AthiL72).