.. | ||
README.md |
scritcher command reference
scritcher scripts are shell-like commands separated by a semicolon.
parameters of the arg type
some commands allow a :N
syntax where N is an integer to use a given
argument when scritcher
is called. so, for example, calling a script:
load :0;
showpath;
and then doing scritcher path/to/script.scri arg
will print arg
on the
screen and then exit.
split and index arguments
plugin commands have a split and an index argument so that you can select where in the file you want the plugin to be ran.
so, if you did plugin 3 1...
, it would split the file in 3, then get the
part that is of index 1 (starting at 0).
Keep in mind parts start from the bottom of the file.
load path_or_arg
Load a file into memory. The file MUST end with the bmp extension (and so MUST be a bmp. feel free to put other files, no warranties are given.)
amp split index gain
Run the eg-amp plugin over the given slice of the file.
rflanger split index delay_depth_avg law_freq
Run the Retro Flanger script from the SWH plugins.
delay_depth_avg
is for theAverage stall (ms)
parameter of the plugin.law_freq
is for theFlange frequency
parameter of the plugin.
eq split index lo mid hi
Run the DJ EQ plugin from the SWH plugins.
lo
, mid
, and hi
are the respective dB gains for each frequency range.
All three ranges accept gains from -70dB to +6dB. Default is 0 for all (no action taken).
phaser split index lfo_rate lfo_depth fb spread
Run the LFO Phaser plugin from the SWH plugins.
Parameters:
lfo_rate
: LFO Rate (Hz), 0..100, default 25lfo_depth
: LFO depth, 0..1, default 0.25fb
: Feedback, -1..1, default 0spread
: Spread (octaves), 0..2, default 1
mbeq split index band_1 band_2 band_3 band_4 band_5 band_6 band_7 band_8 band_9 band_10 band_11 band_12 band_13 band_14 band_15
Multiband EQ from the SWH plugins.
In respective order, the band arugments represent the: 50Hz, 100Hz, 156Hz, 220Hz, 311Hz, 440Hz, 622Hz, 880Hz 1250Hz, 1750Hz, 2500Hz, 3500Hz, 5000Hz, 10000Hz and 20000Hz frequencies.
All of them represent the band's gain in dB. The range is -70 to +30dB, default is 0.
chorus split index voices delay_base voice_spread detune law_freq attendb
Multivoice Chrorus from the SWH plugins.
Parameters:
voices
: Number of voices (int), 1..8, default 1delay_base
: Delay base (ms), 10..40, default 10voice_spread
: Voice separation (ms), 0-2, default 0.5detune
: Detune (%), 0..5, default 1law_freq
: LFO frequency (Hz), 2..30, default 9attendb
: Output attenuation (dB), -20..0, default 0
pitchscaler split index mult
Runs the Higher Quality Pitch Scaler from the SWH plugins.
The mult
parameter is the pitch coefficient, range from 0.5..2, default 1.
reverb split index roomLength roomHeight sourceLR sourceFB listLR listFB hpf warmth diffusion
Run the Early Reflection Reverb from the Invada Studio plugins.
TODO Parameter list
highpass split index freq gain noClip
Run the High Pass Filter from the Invada Studio plugins.
Parameters:
freq
: Frequency. 20..20000, default 1000gain
: Gain, 0..12, default 0noClip
: Soft Clip (assumed boolean), 0..1, default 0
delay seed gain feedback_pc tap_count first_delay delay_range delay_scale delay_rand_pc gain_scale wet
Parameters:
seed
: Random seed, 0..1000, default 0gain
: Input gain (dB), -96..24, default 0feedback_pc
: Feedback (%), 0..100, default 0tap_count
: Number of taps, 2..128, default 2first_delay
: First delay (s), 0..5, default 0delay_range
: Delay range (s), 0..6, default 6delay_scale
: Delay change, 0..5, default 1delay_rand_pc
: Delay random (%), 0..100, default 0gain_scale
: Amplitude change, 0.2..5, default 1wet
: Dry/wet mix, 0..1, default 1
TODO vinyl split index year warp click wear
VyNil effect from SWH.
Parameters:
year
: Year (int), 1900..1990, default 1990rpm
: RPM (int), 33..78, default 33warp
: Surface Warping, 0..1, default 0click
: Crackle, 0..1, default 0wear
: Wear, 0..1, default 0
revdelay split index delay_time dry_level wet_level feedback xfade_samp
Parameters:
delay_time
: Delay time (s), 0..5, default 0dry_level
: Dry Level (dB), -70..0, default 0wet_level
: Wet Level (dB), -70..0, default 0,feedback
: Feedback, 0..1, default 0xfade_samp
: Crossfade samples (int), 0..5000, default 1250
wildnoise/noise split index seed repeat_bytes
Inject random noise on the image.
the wildnoise
version gives a harder version than noise
.
Parameters:
seed
, Random seedrepeat_bytes
, Amount of bytes to preload with random data and repeat throughout the image slice
TODO echo split index delay
Run an echo filter on the given loaded file.
quicksave
Save the file on the same directory of the file specified by load
, but
with a suffix on the filename (before extension).
Doing consecutive quicksave
s will not overwrite any files, the suffixes will
just be different.