From 1dc2346908e45987ba7f6e16b254de3154731f5e Mon Sep 17 00:00:00 2001 From: SharkPool <139097378+SharkPool-SP@users.noreply.github.com> Date: Fri, 19 Jun 2026 00:13:41 -0700 Subject: [PATCH] Refine parameter descriptions in Tune-Shark-V3.md Updated parameter descriptions for various audio effects to include units and improve clarity. --- docs/SharkPool/Tune-Shark-V3.md | 50 ++++++++++++++++----------------- 1 file changed, 25 insertions(+), 25 deletions(-) diff --git a/docs/SharkPool/Tune-Shark-V3.md b/docs/SharkPool/Tune-Shark-V3.md index 5b3921852c..c7e2244f35 100644 --- a/docs/SharkPool/Tune-Shark-V3.md +++ b/docs/SharkPool/Tune-Shark-V3.md @@ -235,9 +235,9 @@ Adds reverb to an inputted sound. **Warning:** Initializing reverb can cause framerate drops as its heavy to setup. For dynamic on/off use, you can use the Delay effect Parameters | What they Do --- | --- -time | the length (or room space) of the reverb effect -decay | the rate of how long the reverb fades over time -mix | percentage of how dry or wet the sound is +time | the length or room size (ms) +decay | how long the reverb fades over time (%) +mix | percentage of how dry or wet the sound is (%) ```scratch 🎛️ set delay of sound [MySound] to time (50) feedback (60) mix (50) ::#666666 @@ -247,9 +247,9 @@ Adds an echoing delay effect to a sound. Parameters | What they Do --- | --- -time | interval between each echo -feedback | intensity of each subsequent echo -mix | percentage of the original sound and the delayed sound +time | interval between each echo (ms) +feedback | intensity of each subsequent echo (%) +mix | percentage of the original sound and the delayed sound (%) ```scratch 🎛️ set pan 3D of sound [MySound] to x (0) y (50) z (50) ::#666666 @@ -271,9 +271,9 @@ Modulates the volume of a sound periodically, creating a tremolo effect. Parameters | What they Do --- | --- -speed | how fast the volume fluctuates -depth | intensity of the volume variation. A higher depth means more dramatic volume changes -mix | amount of the tremolo effect applied +speed | how fast the volume fluctuates (Hz) +depth | intensity of the volume variation. A higher depth means more dramatic volume changes (%) +mix | amount of the tremolo effect applied (%) ```scratch 🎛️ set fuzz of sound [MySound] to low (60) med-low (50) med-high (80) high (60) mix (50) ::#666666 @@ -283,11 +283,11 @@ Applies a fuzzy distortion to a sound. Parameters | What they Do --- | --- -low | amount of distortion applied to low frequencies -med-low | amount of distortion applied to mid-low frequencies -med-high | amount of distortion applied to mid-high frequencies -high | amount of distortion applied to high frequencies -mix | proportion of unfuzzed sound and fuzzed sound +low | amount of distortion applied to low frequencies (%) +med-low | amount of distortion applied to mid-low frequencies (%) +med-high | amount of distortion applied to mid-high frequencies (%) +high | amount of distortion applied to high frequencies (%) +mix | proportion of unfuzzed sound and fuzzed sound (%) ```scratch 🎛️ set bitcrush of sound [MySound] to bits (65) freq (60000) ::#666666 @@ -298,19 +298,19 @@ Reduces a sound's resolution and frequency, creating a chiptune-like, retro effe Parameters | What they Do --- | --- bits | bit depth. Lower values result in more distortion -freq | sampling frequency. Lower values create a grittier effect +freq | Sample rate (Hz). Lower values create a grittier effect ```scratch 🎛️ set [highpass v] of sound [MySound] to frequency (400) peak (10) ::#666666 ``` -Highpass: Filters out lower frequencies below the specified cutoff, allowing higher frequencies to pass through. +Highpass: Filters out lower frequencies _below_ a specified cutoff, allowing higher frequencies to pass through. -Lowpass: Filters out higher frequencies above the specified cutoff, allowing lower frequencies to pass through. +Lowpass: Filters out higher frequencies _above_ a specified cutoff, allowing lower frequencies to pass through. Parameters | What they Do --- | --- -frequency | cutoff frequency for the filter +frequency | cutoff frequency for the filter (Hz) peak | resonance at the cutoff frequency ```scratch @@ -321,11 +321,11 @@ Combines the original sound with a delayed version, creating a sweeping, "jet-li Parameters | What they Do --- | --- -time | delay time for the effect -speed | modulation controlling how quickly it oscillates -depth | intensity of the effect -feed | feedback level, controlling how much flanged sound enters -mix | proportion of the original and flanged sound +time | delay time for the effect (ms) +speed | modulation controlling how quickly it oscillates (Hz) +depth | intensity of the effect (%) +feed | feedback level, controlling how much flanged sound enters (%) +mix | proportion of the original and flanged sound (%) ```scratch 🎛️ set compressor of sound [MySound] to threshold (15) knee (50) attack (50) release (50) ratio (50) ::#666666 @@ -352,5 +352,5 @@ Parameters | What they Do gain low | gain applied to low frequencies gain med | gain applied to mid frequencies gain high | gain applied to high frequencies -cutoff low | low-frequency cutoff point -cutoff high | high-frequency cutoff point +cutoff low | low-frequency cutoff position +cutoff high | high-frequency cutoff position