copilot-eldritch.nvim

A Lovecraftian-themed spinner for Copilot in Neovim. Shows fleeting, changing eldritch glyphs while Copilot is working in the background.

Preview

Installation

Add this as a dependency of copilot.lua.

Note: You must call require("copilot-eldritch").setup() AFTER require("copilot").setup().

Using lazy.nvim:

{
    "zbirenbaum/copilot.lua",
    dependencies = { "samiulsami/copilot-eldritch.nvim" },
    config = function()
        require("copilot").setup({...})
        require("copilot-eldritch").setup()
    end
}

Default options

{
	-- Maximum length of the generated string.
	max_length = 73,

	-- Minimum length of the generated string.
	min_length = 1,

	-- Maximum random distance from the cursor position to start drawing glyphs.
	max_distance_from_cursor = 10,

	-- Maximum number of lines (vertical) to spread the across.
	max_lines = 3,

	-- Base speed of the animation tick in milliseconds.
	repeat_ms = 50,

	-- Random jitter added to repeat_ms for the flickering disappearance effect (0 to N ms).
	jitter_ms = 100,

	-- The highlight group used for the text.
	-- By default, the foreground color is randomized based on colors.
	rand_hl_group = "CopilotEldritchHLGroup",

	-- RGB ranges for the random text color.
	-- Contains red, green, blue, each with min and max (0-255).
	colors = {
		red = { min = 133, max = 255 },
		green = { min = 0, max = 0 },
		blue = { min = 68, max = 68 },
	},

	-- A list of strings (glyphs) or a list of lists.
	-- If a list of lists is provided, a random set is chosen per activation.
	-- See source for default glyphs.
	chars = { ... }
}

Random Character Sets

You can provide a "list of lists" to chars to have the plugin pick a random "theme" or character set every time Copilot starts working.

require("copilot-eldritch").setup({
    chars = {
        { "a", "b", "c" },
        { "1", "2", "3" },
        { "!", "@", "#" },
    }
})

Credits

• Inspired by copilot-lualine