SLURSH - VST3 & CLAP PLUGIN by BruceJames.studio
==================================================

Thank you for downloading Slursh!

Slursh is a saturator with a transient-triggered "Collapse" stage. The Slush
section soft-clips with a tanh curve that rounds the waveform toward a sine as
you push it, for thick, rounded saturation. The Collapse section watches the
low-frequency energy of the signal and, when it crosses a threshold, ducks the
low and high bands independently around a sweepable crossover -- a rhythmic
pumping/depumping that locks to the transients of whatever you feed it.

----------------------------------------
INSTALLATION
----------------------------------------

Windows:
  Run the included installer (Slursh_Setup_1.1.0.exe) and follow the prompts.
  The installer copies plugins to the standard system folders:

  VST3 destination: C:\Program Files\Common Files\VST3
  CLAP destination: C:\Program Files\Common Files\CLAP

  Manual install (without the installer):
    Slursh.vst3  ->  C:\Program Files\Common Files\VST3\
    Slursh.clap  ->  C:\Program Files\Common Files\CLAP\

Linux:
  Unpack the .tar.gz, then from the extracted folder run the included script:
    ./install.sh              Install for the current user (no sudo)
                              VST3 -> ~/.vst3   CLAP -> ~/.clap
    ./install.sh --system     Install system-wide (uses sudo)
                              VST3 -> /usr/lib/vst3   CLAP -> /usr/lib/clap
    ./install.sh --uninstall  Remove the per-user install
                              (add --system to remove a system-wide install)

  Manual install (without the script):
    Slursh.vst3  ->  ~/.vst3/        (or /usr/lib/vst3 system-wide)
    Slursh.clap  ->  ~/.clap/        (or /usr/lib/clap system-wide)

Restart your DAW and rescan plugins after installing.

----------------------------------------
QUICK START
----------------------------------------

1. Insert Slursh on a track or bus.
2. Raise Drive in the Slush section to push the signal into saturation; use
   Threshold, Floor, and Knee to shape how the soft-clip blends in.
3. In the Collapse section, set Amount to taste and lower Collapse Threshold
   until the effect engages on the transients you want it to react to.
4. Set the Crossover (Xover) to split the duck into low and high bands, then
   dial Lo Duck / Hi Duck for how much each band drops.
5. Shape the movement with Lo/Hi Attack and Lo/Hi Release. The envelope display
   to the right shows the attack and release curves with a live position ball.
6. Use Input / Dry-Wet / Output in the Global section to set levels and blend.

The Drive meter (left) shows how hard the saturator is working; the Collapse
meter (right) shows how far the collapse has engaged.

----------------------------------------
PARAMETERS
----------------------------------------

SLUSH (saturation)
  Drive         How hard the signal is pushed into the tanh saturator. Higher
                values round the waveform further toward a sine.
  Threshold     Level below which the dry signal is blended back in, so quiet
                detail stays clean while louder material saturates.
  Floor         Minimum amount of saturation blended in below the threshold
                (0 = fully clean under threshold).
  Knee          Softness of the transition into saturation (0 = hard, 1 = gentle).

GLOBAL
  Input         Input gain, -24 to +12 dB, applied before saturation.
  Dry / Wet     Blend between the dry input and the processed signal.
  Output        Output gain, -24 to +12 dB, applied after processing.

COLLAPSE (transient-triggered ducking)
  Amount        Overall depth of the collapse effect (0 = off).
  Xover         Crossover frequency (100-1000 Hz) splitting the duck into a low
                and a high band.
  Threshold     Low-energy level at which the collapse engages.
  Lo Duck       How far the low band drops when engaged, in dB (0-48).
  Hi Duck       How far the high band drops when engaged, in dB (0-48).
  Lo Atk        Attack time of the low-band gate (1-500 ms).
  Hi Atk        Attack time of the high-band gate (1-500 ms).
  Lo Rel        Release time of the low-band gate (10-2000 ms).
  Hi Rel        Release time of the high-band gate (10-2000 ms).
  Squarify      How much the low band is driven toward a squared-off fundamental
                as the collapse engages.

  Bypass        Hard bypass. Processing is halted and the input passes through
                unchanged.
  Null          Subtracts the dry signal from the output so you hear only what
                Slursh is adding. Useful for auditing the effect in isolation.

----------------------------------------
INTERFACE
----------------------------------------

Click the logo (top-right) to open Settings, where you can choose the interface
size (100% / 150% / 200%) and toggle "Check for updates". Your chosen size is
remembered between sessions.

----------------------------------------
LICENSE & ACTIVATION
----------------------------------------

Slursh runs in demo mode until a valid license key is entered. In demo mode the
plugin inserts a brief silence periodically.

Purchase a license at https://brucejames.studio

To activate: click AUTHORIZE in the plugin UI, enter your key, and press Submit.
An internet connection is required for activation only.

Your license file is stored here after activation:
  Windows: %APPDATA%\Slursh\license.json
  Linux:   ~/.config/Slursh/license.json

----------------------------------------
TROUBLESHOOTING
----------------------------------------

- If your DAW does not detect the plugin, verify it is in the correct folder
  and perform a manual plugin rescan.
- Some DAWs require a restart after installation.
- If activation fails, check your internet connection and that the license
  key was entered exactly as received (no extra spaces).
- If the SmartScreen warning appears during install, click "More info" then
  "Run anyway" to proceed.

Need help? Contact support@brucejames.studio

----------------------------------------
(c) 2026 BruceJames.studio - All Rights Reserved.
