README file from
GithubParticle Spoilers
Particle Spoilers for Obsidian is a plugin that brings interactive spoiler effects right into your notes. It hides sensitive text, answers, or plot spoilers using your choice of five distinct styles: a dynamic animation of shimmering particles, a solid color block (similar to Discord or Steam), a soft blur filter, scrambled and rotated characters, or a digital matrix rain. The hidden text can be easily revealed with a simple click.
Usage
Using the plugin is as simple as applying standard Markdown formatting or using the built-in commands.
- Syntax: to hide text, simply wrap it in your chosen marker, which defaults to double vertical bars
||.- Example:
||This is a secret message||.
- Example:
- Inserting: you can easily wrap selected text by clicking the "eye-off" icon in the ribbon, or by using the "Insert spoiler" command in the command palette.
- Settings: go to the plugin settings to customize it to your liking:
- Spoiler style:
- Particle (animated dust);
- Block (solid color rectangle);
- Blur (soft blur filter);
- Scramble (shuffled and rotated characters);
- Matrix (digital rain of falling glyphs).
- Custom marker: set a custom syntax marker (e.g.,
!!,%%) to avoid conflicts with other Markdown elements. - Style Options:
- Particle: control the particle density and movement speed, and choose whether to use the app's accent color for the effect.
- Block: choose between using the app's accent color or selecting a custom color via a color picker.
- Blur: adjust the blur amount in pixels and optionally enable "Reveal on hover" to show the text without clicking.
- Scramble: adjust the letter-shuffling speed, toggle between the app's accent color and normal text color, and optionally enable "Reveal on hover".
- Matrix: control the digital rain fall speed and optionally enable "Reveal on hover".
- Reveal on hover: available for Blur, Scramble, and Matrix styles. Hovering reveals the text temporarily; clicking while hovering keeps it open.
- Hide on mouse leave: the text will automatically close when you move your mouse away from the revealed spoiler.
- Disable effect in Edit mode: choose whether the spoilers should be hidden in Live Preview, or only apply the effect in Reading mode.
- Spoiler style:
Results
| Light Theme | Dark Theme |
|---|---|
Install
Manually
- Copy
main.js,manifest.json, andstyles.cssinto<your vault>/.obsidian/plugins/particle-spoilers/. - Settings → Community plugins → Enable Particle Spoilers.
Upcoming features
- Static Scramble mode: an option to make the Scramble effect static, with the ability to randomly reshuffle characters on demand using a ⟳ button.
- Bulk reveal: a new command will be added to the Obsidian command palette — "Reveal all spoilers in note", allowing you to open all hidden elements at once.
- Per-note style customization: support for your note's
cssclassesproperty to apply a specific spoiler style, overriding the global settings.
Support
Particle Spoilers is free and open source. If it's useful to you, you can support its development with TON or USDT on the TON network: tonproxywallet.ton | UQALKfbKI2Czizms4SisKXHnejG2iEoH26O-fy3_rJ5FbJDu
Thank you!
License
MIT © LXXVII