astral.nvim is a Neovim plugin for colorscheme management.
This very simple plugin allows Neovim to remember the last used colorscheme and restore it when Neovim opens.
- Remembers the last used colorscheme and restores it when Neovim opens.
- Allows setting fallback themes if the saved colorscheme is not available.
Using lazy.nvim, add the plugin to your configuration:
require("lazy").setup({
{
"astral/astral.nvim",
version = "*", -- Pin to GitHub releases
},
})You can configure the astral plugin by passing a table of options to require("astral").setup().
The default values for astral configuration are:
local config = {
restore_colors = true, -- Enable or disable automatic colorscheme restoration
fallback_themes = { -- Default fallback themes
"catppuccin",
"tokyonight",
"default"
},
}To set the options for astral,
use the following lazy.nvim configuration:
require("lazy").setup({
{
"astral/astral.nvim",
version = "*", -- Pin to GitHub releases
opts = {
restore_colors = true, -- Set to false to disable colorscheme restoration
fallback_themes = { -- Customize fallback themes
"catppuccin",
"tokyonight",
"default"
},
}
},
}):Astral reset: Reset the colorscheme management.
- ColorScheme: Store the new name when the colorscheme changes.
If you encounter issues with astral.nvim, here are some common problems and solutions:
-
Colorscheme not restoring on startup:
- Ensure
restore_colorsis set totruein the configuration. - Check if the
settings.jsonfile exists in thedatapath (vim.fn.stdpath("data") .. "/lazy/astral.nvim/settings.json"). If not, the plugin should create it automatically.
- Ensure
-
Fallback themes not applied:
- Verify that the
fallback_themesarray in the configuration contains valid colorscheme names. - Ensure that the fallback themes are installed and available in Neovim.
- Verify that the
-
Unknown Astral command error:
- Ensure you are using valid commands. The available command is
:Astral reset.
- Ensure you are using valid commands. The available command is
-
Colorscheme changes not saved:
- Ensure there are no errors in the autocommand that triggers
on the
ColorSchemeevent. - Check if the
settings.jsonfile is writable and that your Neovim configuration allows writing to this path.
- Ensure there are no errors in the autocommand that triggers
on the
If the issue persists, please open an issue on the GitHub repository with details about your configuration and the problem you are facing.
astral.nvim is licensed under the MIT License. See LICENSE for details.
Contributions are welcome! Please open an issue or submit a pull request to the GitHub repository.
