Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/vimpostor/vim-lumen
Make vim follow your system-wide dark mode preference
https://github.com/vimpostor/vim-lumen
colorscheme dark-mode neovim neovim-plugin nvim vim vim-plugin
Last synced: 3 days ago
JSON representation
Make vim follow your system-wide dark mode preference
- Host: GitHub
- URL: https://github.com/vimpostor/vim-lumen
- Owner: vimpostor
- License: gpl-3.0
- Created: 2022-04-19T13:01:27.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2024-09-19T21:43:44.000Z (4 months ago)
- Last Synced: 2025-01-02T06:08:59.305Z (10 days ago)
- Topics: colorscheme, dark-mode, neovim, neovim-plugin, nvim, vim, vim-plugin
- Language: Vim Script
- Homepage:
- Size: 125 KB
- Stars: 97
- Watchers: 3
- Forks: 3
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# vim-lumen
This plugin enables vim to follow the global system-wide dark mode preference of your platform.
https://user-images.githubusercontent.com/21310755/225781457-2a1e4f26-fbd5-4c08-a75e-2c2f931488b3.mp4
Supported platforms are **Linux**, **MacOS** and **Windows**. All platform implementations are interrupt-based and do not use any resources in the background because they avoid polling and use the proper system APIs instead.
# Installation
With `vim-plug` add the following line to your `.vimrc`:
```vim
Plug 'vimpostor/vim-lumen'
```
Once a system dark mode preference change is detected, this plugin will set the `background` vim option accordingly, so make sure that your colorscheme supports reloading as described in `:h 'background'`.
# Dependencies
## Linux
On Linux it is required that you have `gdbus` installed together with **one** of the following options:
- KDE Plasma 5.24 (or later) or
- Gnome 42 (or later) or
- [darkman](https://gitlab.com/WhyNotHugo/darkman) (Recommended for tiling WMs) or
- [color-scheme-simulator](https://gitlab.gnome.org/exalm/color-scheme-simulator)
Make sure that the `xdg-desktop-portal` is running.
## MacOS
It is required that Swift is available on your system. Swift is shipped with Xcode for example.
## Windows
At least Windows 10 1903 is required. No further installed components are needed.
This also works inside WSL2.
# FAQ
## How can I add custom callbacks?
You can use the `LumenLight` and `LumenDark` `User` autocommands:
```vim
au User LumenLight echom 'Entered light mode'
au User LumenDark echom 'Entered dark mode'
```
Note that for the common usecase of switching the colorscheme, there are the `g:lumen_light_colorscheme` and `g:lumen_dark_colorscheme` variables.
## What are some good light colorschemes?
There are not many colorschemes that work well both in light and dark mode.
Here are some example colorschemes that I can personally recommend:
- [everforest](https://github.com/sainnhe/everforest)
- [papercolor](https://github.com/NLKNguyen/papercolor-theme)
- [prism](https://github.com/vimpostor/vim-prism)
- `retrobox` from the [default Vim colorschemes](https://github.com/vim/colorschemes)
## Why not use the new SIGWINCH autocmd in neovim?
Neovim recently merged [support for SIGWINCH autocmds](https://github.com/neovim/neovim/pull/18029). It is possible to hack together dark mode support by abusing the `SIGWINCH` autocmd, but this has quite a few disadvantages:
- You require a terminal that sends `SIGWINCH` when the system-wide dark mode preference changes. At the moment, pretty much no terminal supports this besides `iTerm`
- The `SIGWINCH` event is fired regularly for other events. For example while resizing the window, `SIGWINCH` can be emitted many times per second, which causes performance issues due to checking the system dark mode preference multiple times per second
- `SIGWINCH` is not really intended for this usecase at all. You are abusing a signal that is originally only meant to be fired when the terminal size changes
- There is only `SIGWINCH` support in `neovim`, whereas this plugin also supports regular vim