scritcher/README.md

68 lines
2.2 KiB
Markdown
Raw Normal View History

2019-06-06 20:05:59 +00:00
scritcher
====
2019-07-09 21:46:27 +00:00
glitch art "framework", ???????? language??? something?
2019-07-10 16:24:03 +00:00
![example of the amp command](https://estrogen.fun/i/57y7kn55.png)
![example of the rflanger command](https://estrogen.fun/i/i2055hdf.png)
2019-07-10 16:24:03 +00:00
# how do?
2019-08-27 17:40:41 +00:00
## build depedencies (headers included):
- zig at https://ziglang.org
- libc, lilv and libsndfile
2019-07-23 00:50:49 +00:00
- graphicsmagick for the `rotate` command
2019-10-20 16:08:54 +00:00
- readline (for repl)
2019-08-27 17:40:41 +00:00
## plugin depedencies (only required at runtime):
- lv2 default plugins (most specifically the eg-amp plugin,
will likely be there by default)
2019-07-10 16:24:03 +00:00
- the SWH plugins ( https://github.com/swh/lv2 )
2019-07-10 23:19:40 +00:00
- the Invada Studio plugins ( https://launchpad.net/invada-studio/ )
2020-01-25 21:52:45 +00:00
- abGate plugin
2020-01-25 21:53:29 +00:00
- MDA plugins
2020-01-26 17:03:01 +00:00
- Calf plugins
2019-07-10 16:24:03 +00:00
2019-07-08 03:26:37 +00:00
```bash
# build and install
2019-08-27 17:40:41 +00:00
# assumes lilv headers are at /usr/include/lilv-0, edit build.zig if different
git clone https://gitdab.com/luna/scritcher.git
cd scritcher
2019-07-08 03:25:55 +00:00
zig build install --prefix ~/.local/
# on your input image file
convert blah.jpg blah.bmp
2019-08-27 17:40:41 +00:00
# if you got the lv2 default amp plugin, this is runnable
2019-07-10 15:02:16 +00:00
scritcher examples/middle_amp.scri blah.bmp
2019-08-27 17:40:41 +00:00
# if not, the noise plugin does not depend on any lv2 plugin.
scritcher examples/noise.scri blah.bmp
2019-07-10 15:02:16 +00:00
// scritcher saves it on an incremental basis, so the first run will save to
// blah_g1.bmp, the second saves to blah_g2.bmp, etc.
$your_image_viewer blah_g1.bmp
```
2019-09-11 01:27:35 +00:00
# using the repl
using repl works via `scritcher repl scri_file.scri input_image.bmp`
you type commands as you'd write the specific scritcher commands
2020-04-10 03:20:46 +00:00
(`doc/README.md`), with four repl-specific ones (semicolons do not apply):
2019-09-11 01:27:35 +00:00
- `push`, to push the last written command to the queue
- `save`, to write the queue to the given `scri_file.scri` file
- `list`, to print the current contents of the queue
2020-04-10 03:20:46 +00:00
- `quit`, to exit
2019-09-11 01:27:35 +00:00
2020-04-10 03:20:46 +00:00
After a non-REPL command, such as an effect, the program pointed by
`SCRITCHER_RUNNER` will run as argument to the `runqs` command. By default,
the program run will be `ristretto` (as it is my preffered image viewer,
considering it was able to handle when some images went broke)
this allows for quicker iteration of commands, as you can type a command, see
the image changes as fast as possible, tweak its arguments,
and when satisfied, `push` it, and work on the next command, etc.