tamton-aquib / zone.nvim

Screensaver plugin for neovim.

ZONE

A screensaver plugin for neovim. Inspiration from: emacs-zone.
Currently WIP. Has some bugs.

Requirements:

• Neovim version >= 0.8

Installation:

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

Usage:

require("zone").setup()

Click here to see default configuration

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

treadmill.mp4

Dvd

Epilepsy

epilepsy.mp4

Vanish

Note:

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

Todo:

Moved to todo.norg