Sparkles

An Obsidian plugin that adds an animated sparkle overlay to your vault with customizable colors and settings.

Features

• Animated Sparkles: Beautiful, animated sparkles float across your screen
• Multiple Star Shapes: Five different sparkle shapes:
  • Diamond
  • Hollow Diamond
  • Soft Star
  • Six-Point Star
  • Eight-Point Star
• Extensive Color Presets: Choose from:
  • Single colors (black, white, grey, red, orange, yellow, green, blue, purple, pink)
  • 50+ pride flag color schemes
• Fully Customizable: Adjust all aspects of the sparkle animation
• Performance Optimized: Uses HTML5 Canvas for smooth rendering

Installation

From Source

1. Clone this repository
2. Copy the plugin folder to your Obsidian vault's .obsidian/plugins/ directory
3. Enable the plugin in Obsidian's Community Plugins settings

Usage

Once enabled, sparkles will automatically appear on your screen. No additional configuration is required, though you can customize the appearance to your liking.

Settings

Access the settings by navigating to Settings → Community Plugins → Sparkles.

Available Settings

• Sparkle count (1-200): Number of sparkles displayed on screen
• Min size (1-20): Minimum sparkle size
• Max size (1-20): Maximum sparkle size
• Min lifetime (500-10000ms): How long sparkles live before fading
• Max lifetime (500-10000ms): Maximum sparkle lifetime
• Wiggle distance (0-20): How far sparkles drift from their origin
• Max rotation (0-45°): Maximum rotation angle for sparkles
• Fade in duration (100-2000ms): Time for sparkles to fade in
• Fade out duration (100-2000ms): Time for sparkles to fade out
• Color preset: Choose from 60+ color schemes.

Color Presets

The plugin includes color presets for:

• Basic Colors: Black, White, Grey, Red, Orange, Yellow, Green, Blue, Purple, Pink
• Pride Flags: Rainbow, Gay Men, Lesbian, Bisexual, Pansexual, Transgender, Non-Binary, Asexual, Aromantic, Aroace, Demisexual, Genderfluid, Genderqueer, Agender, Bigender, Pangender, Omnisexual, Polysexual, Intersex, Two-Spirit, Sapphic, Questioning, Polyamorous
• Microlabels: Abrosexual, Graysexual, Grayromantic, Demigender, Demiboy, Demigirl, Genderflux, Genderfae, Genderfaun, Xenogender, Lithromantic, Fraysexual, Cupiosexual, Cupioromantic, Trigender, Multigender, Polygender, Androgyne, Neutrois, Maverique, Omnigender, Aporagender, Gendervoid, Greygender, Quoiromantic

Requirements

• Obsidian 0.15.0 or higher

Notes

Never had to deal with Obsidian's particular brand of fussy before, so the way the initial rendering works is kinda hacky. Attaching it to the document body is the only way to get the sparkles to show upon startup, but that blocks users from dragging the window, so I told it to wait and then resize to only render underneath the workspace tab header containers.