diff options
| author | s-ol <s-ol@users.noreply.github.com> | 2020-01-25 17:07:33 +0000 |
|---|---|---|
| committer | s-ol <s-ol@users.noreply.github.com> | 2020-01-25 17:09:09 +0000 |
| commit | 6594f9cc3c91ba225c4679ec615a71a3266dabe5 (patch) | |
| tree | 15a997268cd8698db49e3cf9f79326fc60f55195 | |
| parent | OSC configuration in config.yaml (diff) | |
| download | glsl-view-6594f9cc3c91ba225c4679ec615a71a3266dabe5.tar.gz glsl-view-6594f9cc3c91ba225c4679ec615a71a3266dabe5.zip | |
document configuration in README.md
| -rw-r--r-- | README.md | 22 | ||||
| -rw-r--r-- | config.yaml | 8 |
2 files changed, 22 insertions, 8 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..ea6ed8d --- /dev/null +++ b/README.md @@ -0,0 +1,22 @@ +configuration +------------- + +- `fragment` (`str`): path to GLSL fragment shader. +- `width` (`int`): horizontal rendering resolution. defaults to `1920`. +- `height` (`int`): vertical rendering resolution. defaults to `1080`. +- `outputs`: list of outputs. defaults to one 800x600 window. + each output is a dictionary with the following keys: + - `type` (`str`): currently always `window`. + - `width` (`int`): window width. defaults to `800`. + - `height` (`int`): window height. defaults to `600`. +- `osc`: either a 'liblo URL' or dictionary with the following keys: + - `protocol` (`str`): `udp`, `tcp` or `unix`. defaults to `udp`. + - `port` (`int`): port to bind to. defaults to `9000`. + +### libio URLs +Unfortunately undocumented by libio. The following formats are valid: + +- `osc.udp://localhost:1234` +- `osc.udp://224.0.1.9:1234` (multicast IP) +- `osc.tcp://:1234` +- `osc.unix://localhost/tmp/mysocket` diff --git a/config.yaml b/config.yaml index 78b5e69..4799aa1 100644 --- a/config.yaml +++ b/config.yaml @@ -6,11 +6,3 @@ outputs: width: 270 height: 480 fullscreen: false -parameters: - - name: camera - type: mat4 - - name: bg - type: vec4:rgba -osc: - protocol: tcp - port: 4444 |