🌧️ Rain

Fun little plugin that can be used as a screensaver and on your dashboard.

Features

• Automatically enables/disables on these dashboard plugins:
  • mini.starter
  • alpha-nvim
  • dashboard-nvim
• Runs as a screen-saver when there is no activity for a specified amount of time.
• Holiday theme switcher with default holidays that can be overridden.

Full video (MP4)

Available Themes

Currently, the following default themes are available:

1. april_fools - 🤡, 🎭, 🃏, 🎉, 😂, 🙃, 🎈, 🎁, 🤣, 😜
2. arcade - 🎮 🕹️ 👾 💾 ⚔️ 🛡️ 🏰
3. art - 🎨 🖼️ 🖌️ 🎭 🎶 📚 🖋️
4. bakery - 🍞 🥖 🥐 🍩 🍰 🧁 🍪
5. beach - 🌴 🏖️ 🍹 🌅 🏄 🐚 🌞
6. binary - 0, 1
7. blood - ❦, 🩸, ❢, ●, ·, ⚰️, 💀, 🩸, ⚱️, 🫀
8. bugs - 🐞, 🐜, ��, 🦗, 🕷️, 🕸️, 🐛
9. business - 💼, 🖊️, 📈, 📉, 💹, 💲, 🏢
10. candy - 🍬 🍭 🍫 🍩 🍰 🧁 🍪
11. cards - ♠️, ♥️, ♦️, ♣️, ��
12. carnival - 🎪 🎭 🍿 🎠 🎡 🎈 🤹
13. casino - 🎰 ♠️ ♦️ ♣️ ♥️ 🎲 🃏
14. cats - 🐱, 🦁, 🐯, 🐈, 🐅, 🐆
15. coffee - ☕ 🥐 🍰 🍪 🍩 🥛 🍫
16. cyberpunk - 🌃 💿 🕶️ ⚙️ 🖥️ 🎮 🔌
17. deepsea - �� 🐙 🦈 🌊 🦑 🐡 🐟
18. desert - 🌵 🐪 🏜️ 🌞 🦂 🪨 💧
19. dice - ⚀, ⚁, ⚂, ⚃, ⚄, ⚅
20. diner - 🍔 �� 🥤 🍳 🥞 🥓 🍦
21. easter - 🐣 🐥 🐤 🥚 🌸 🍫 🐇 🌷 🌼 🍃 🦋 🍬 🌈 🎀 💒
22. emotional - 😀, 😃, 😄, 😁, 😆, 😅, 😂, 🤣, 😊, 😇, 🙂, 🙃, 😉, 😌, 😍, 😘, 😗, 😙, 😚, 😋, 😛, 😝, 😜, 🤪, 🤨, 🧐, 🤓, 😎, 🤩, 😏, 😒, 😔, 😟, 😕, 🙁, ☹️, 😣, 😖, 😫, 😩, 🥺, 😢, 😭, 😤, 😠, 😡, 🤬, 🤯, 😳, 🥵, 🥶, 😱, 😨, 😰, 😥, 😓, 😶, 😐, 😑, 😬, 😯, 😦, 😧, 😮, 😲, 🥱, 😴, 🤤, 😪, 😵, 🤐, 🥴, 🤢, 🤮, 🤕, 🤒, 😷, 🥰, 😸, 😺, 😻, 😼, 😽, 🙀, 😿, 😹
23. explorer - 🌍 🌐 🗺️ 🔍 ⛺ 🌄 🧭
24. fantasy - 🐉 🏰 �� 🧙 🛡️ 🗡️ 🌌 👑
25. farm - 🐄 🐖 🐓 🌾 🍎 🍏 🚜
26. garden - 🌱, 🌸, 🌻, 🌿, 🍂, 🍃, 🌾
27. halloween - 🎃, 👻, 🦇, 🕷️, 🕸️, 🦉, 🔮, 💀, 👽, 🌙, 🍬, 🍭, 🖤, 🔪, 🧛, 🪦, 😱, 🙀, 🌕, ⚰️
28. jungle - 🦜 🦍 🌴 🐅 🐍 🌺 🦎
29. leaves - 🍂 �� 🍀 🌿   
30. lunar - 🌑, 🌒, 🌓, 🌔, 🌕, 🌖, 🌗, 🌘
31. magical - 🔮 🌟 🧹 🎩 🐇 🪄 💫
32. mathematical - ➕, ➖, ✖️, ➗, ≠, ≈, ∞
33. matrix - ｦ, ｧ, ｨ, ｩ, ｪ, ｫ, ｬ, ｭ, ｮ, ｯ, ｰ, ｱ, ｲ, ｳ, ｴ, ｵ, ｶ, ｷ, ｸ, ｹ, ｺ, ｻ, ｼ, ｽ, ｾ, ｿ, ﾀ, ﾁ, ﾂ, ﾃ, ﾄ, ﾅ, ﾆ, ﾇ, ﾈ, ﾉ, ﾊ, ﾋ, ﾌ, ﾍ, ﾎ, ﾏ, ﾐ, ﾑ, ﾒ, ﾓ, ﾔ, ﾕ, ﾖ, ﾗ, ﾘ, ﾙ, ﾚ, ﾛ, ﾜ, ﾝ, 1, 2, 3, 4, 5, 6, 7, 8, 9, 0, -, =, *, _, +, |, :, <, >, "
34. medieval - 🏰 🛡️ ⚔️ 🎠 👑 🏹 🍺
35. musical - 🎵 🎶 🎤 🎷 🎸 🎺 🎻
36. mystery - 🕵️, 🔎, ��, 🔑, 📜, 🖋️, 🗝️
37. mystical - 🔮 🌕 🌟 📜 ✨ 🔥 💫
38. new_year - 🎆 🎉 🍾 🥂 ⏰ 🕛 🎈 🌟 ✨ 🎊 🥳 💫 📅 2️⃣ 0️⃣ 2️⃣ 4️⃣
39. nocturnal - 🦉 🌙 🦇 🌌 🌠 🔭 🌚
40. ocean - 🌊 🐠 🐟 🐡 🐬 🐳 🦈 🐚 ⛵
41. pirate - ☠️ ⚓ 🏴‍☠️ 🗺️ 🦜 ⚔️ 💰
42. retro - �� 📺 🎞️ 📼 🎙️ 🕰️ ☎️
43. snow - ❄️  ❅ ❇ * .
44. spa - 🕯️ 🛁 🌸 💆 🍵 🧘 💅
45. space - 🪐 🌌 ⭐ 🌙 🚀 🛰️ ☄️ 🌠 👩‍🚀
46. sports - ⚽ 🏀 🏈 ⚾ 🎾 🏓 🏒
47. spring - 🐑 🐇 🦔 🐣 🦢 🐝 🌻 🌼 🌷 🌱 🌳 🌾 🍀 🍃 ��
48. stars - ★ ⭐ ✮ ✦ ✬ ✯ 🌟
49. steampunk - ⚙️ 🕰️ 🎩 🚂 🧭 🔭 🗝️
50. st_patricks_day - 🍀 🌈 💚 🇮🇪 🎩 🥔 🍺 🍻 🥃 �� 💰 🌟 🍵 🐍 🪄
51. summer - 😎 🏄 🏊 🌻 🌴 🍹 ��️ ☀️ 🌞 🕶️ 👕 ⛵ 🥥 🌊
52. temporal - 🕐, 🕑, 🕒, 🕓, 🕔, 🕕, 🕖, 🕗, 🕘, 🕙, 🕚, 🕛
53. thanksgiving - 🦃 🍂 🍁 🌽 🥧 🍠 🍎 🍖 🍗 🥖 🥔 🍇 🍷 🌰 🥕
54. travel - ✈️, 🌍, 🗺️, 🏨, 🧳, 🗽, ��
55. tropical - 🌴 �� 🍉 🥥 🌺 🐢 🌊
56. urban - 🏢 �� 🚇 🍕 🚦 🛴 🎧
57. us_independence_day - 🇺🇸 🎆 🗽 🦅 🌭 🍔 ⭐ 🎉 🥳 🍻 🥁 🎵 🎶 🚀 💥v
58. valentines_day - ❤️ 💖 💘 💝 💕 💓 💞 💟 💌 🌹 🍫 💐 💍 🍷 🕯️
59. wilderness - 🌲 🐺 🦌 🏞️ 🔥 ⛺ ��
60. wildwest - 🤠 �� 🌵 🔫 ⛏️ 🌄 🚂
61. winter_wonderland - ❄️ ⛄ 🌨️ 🎿 🛷 🏔️ 🧣
62. xmas - 🎄 �� 🤶 🎅 🛷 ❄ ⛄ 🌟 �� 🎶 ❄️  ❅ ❇ *
63. zodiac - ♈, ♉, ♊, ♋, ♌, ♍, ♎, ♏, ♐, ♑, ♒, ♓
64. zoo - 🦁 🐘 🦓 🦒 🦅 🦉 🐆

