Skip to content

Commit 0735c22

Browse files
committed
updated README
1 parent 5a3efe2 commit 0735c22

1 file changed

Lines changed: 9 additions & 2 deletions

File tree

README.md

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
<!-- TODO: link to seamless docs -->
44

5-
Suite of VST-Plugins and Standalone Applications to easily control the Seamless system using OSC-Messages.
5+
Suite of VST-Plugins and Standalone Applications to easily control the [Seamless system]([https://github](https://tu-studio.github.io/seamless-docs/)) using OSC-Messages.
66

77
## Usage
88

@@ -16,7 +16,8 @@ The Main plugins listen for external OSC-Messages on the port specified in the m
1616
| OSC-Path | data format | comment |
1717
| --- | --- | --- |
1818
| `/source/pos/xyz` | `ifff` source_index, x, y, z | x,y,z should be between -1 and 1, values outside this range will be clipped by the plugins |
19-
| `/source/send` | `iif` source_index, renderer_index, gain | renderer_index starts from 0, with 0 being ambisonics and 1 being wfs, gain should be between 0 and 1|
19+
| `/source/pos/<coordinate>`, where `coordinate` is one of `x`, `y` or `z` | `if` source_index, x or y or z | x,y,z should be between -1 and 1, values outside this range will be clipped by the plugins |
20+
| `/source/send` and `/send/gain` | `iif` source_index, renderer_index, gain | renderer_index starts from 0, with 0 being ambisonics and 1 being wfs, gain should be between 0 and 1|
2021

2122
## Development
2223

@@ -26,4 +27,10 @@ update submodules with
2627

2728
```bash
2829
git submodule update --init --recursive
30+
31+
# configure
32+
cmake -B build -DCMAKE_BUILD_TYPE=Release -G Ninja
33+
34+
# build
35+
cmake --build ./build --config Debug --target all
2936
```

0 commit comments

Comments
 (0)