Add README.md

Author: exscape

README.md

@@ -0,0 +1,39 @@
+# Simplified Visuals for Slay the Spire 2
+
+A mod that offers options to remove or tweak certain visual effects.  
+Might be of use for people who are sensitive to motion/visual stimulation, easily distracted, or just want a "cleaner" look.  
+
+**All changes are optional**, see the configuration menu (Settings -> Mod Settings -> Simplified Visuals, then click the cog wheel in the upper right).
+
+As of the initial version, supports removing:
+
+* Various effects on the game's Timeline (moving stars, confetti, pulsing buttons)
+* Radial blur: used by Bygone Effigy, Ceremonial Beast, Mecha Knight, Shrinker Beetle, Vantom
+* "Big Slash": used by Perfected Strike, Sovereign Blade, Mecha Knight
+* "Scream": used by Bygone Effigy, Ceremonial Beast, Mecha Knight, Shrinker Beetle, The Insatiable
+* "Spooky scream": used by Haunted Ship, Soul Fysh
+* Purple Doom screen overlay (when an enemy dies to Doom)
+* The Insatiable's sandfalls and other sand VFX
+* Slippery Bridge event (disable rain)
+* Regent's attack animation
+
+You can also:
+
+* Remove the delay between drawn cards, making them move together as a unit (also speeds up the game)
+* Make Sovereign Blade stay still when idle
+* Remove the glow/sparkles from rare and uncommon cards (in card rewards and unlocks)
+
+Feel free to contact me via [GitHub issues](https://github.com/exscape/SimplifiedVisuals/issues) or on the Slay the Spire Discord (@Aeluwas) if you have suggestions on additional settings or other improvements, or to report issues.
+
+v0.1.0 is tested with Slay the Spire 2 version 0.99.1 and somewhat tested with version 0.100.0 (beta released on 2026-03-20).  
+Later versions are likely to work just as well; if something breaks, it should be just a single effect toggle or two being affected.
+
+## Installation
+
+1. Ensure you have a `mods` folder where StS 2 is installed, for example: `C:\Program Files (x86)\Steam\steamapps\common\Slay the Spire 2\mods`
+2. Ensure you have the latest version of [BaseLib](https://github.com/Alchyr/BaseLib-StS2/releases) installed: simply unpack the .zip in the above folder
+3. Download this mod's [latest release](https://github.com/exscape/SimplifiedVisuals/releases) and unpack it into the mods folder
+
+You can have separate folders for each mod, or simply unpack everything together; the game doesn't care.
+
+When updating this mod, also check for updates to BaseLib, as I'm currently aggressively using new features for the mod configuration.