← All docs
Getting started

Quick start

XOSC is a one-trick pony: it listens for an input, and forwards it as OSC. Here's how to wire it up to Resolume in under a minute.

1. Install

Download the installer from the download page, run it, and click through. Windows SmartScreen will warn you because the binary isn't code-signed — choose More info → Run anyway. The installer puts XOSC in your local AppData; nothing system-wide.

2. Add nodes

When XOSC opens, the canvas is empty. Use the toolbar:

  • Click + Input to drop an input node.
  • Click OSC Out to drop an output node.
Each node has a colour you can change in the right-hand inspector.

3. Bind your input

Click the input node, then click Bind next press in the inspector (or click the pill on the node itself). The node enters a pulsing "listening" state. Press your physical button — XOSC reads the next event and binds it.

In the inspector you can change the capture source between Keyboard / MIDI / Gamepad / Serial. For serial, you'll also pick the COM port and baud rate, then click Open port.

4. Configure the OSC output

Click the OSC output node. In the inspector, set:

  • Host127.0.0.1 if Resolume is on the same machine.
  • Port7000 (Resolume default).
  • Address — paste the OSC address from Resolume. (See below for how to find it.)
  • Arguments — by default we send int 1. Resolume treats that as "press".
The Trigger mode dropdown decides what happens on the input event:
  • Pulse — fire the configured args once on press. (Default.)
  • Toggle — flip an internal boolean, send int 1 / int 0 alternately.
  • Hold — send int 1 on press, int 0 on release.

5. Wire them

Drag from the input node's right edge to the output node's left edge. The wire is gradient-coloured from the input's colour to the output's colour.

You can wire one input to multiple outputs (fan-out), or multiple inputs to one output (fan-in), or both.

6. Test

Click Send test packet in the OSC output's inspector to fire one OSC message immediately. If Resolume is open and listening on port 7000, you'll see it react.

Open the Debug panel (bug icon, top right) to watch every event and packet in real time. Use Copy to grab the log if you need to share it for support.

Finding Resolume OSC addresses

In Resolume: Shortcuts → Edit OSC. Click any control in the interface (a clip, a slider, a button) and the address appears in the bottom-right corner. Copy it and paste into XOSC.