{"id":21917178,"url":"https://github.com/oxy2dev/intro.nvim","last_synced_at":"2025-07-05T04:33:32.284Z","repository":{"id":229650860,"uuid":"776745072","full_name":"OXY2DEV/intro.nvim","owner":"OXY2DEV","description":null,"archived":false,"fork":false,"pushed_at":"2024-04-12T00:43:32.000Z","size":41,"stargazers_count":14,"open_issues_count":0,"forks_count":1,"subscribers_count":1,"default_branch":"main","last_synced_at":"2024-04-12T23:36:07.194Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Lua","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/OXY2DEV.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null}},"created_at":"2024-03-24T11:23:36.000Z","updated_at":"2024-04-15T08:46:39.142Z","dependencies_parsed_at":"2024-03-27T23:24:23.882Z","dependency_job_id":"1cd8e7e4-f9c6-4282-8654-e2ff66244924","html_url":"https://github.com/OXY2DEV/intro.nvim","commit_stats":null,"previous_names":["oxy2dev/intro.nvim"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OXY2DEV%2Fintro.nvim","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OXY2DEV%2Fintro.nvim/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OXY2DEV%2Fintro.nvim/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OXY2DEV%2Fintro.nvim/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/OXY2DEV","download_url":"https://codeload.github.com/OXY2DEV/intro.nvim/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":249638251,"owners_count":21304305,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-28T19:28:31.832Z","updated_at":"2025-04-19T07:35:37.889Z","avatar_url":"https://github.com/OXY2DEV.png","language":"Lua","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003e[!IMPORTANT]\n\u003e This plugin will **not** be updated(most likely). Making this plugin, I have understood the limitations of myself and neovim.\n\u003e The whole plugin was basically kept together with duct tape for the most part. Even though I tried my best, I couldn't make the plugin as good as I wanted.\n\u003e The animation system is **very** primitive. The plugin isn't fast.\n\u003e The plugin can randomly crash on update(when `lazy.nvim` is used). Plus the code is basically spaghetti.\n\u003e\n\u003e So, I will go learn new things, experiment a lot and hopefully make a better version in the future.\n\n---\n\nhttps://github.com/OXY2DEV/intro.nvim/assets/122956967/b2ffb4ca-d543-46f6-8d7c-c4dbd42caa56\n\n\u003ch1 align=\"center\"\u003eIntro.nvim\u003c/h1\u003e\n\u003cp align=\"center\"\u003eAnimated \u003ccode\u003e:intro\u003c/code\u003e for Neovim\u003c/p\u003e\n\n\u003cp align=\"center\"\u003e\n  \u003ca href=\"#install\"\u003eInstallation\u003c/a\u003e | \u003ca href=\"DOC.md\"\u003eDocumentation\u003c/a\u003e | \u003ca href=\"#presets\"\u003ePresets\u003c/a\u003e | \u003ca href=\"#showcase\"\u003eShowcase\u003c/a\u003e\n\u003c/p\u003e\n\n\u003ch2\u003e🏝️ Introduction\u003c/h2\u003e\n\n\u003e[!NOTE]\n\u003e This plugin was made **entirely** inside termux. So, I may or may *not* be able to reproduce your issue due to *hardware limitations*. So, It would really help me debug the issues if you add **extra details** to your issues(e.g. **explaining what happens** instead of the plugin starting, **attaching a video** of the bug, what machine you are using etc.).\n\n\u003e[!WARNING]\n\u003e This plugin was meant to be used inside **termux** so some things may be a *little bit* off when used somewhere else.\n\nIn 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).\n\nSome 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.\n\nI also couldn't find any plugin which provided a way to add `gradients` to the texts which I really wanted.\n\nKey features of this plugin.\n- Easily show recently opened files, add keymaps, text arts etc. without having to write everything from scratch.\n- 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.\n- 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.\n- 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).\n- 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.\n\n\n\u003ch2 id=\"install\"\u003e💻 Installation\u003c/h2\u003e\n\u003ch3\u003e💤 Lazy\u003c/h3\u003e\n\n\u003e[!WARNING]\n\u003e Do not lazy load the plugin. \n\u003e \n\u003e The plugin should run before other plugins so by setting `lazy = false` the plugin won't get the chance to load.\n\n```lua\n-- plugins.lua\n{\n  \"OXY2DEV/intro.nvim\",\n  -- For file icons\n  dependencies= {\n    \"nvim-tree/nvim-web-devicons\"\n  },\n  config = function ()\n    require(\"intro\").setup();\n  end\n}\n```\n\n```lua\n-- plugins/intro.lua\nreturn {\n  \"OXY2DEV/intro.nvim\",\n  dependencies = {\n    \"nvim-tree/nvim-web-devicons\"\n  },\n  config = function ()\n    require(\"intro\").setup();\n  end\n}\n```\n\n\u003ch3\u003e🧰 Mini.deps\u003c/h3\u003e\n\n```lua\n-- depe.lua\nrequire(\"mini.deps\").add({\n  source = \"OXY2DEV/intro.nvim\",\n  depends = {\n    \"nvim-tree/nvim-web-devicons\"\n  }\n})\n\nrequire(\"intro\").setup();\n```\n\n\u003ch2 id=\"presets\"\u003e🧩 Presets\u003c/h2\u003e\n\nIf you want to `quickly set up` the plugin and don't want any of the hassle of customisation then this section is for you.\n\nPresets are applied like this.\n```lua\nrequire(\"intro\").setup({\n  preset = {\n    name = \"\",  -- Name of the preset\n    opts = {}   -- Options of the preset to use\n  }\n})\n\n-- If you don't want customisation you can use this\nrequire(\"intro\").setup({\n  preset = \"\"   -- Name of the preset\n})\n```\n\nThe presets are available in the `/lua/intro/presets.lua` file in the plugin.\n\n\u003e[!TIP]\n\u003eItems that have a • in front of them are the preset name and the items that are numbered are the options for that preset.\n\n\u003e[!NOTE]\n\u003e The order in the `opts` matters. Some options have the ability to overwrite the values set by other options. This becomes more apparent in case there are options that add components to the screen. In this case, the option that came first in the list will have it components added first.\n\u003e \n\u003e As such it is recommended you follow the order of options when using them. So, an option whose list number is less should be added first.\n\nCurrently available `presets` are,\n- nvim\n  1. animated\n- nvim_mini\n  1. animated\n  1. dark_alt\n  2. dark_alt_animated\n- startify(based on `vim-strtify`)\n  1. green\n  2. red\n  3. pink\n  4. flamingo\n  5. gradient_blue_green\n  6. gradient_endless_river(taken from `uiGradients`)\n  7. gradient_friday(taken from `uiGradients`)\n  8. recent_files\n  9. recent_files_current_dir\n  10. list_shade\n- cats(they are in `rows x columns` structure)\n  1. c1x2\n  2. c1x3\n  3. c1x4\n  4. c2x2\n  5. c3x3\n  6. c3x1\n  7. rosewater\n  8. rosewater_alt\n  9. mauve\n  10. mauve_alt\n  11. yellow\n  12. yellow_alt\n  13. green\n  14. green_alt\n  15. blue\n  16. blue_alt\n  17. all_the_colors \n  19. all_the_colors_alt\n- hydra(based on the \"Evil\" theme of `startup.nvim`)\n  1. animated\n\nMore `presets` are going to be added in the future. If you want a specific type of preset you can open an `issue` for it.\n\n\u003ch2 id=\"showcase\"\u003e🌌 Plugin showcase\u003c/h2\u003e\n\u003ch3\u003eImages\u003c/h3\u003e\n\n\u003e[!NOTE]\n\u003e The images were taken on my phone so they can be a bit blurry.\n\n![Screenshot_1](https://github.com/OXY2DEV/intro.nvim/blob/assets/images/plugin_img_1.jpg)\n\n![Screenshot_1_L](https://github.com/OXY2DEV/intro.nvim/blob/assets/images/plugin_img_1_large.jpg)\n\n![Screenshot_2_L](https://github.com/OXY2DEV/intro.nvim/blob/assets/images/plugin_img_2_large.jpg)\n\n![Screenshot_3_L](https://github.com/OXY2DEV/intro.nvim/blob/assets/images/plugin_img_3_large.jpg)\n\n![Screenshot_4_L](https://github.com/OXY2DEV/intro.nvim/blob/assets/images/plugin_img_4_large.jpg)\n\n![Screenshot_5_L](https://github.com/OXY2DEV/intro.nvim/blob/assets/images/plugin_img_5_large.jpg)\n\n\n\u003ch3\u003eVideos\u003c/h3\u003e\n\nhttps://github.com/OXY2DEV/intro.nvim/assets/122956967/2d4b230a-328a-4b80-90c4-55f9b6d26dab\n\nhttps://github.com/OXY2DEV/intro.nvim/assets/122956967/b415931b-aa95-48e6-9133-847af7d222e2\n\nhttps://github.com/OXY2DEV/intro.nvim/assets/122956967/9e9ed7b7-86b1-4412-8328-82b9071e8c65\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Foxy2dev%2Fintro.nvim","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Foxy2dev%2Fintro.nvim","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Foxy2dev%2Fintro.nvim/lists"}