Animated :intro for Neovim

Installation | Documentation | Presets | Showcase

In my experience, after installing a new start screen plugin I will most likely end up writing helper functions for myself to better customise the plugin. This was a problem as I would have to change the helper functions every time I eventually needed to switch to a different plugin(either due to lack of features or not providing more customisation).

Some of the plugins are easy to set up but comes at the cost of you can't really change it much. Other have more customisation but don't have an easy way to set up.

I also couldn't find any plugin which provided a way to add gradients to the texts which I really wanted.

Key features of this plugin.

• Easily show recently opened files, add keymaps, text arts etc. without having to write everything from scratch.
• Gradient colors! If you have experience with something like lolcat or wanted gradients in your text then you are going to like this plugin. Plus unlike other plugins this one also has helper functions to make the entire process easier.
• Minimal config. If you aren't crazy about customisation and just want something simple and easy to set up then you can use one of the presets. But they are not like your normal presets as they do provide customisation of the presets in case you want it.
• Simple animations. The plugin provides a way to make simple color based animations(along with some text based ones, this is a work in progress though).
• Complete timing control over animations. This plugin not only provides options to control when the animations start but it also allows you to control them for individual animations too if you want.

-- plugins.lua
{
  "OXY2DEV/intro.nvim",
  -- For file icons
  dependencies= {
    "nvim-tree/nvim-web-devicons"
  },
  config = function ()
    require("intro").setup();
  end
}

-- plugins/intro.lua
return {
  "OXY2DEV/intro.nvim",
  dependencies = {
    "nvim-tree/nvim-web-devicons"
  },
  config = function ()
    require("intro").setup();
  end
}

-- depe.lua
require("mini.deps").add({
  source = "OXY2DEV/intro.nvim",
  depends = {
    "nvim-tree/nvim-web-devicons"
  }
})

require("intro").setup();

If you want to quickly set up the plugin and don't want any of the hassle of customisation then this section is for you.

Presets are applied like this.

require("intro").setup({
  preset = {
    name = "",  -- Name of the preset
    opts = {}   -- Options of the preset to use
  }
})

-- If you don't want customisation you can use this
require("intro").setup({
  preset = ""   -- Name of the preset
})

The presets are available in the /lua/intro/presets.lua file in the plugin.

Currently available presets are,

• nvim
  1. animated
• nvim_mini
  1. animated
  2. dark_alt
  3. dark_alt_animated
• startify(based on vim-strtify)
  1. green
  2. red
  3. pink
  4. flamingo
  5. gradient_blue_green
  6. gradient_endless_river(taken from uiGradients)
  7. gradient_friday(taken from uiGradients)
  8. recent_files
  9. recent_files_current_dir
  10. list_shade
• cats(they are in rows x columns structure)
  1. c1x2
  2. c1x3
  3. c1x4
  4. c2x2
  5. c3x3
  6. c3x1
  7. rosewater
  8. rosewater_alt
  9. mauve
  10. mauve_alt
  11. yellow
  12. yellow_alt
  13. green
  14. green_alt
  15. blue
  16. blue_alt
  17. all_the_colors
  18. all_the_colors_alt
• hydra(based on the "Evil" theme of startup.nvim)
  1. animated

More presets are going to be added in the future. If you want a specific type of preset you can open an issue for it.