🚀 Features

📦 Installation

{
 "scottmckendry/cyberdream.nvim",
 lazy = false,
 priority = 1000,
}

use { "scottmckendry/cyberdream.nvim" }

{
 require("lualine").setup({
 -- ... other config
 options = {
 theme = "auto", -- "auto" will set the theme dynamically based on the colorscheme
 },
 -- ... other config
 })
}

🚀 Usage

vim.cmd("colorscheme cyberdream")

⚙️ Configuring

require("cyberdream").setup({
 -- Set light or dark variant
 variant = "default", -- use "light" for the light variant. Also accepts "auto" to set dark or light colors based on the current value of `vim.o.background`
 -- Enable transparent background
 transparent = false,
 -- Reduce the overall saturation of colours for a more muted look
 saturation = 1, -- accepts a value between 0 and 1. 0 will be fully desaturated (greyscale) and 1 will be the full color (default)
 -- Enable italics comments
 italic_comments = false,
 -- Replace all fillchars with ' ' for the ultimate clean look
 hide_fillchars = false,
 -- Apply a modern borderless look to pickers like Telescope, Snacks Picker & Fzf-Lua
 borderless_pickers = false,
 -- Set terminal colors used in `:terminal`
 terminal_colors = true,
 -- Improve start up time by caching highlights. Generate cache with :CyberdreamBuildCache and clear with :CyberdreamClearCache
 cache = false,
 -- Override highlight groups with your own colour values
 highlights = {
 -- Highlight groups to override, adding new groups is also possible
 -- See `:h highlight-groups` for a list of highlight groups or run `:hi` to see all groups and their current values
 -- Example:
 Comment = { fg = "#696969", bg = "NONE", italic = true },
 -- More examples can be found in `lua/cyberdream/extensions/*.lua`
 },
 -- Override a highlight group entirely using the built-in colour palette
 overrides = function(colors) -- NOTE: This function nullifies the `highlights` option
 -- Example:
 return {
 Comment = { fg = colors.green, bg = "NONE", italic = true },
 ["@property"] = { fg = colors.magenta, bold = true },
 }
 end,
 -- Override colors
 colors = {
 -- For a list of colors see `lua/cyberdream/colours.lua`
 -- Override colors for both light and dark variants
 bg = "#000000",
 green = "#00ff00",
 -- If you want to override colors for light or dark variants only, use the following format:
 dark = {
 magenta = "#ff00ff",
 fg = "#eeeeee",
 },
 light = {
 red = "#ff5c57",
 cyan = "#5ef1ff",
 },
 },
 -- Disable or enable colorscheme extensions
 extensions = {
 telescope = true,
 notify = true,
 mini = true,
 ...
 },
})

Note

For a complete list of extensions, see the table in config.lua.

🎁 Extras

🧑‍🍳 Recipes

Map a key to toggle between light and dark mode

-- Add a custom keybinding to toggle the colorscheme
vim.api.nvim_set_keymap("n", "<leader>tt", ":CyberdreamToggleMode<CR>", { noremap = true, silent = true })

Create an autocmd to hook into the toggle event and run custom code

-- The event data property will contain a string with either "default" or "light" respectively
vim.api.nvim_create_autocmd("User", {
 pattern = "CyberdreamToggleMode",
 callback = function(event)
 -- Your custom code here!
 -- For example, notify the user that the colorscheme has been toggled
 print("Switched to " .. event.data .. " mode!")
 end,
})

🎨 Palette

🤝 Contributing