jevstrudel.git / packages / osc / README.md
1# @strudel/osc
2
3OSC output for strudel patterns! Currently only tested with super collider / super dirt.
4
5## Usage
6
7Assuming you have [node.js](https://nodejs.org/) installed, you can run the osc bridge server via:
8
9```sh
10npx @strudel/osc
11```
12
13You should see something like:
14
15```log
16osc client running on port 57120
17osc server running on port 57121
18websocket server running on port 8080
19```
20
21### --port
22
23By default it will use port 57120 for the osc client, which is what [superdirt](https://github.com/musikinformatik/SuperDirt) uses. You can change it via the `--port` option:
24
25```sh
26npx @strudel/osc --port 7771 # classic dirt
27```
28
29### --debug
30
31To log all incoming osc messages, add the `--debug` flag:
32
33```sh
34npx @strudel/osc --debug
35```
36
37## Usage in Strudel
38
39To test it in strudel, you have can use `all(osc)` to send all events through osc:
40
41```js
42$: s("bd*4")
43
44all(osc)
45```
46
47[open in repl](https://strudel.cc/#JDogcygiYmQqNCIpCgphbGwob3NjKQ%3D%3D)
48
49You can read more about [how to use Superdirt with Strudel](https://strudel.cc/learn/input-output/#oscsuperdirtstrudeldirt) in  the tutorial.