Skip to content

Latest commit

 

History

History
50 lines (40 loc) · 1.27 KB

README.md

File metadata and controls

50 lines (40 loc) · 1.27 KB
Raw

spacebrOsc

Converts OSC bundles to spacebro events.

Usage

spacebrOsc is meant to be used as is. You install it, provide a custom configuration file and run it.

Install
$ git clone git@github.com:spacebro/spacebrOsc.git
$ cd spacebrOsc/
$ npm i
Eventually use custom settings
$ cp settings/settings.default.js settings/settings.js
$ vim settings/settings.js
Run
$ node index.js

Settings

{
  "verbose": false, // does spacebrOsc logs everything or not
  "useCustomEventName": 'my-custom-event',
  // if set to false, OSC message address will be used as spacebro event name
  // else, provide a string that will be the event name and OSC message address will be sent as data
  "spacebro": {
    "host": "127.0.0.1", // host of your spacebro server
    "port": 8888, // port of your spacebro server
    "channelName": "spacebrosc" // channel name you want to use (optionnal)
  },
  "osc": {
    "localAddress": "0.0.0.0",
    // on which local ip do you want to open an UDP socket for your OSC sending app to connect
    "localPort": 12345 // on which port you open that UDP socket
  }
}

Example

If you don't have an OSC sending app, you can test with the tools/osc-emitter.js script. Just make sure the settings matches.