luna/scritcher
1
2
Fork 0
Code Issues Pull requests Releases Activity

update doc/README.md

Browse source
This commit is contained in:
Luna 2019-07-09 18:51:00 -03:00
parent eb201fd6b8
commit fe8ef6b25c
1 changed files with 17 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

22
doc/README.md
View file

@ -8,23 +8,35 @@ scritcher scripts are shell-like commands separated by a semicolon.
some commands allow a `:N` syntax where N is an integer to use a given 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: argument when `scritcher` is called. so, for example, calling a script:
``` ```
load :1; load :0;
showpath; showpath;
``` ```
and then doing `scritcher path/to/script.scri arg` will print `arg` on the and then doing `scritcher path/to/script.scri arg` will print `arg` on the
screen and then exit. 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).
## `load path_or_arg` ## `load path_or_arg`
Load a file into memory. The file will be converted to BMP. 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.)
## `echo split index delay` ## `amp split index gain`
Run the eg-amp plugin over the given slice of the file.
## TODO `echo split index delay`
Run an echo filter on the given loaded file. Run an echo filter on the given loaded file.
## `quicksave` ## TODO `quicksave`
Save the file on the same directory of the file specified by `load`, but Save the file on the same directory of the file specified by `load`, but
with a suffix on the filename (before extension). with a suffix on the filename (before extension).
@ -32,6 +44,6 @@ with a suffix on the filename (before extension).
Doing consecutive `quicksave`s will not overwrite any files, the suffixes will Doing consecutive `quicksave`s will not overwrite any files, the suffixes will
just be different. just be different.
## `showpath` ## TODO `showpath`
Print the current loaded path on the screen. Print the current loaded path on the screen.