Skip to content

Latest commit

 

History

History
143 lines (126 loc) · 7.29 KB

README.md

File metadata and controls

143 lines (126 loc) · 7.29 KB
Raw

🍁 Drop

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

drop.webm

Features

  • Automatically enables/disables on these dashboard plugins:
  • 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.

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

⚡️ Requirements

📦 Installation

Install the plugin with your preferred package manager:

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

-- Lazy.nvim
{
  "folke/drop.nvim",
  opts = {
    -- ...
  }
}

⚙️ Configuration

drop.nvim comes with the following defaults:

{

  ---@type DropTheme|string
  theme = "auto", -- when auto, it will choose a theme based on the date
  ---@type ({theme: string}|DropDate|{from:DropDate, to:DropDate}|{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 drop window
}