https://github.com/tamton-aquib/zone.nvim

Screensaver plugin for neovim.
https://github.com/tamton-aquib/zone.nvim

hacktoberfest neovim neovim-plugin nvim plugin

Last synced: 16 days ago
JSON representation

Screensaver plugin for neovim.

• Host: GitHub
• URL: https://github.com/tamton-aquib/zone.nvim
• Owner: tamton-aquib
• License: mit
• Created: 2022-05-03T14:27:31.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2024-03-10T15:13:01.000Z (8 months ago)
• Last Synced: 2024-08-01T16:44:33.676Z (4 months ago)
• Topics: hacktoberfest, neovim, neovim-plugin, nvim, plugin
• Language: Lua
• Homepage:
• Size: 35.2 KB
• Stars: 254
• Watchers: 6
• Forks: 7
• Open Issues: 7
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# ZONE

A screensaver plugin for neovim. Inspiration from: [emacs-zone](https://www.emacswiki.org/emacs/ZoneMode).


Currently WIP. Has some bugs.

#### Requirements:

- Neovim version >= 0.8

#### Installation:

```lua

use { 'tamton-aquib/zone.nvim' }

```

#### Usage:

```lua

require("zone").setup()

```

 Click here to see default configuration 

```lua

require('zone').setup {

    style = "treadmill",

    after = 30,          -- Idle timeout

    exclude_filetypes = { "TelescopePrompt", "NvimTree", "neo-tree", "dashboard", "lazy" },

    -- More options to come later

    treadmill = {

        direction = "left",

        headache = true,

        tick_time = 30,     -- Lower, the faster

        -- Opts for Treadmill style

    },

    epilepsy = {

        stage = "aura",     -- "aura" or "ictal"

        tick_time = 100,

    },

    dvd = {

        -- text = {"line1", "line2", "line3", "etc"}

        tick_time = 100,

        -- Opts for Dvd style

    },

    -- etc

}

```

#### Showcase:

> Treadmill

https://user-images.githubusercontent.com/77913442/214005406-e5f6e311-8868-44c9-a0a9-3d3640222364.mp4

> Dvd

![zone_dvd](https://user-images.githubusercontent.com/77913442/166483923-94488f6a-5a11-4d01-8ff2-a9b2df929964.gif)

> Epilepsy

https://user-images.githubusercontent.com/77913442/214006320-bd2a1c50-b722-44b1-a453-9d817eb68bbe.mp4

> Vanish

![zone_vanish](https://user-images.githubusercontent.com/77913442/166484010-62037c22-983e-473d-b66c-d5ccf563102f.gif)

#### Note:

> ❗ This plugin wont eat the current buffer. It just emulates the content as a cover on top.

### Todo:

Moved to [todo.norg](https://github.com/tamton-aquib/zone.nvim/blob/main/todo.norg)