https://github.com/nstefan002/donut.nvim
donut.c meets Neovim
https://github.com/nstefan002/donut.nvim
donut lua luarocks neovim-plugin screensaver
Last synced: 3 months ago
JSON representation
donut.c meets Neovim
- Host: GitHub
- URL: https://github.com/nstefan002/donut.nvim
- Owner: NStefan002
- License: mit
- Created: 2024-03-31T00:00:49.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-05-07T19:22:58.000Z (over 1 year ago)
- Last Synced: 2024-05-07T20:31:46.547Z (over 1 year ago)
- Topics: donut, lua, luarocks, neovim-plugin, screensaver
- Language: Lua
- Homepage:
- Size: 32.2 KB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
Awesome Lists containing this project
README
# Donut.nvim
> donut.c meets Neovim
Donut.nvim is the Neovim screensaver that spawns a spinning donut in each opened Neovim window.
> [!NOTE]
>
> donut.nvim does not change any of the buffers, it just creates new buffers on top of existing ones
and after you press any key it restores your buffers.
## 📺 Showcase
https://github.com/NStefan002/donut.nvim/assets/100767853/3b60a4ef-5517-4195-a6d2-dda32dde5785
## 📋 Installation
> [!NOTE]
>
> - Neovim version >= 0.9.5 is required.
> - No need to call `setup` function, donut.nvim is ready to use out of the box.
> - Only call `setup` function if you want to change the default configuration.
> - No need to lazy load it via Lazy.nvim, donut.nvim lazy loads by default.
[lazy](https://github.com/folke/lazy.nvim):
```lua
{
"NStefan002/donut.nvim",
version = "*",
lazy = false,
}
```
[rocks.nvim](https://github.com/nvim-neorocks/rocks.nvim):
`:Rocks install donut.nvim`
## ⚙️ Configuration
Default configuration
```lua
{
timeout = 300,
sync_donuts = false,
}
```
\
If you want to change the default configuration, you can call the `setup` function.
```lua
require("donut").setup({
timeout = 60, -- set to 0 to disable (can still be triggered manually with :Donut command)
sync_donuts = true,
}
```
or you can just set `vim.g.donut_config` to a table with the configuration you want.
```lua
vim.g.donut_config = { timeout = 30, sync_donuts = false }
```
## ❓ How does it work?
- After the timeout, donut.nvim will spawn a donut for each opened window.
- When you press any key, donut.nvim will clear all the donuts and restore your buffers.
- If you have `sync_donuts` set to `true`, the donuts will spin in sync.
- If you want to manually trigger the donuts, you can call `:Donut` command.
## 🎭 Inspiration
- [donut.c](https://www.a1k0n.net/2011/07/20/donut-math.html)
## Other Neovim screensavers
- [zone](https://github.com/tamton-aquib/zone.nvim)
- [cellular-automaton](https://github.com/Eandrju/cellular-automaton.nvim)
- [drop](https://github.com/folke/drop.nvim)
- ~~[I'm waiting for this one](https://www.reddit.com/r/neovim/comments/1bsebep/raining_inside_neovim/)~~ [rain](https://github.com/tamton-aquib/stuff.nvim/blob/main/lua/rain.lua) module from [stuff.nvim](https://github.com/tamton-aquib/stuff.nvim)