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 the `Average stall (ms)` parameter of the plugin.
 - `law_freq` is for the `Flange 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 25
 - `lfo_depth`: LFO depth, 0..1, default 0.25
 - `fb`: Feedback, -1..1, default 0
 - `spread`: Spread (octaves), 0..2, default 1

## 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.