Skip to content

Getting started

Jump to bottom
tngjonas edited this page Apr 2, 2021 · 35 revisions

Installation

  1. Download and install Unity 2018.4.29. Personal edition is fine for desktop usage.

  2. Start a new Unity project.

  3. Import videolab package. Do so either via Assets > Import Package > Custom Package or drag and drop the unity package file into the project explorer.

  4. Make sure Project Settings > Player > Other Settings > Configuration > Scripting Runtime Version is .NET 4.x equivalent

  5. Make sure Project Settings > Player > Graphics API is set to OpenGLCore for Mac, Metal for iOS and OpenGLES2 for Android. You may have to uncheck the Auto Graphics API option to be able to set this.

If you want the very latest videolab version, clone the repo and drag drop everything from /Assets into your project.

Note that you need the .meta files too, make sure they are copied.

Wiring your first patch

videolab relies on a node-based system called Klak for scripting. You can script via code too if you want, but there are some limitations (see Exporting for OP-Z).

  1. Add a Patch object to your scene - right-click in the Hierarchy and select Klak > Patch.

  2. Click Open Patcher in the Patch component Inspector. This opens the Patcher window, dock it somewhere the suits your editor setup.

  3. Right click inside the Patcher window, browse the Create menu for all the nodes that make up Klak. Nodes are patched together by dragging wires from inlets to outlets in the Patcher window. You need to enter Play mode to see your patch run.

  4. Connect some MIDI-enabled device to your computer and make sure it shows up in the Midi Jack window (Window > MIDI Jack). Experiment with the MIDI input and output Klak nodes.

Organising your patch

Be sure to name the nodes you add, otherwise your patch will quickly become impossible to read.

Also break complex patches up into multiple smaller patches. A super-patch can be used to enable and disable sub-patches using the Active Status Out node.

Klak node multi-editing

While multi-editing is not supported by the Patcher GUI there is a workaround. All nodes are also listed under the Patch object in the Hierarchy panel and selecting them there allows you to edit as many as you want.

Samples

Clone this wiki locally