This is a step by step tutorial on how to use IanniX to control 100 objects in Unity using 50 cursors and 50 triggers in Unity 3D.
In this tutorial we will set up IanniX on one computer (the sender) and Unity on another computer (the receiver). We will then use IanniX to play a musical score, which will be interpreted and performed by Unity 3D.
- Make sure Iannix is installed on the sender.
- Make sure Unity is installed on the receiver.
- Make sure that both computers can connect (use ping)
Setting up the Sender
Preparations to be done on the sender.
Before you get started, you need to figure out the IP1. Internet Protocol 2. Intellectual property of the sender.
Open the Rosette Example in IanniX
- In the IanniX inspector open the
FILES tab, pick
Rosette (double click)
- Click OK, to create the default rosette with 50 circles.
- You can play the example (hit space bar) and reset it (press F)
Configure Yannix to send messages to Unity
- In Iannix, go to the inspector, pick the
CONFIG tab, and the
NETWORK tab below it.
- Make sure that
enable OSC[[OSC|Open Sound Control]] is checked
- Below set
DEFAULT IP1. Internet Protocol 2. Intellectual property to the IP1. Internet Protocol 2. Intellectual property of your target machine
(Use 127.0.0.1 if you run both programs on the same machine)
This is the machine where IanniX will send its OSC[[OSC|Open Sound Control]] messages
- Make sure the remote port is set to `57120`, which is the default port used by IanniX.
This is the port where IanniX will send its OSC[[OSC|Open Sound Control]] messages.
Setting up the Receiver
Preparations to be done on the receiver.
Before you get started, you need to figure out the IP1. Internet Protocol 2. Intellectual property of the receiver.
Install the Iannix-Unity Patch
- Create a new Unity Project
- Download the zip file with the Iannix-Unity Scripts and extract it.
- Add the scripts and plugins folder to project assets in Unity
Create a Scripts Object
- Create a new empty node and name it "scripts"
- Drag the Iannix.js script from the `Scripts` folder in your project assets to the scripts object in the hierarchy
- Drag `Osc` and `Udp` from the Plugins folder in your assets onto the scripts node.
- Make sure all three Scripts are activated (check mark in the top left)
Configure Unity to receive messages from IanniX
- Make sure to pick the script in the hierarchy browser, then configure it in the inspector
- Set Remote IP1. Internet Protocol 2. Intellectual property to the IP1. Internet Protocol 2. Intellectual property of the sender (that is the computer that runs IanniX) (127.0.0.1 for the local machine)
- Set the local port to the port that has been configured as target port in IanniX. We use the default port configured in IanniX, which is 57120.
- Set the remote port to the OSC[[OSC|Open Sound Control]] In Port of Iannix, which is 1234 (we don't use it right now, so it doesn't really matter)
Lock your script object in the Inspector
Since we need to drag other stuff onto the script, we need to lock it first.
- Select the script object in the hierarchy browser
- Lock the script in the inspector window (click the little lock symbol)
Now the script will stay in your inspector view, no matter what object you pick in your hierarchy view....
Create 50 objects to be controlled by the cursors
- Create a cube of dimensions 1.0 x 1.0 x 0.05.
- Create 50 duplicates of the cube
- Create a group for the cubes named
Create 50 objects to be controlled by the triggers
- Create a sphere of dimensions (1.0, 1.0, 1.0)
- Create 50 duplicates of the sphere
- Create a group for the spheres named
Configure the Script to control your cursors
- Select 50 Cubes in the hierarchy browser and drag them onto the
Cursors field in the inspector
- Look up the ID of the first cursor object in IanniX (the objects are listed in the objects tab of the IanniX inspector)
- Set the
First Cursor ID in the Unity Inspector to match the ID
Configure the Script to control your triggers
- Select 50 Spheres in the hierarchy browser and drag them onto the
Triggers field in the inspector
- Look up the ID of the first trigger object in IanniX.
- Set the
First Trigger ID in the Unity Inspector to match the ID.
Running the Performance
Start Playing the Score
On the sender:
- In IanniX press Space to play
- In Unity press CMD-P to play
- In Unity pick the Scene mode to view your objects
Set up the Main Camera
On the receiver:
- Once the objects are distributed, stop the unity player (CMD-P)
- Position the camera, so that all objects are in view
- Make sure the camera uses perspective projection and the objects are inside the camera frustum
- In IanniX, select
MESSAGE LOG to see the OSC[[OSC|Open Sound Control]] messages when they are sent in real time
- In the Unity Script check the debug field, to log the received OSC[[OSC|Open Sound Control]] messages to the console in real time
Things to try
Use your own Models!
- Instead of choreographing cubes and spheres, import your own models (and those of your friends) to choreograph them
- Learn to use textures and materials and shaders to create a more realistic look
Use IanniX to create your own visual scores
- Get to know the IanniX user interface
- Learn how to use IanniX to create your own scores
- Learn how to use the Iannix Script Editor to generate complex scores
Explore the script
- Double click the script to open it in the MonoDevelop editor
- What are the three private arrays used for? (cursorCoord, triggerCoord, triggerValue)
- When are
Modify the Script
- Which properties of the objects are controlled by the script and where?
- Change the script to modify other properties
- Explore the Unity scripting reference to learn more.