⚡️ Requirements

• Neovim >= 0.8.0
• a Nerd Font

📦 Installation

Install the plugin with your preferred package manager:

-- Packer
use({
  "igorktech/rain.nvim",
  event = "VimEnter",
  config = function()
    require("rain").setup()
  end,
})

-- Lazy.nvim
{
  "igorktech/rain.nvim",
  opts = {
    -- ...
  }
}

⚙️ Configuration

rain.nvim comes with the following defaults:

{
  ---@type RainTheme|string
  theme = "auto", -- when auto, it will choose a theme based on the date
  ---@type ({theme: string}|RainDate|{from:RainDate, to:RainDate}|{holiday:"us_thanksgiving"|"easter"})[]
  themes = {
    { theme = "new_year", month = 1, day = 1 },
    { theme = "valentines_day", month = 2, day = 14 },
    { theme = "st_patricks_day", month = 3, day = 17 },
    { theme = "easter", holiday = "easter" },
    { theme = "april_fools", month = 4, day = 1 },
    { theme = "us_independence_day", month = 7, day = 4 },
    { theme = "halloween", month = 10, day = 31 },
    { theme = "us_thanksgiving", holiday = "us_thanksgiving" },
    { theme = "xmas", from = { month = 12, day = 24 }, to = { month = 12, day = 25 } },
    { theme = "leaves", from = { month = 9, day = 22 }, to = { month = 12, day = 20 } },
    { theme = "snow", from = { month = 12, day = 21 }, to = { month = 3, day = 19 } },
    { theme = "spring", from = { month = 3, day = 20 }, to = { month = 6, day = 20 } },
    { theme = "summer", from = { month = 6, day = 21 }, to = { month = 9, day = 21 } },
  },
  max = 75, -- maximum number of drops on the screen
  interval = 100, -- every 150ms we update the drops
  screensaver = 1000 * 60 * 5, -- show after 5 minutes. Set to false, to disable
  filetypes = { "dashboard", "alpha", "ministarter" }, -- will enable/disable automatically for the following filetypes
  winblend = 100, -- winblend for the rain window
  tail = { enable = true, length = 5, delta = 5, dynamic = true }, -- enable/disable tail
  wind = { enable = true, speed = 10, direction = "both" }, -- enable/disable wind effect
}

Tail Configuration

The tail option controls the trailing effect behind each drop:

• enable (boolean): Enable/disable the tail effect
• length (number): Base length of the tail (default: 5)
• delta (number): Maximum variation in tail length (default: 5)
• dynamic (boolean): Whether tail length should change dynamically over time

Wind Configuration

The wind option controls the horizontal movement of drops:

• enable (boolean): Enable/disable the wind effect
• speed (number): Maximum speed of horizontal movement (default: 10)
• direction (string): Wind direction - "both", "left", or "right" (default: "both")

🎨 Customization

You can customize the appearance of the rain effect by:

1. Creating your own theme:

require("rain").setup({
  theme = {
    symbols = { "🌧️", "💧", "☔", "🌂" }, -- your custom symbols
    colors = { "Rain1", "Rain2", "Rain3" }, -- your custom highlight groups
  }
})

1. Adding custom highlight groups:

vim.api.nvim_set_hl(0, "Rain1", { fg = "#88ccff" })
vim.api.nvim_set_hl(0, "Rain2", { fg = "#66aaff" })
vim.api.nvim_set_hl(0, "Rain3", { fg = "#44aaff" })

📝 License

MIT