GMU:Tutorials/Networking/Controlling Unity with Processing

On 1 Computer

1. Open Unity and Processing.
2. In both programs the Remote IP should be set to 127.0.0.1
3. The SendToPort in Processing equals the ListenerPort in Unity. You will have to adjust the values manually. Usually port values between 7000 and 15000 are not taken, so you can use them for your OSC connection. If it is not working try changing the ports. Do not use the same value twice at the same time, if you have more than one connection running.

On 2 Computers

1. Make sure you are connected to the same Wifi. If it does not work there might be an active firewall disturbing your work, so turn that off if you have to.
2. Open Unity and Processing.
3. In Unity fill in the IP of the Computer that is running Processing.
4. The SendToPort in Processing equals the ListenerPort in Unity. You will have to adjust the values manually. Usually port values between 7000 and 15000 are not taken, so you can use them for your OSC connection. If it is not working try changing the ports. Do not use the same value twice at the same time, if you have more than one connection running.

Processing

In Processing you need to install a library. Click on Tools – Add Tools – Choose Libraries – Search for oscP5 and install it.

This is the basic processing script for sending Osc data (it just sets up the connection, actions can be added):

//load libraries
import netP5.*;
import oscP5.*;

OscP5 oscP5;
NetAddress myRemoteLovation;

//make a connection
void setup () {
  osP5 = new OscP5 (this, 9000);
  myRemoteLocation = new NetAddress("127.0.0.1", 9000);
}

// this is where you can make things happen and send values to Unity
void draw () {
  OscMessage myMessage = new OscMessage ("/");
    // add a value to the message (optional)
    myMessage.add(somevalue);
    // add a bool to the message (optional)
    myMessage.add(true);
  oscP5.send(myMessage, myRemoteLocation);
}

// this is where you get feedback in Processing
void oscEvent (OscMessage theOscMessage) {
  print("### received an osc message.");
  print(" addrpattern: "+theOscMessage.addrPattern());
    println(" typetag: "+theOscMessage.typetag());
    println("### received an osc message. with address
    pattern"+theOscMessage.addrPattern()+" typetag
    +theOscMessage.typetag());
}

Unity

With just a little help from Google (or bing if you’re one of those people) you can find one of these Osc Receiver Scripts. You will also need scripts for Osc and Udp.

1. Import the scripts to the Assets folder using drag&drop. If you’re working on a real actual project it might be best to create a folder for all your scripts.
2. Create an empty game object (right click in the hierarchy) and rename it, so you know what it is.
3. From the assets you drag the scripts onto the empty game object.
4. Do not forget to adjust the IP, and the port in the inspector.

5. In the Inspector you see the public variable Game Receiver within the Osc Receiver Script. Drag the object you want to manipulate from the hierarchy onto the Game Receiver value. By default this value is called “Cube”.

6. If you haven't done it already - Safe! Ctrl+S on Windows, Macs probably do that differently, but you will know that better than me.

If all this code is completely new to you and you only understand trainstation – here is an explanation for the whole OSC Receiver Script:

Public values are adjustable without any coding; just use the inspector for that.

public var RemoteIP : String = "";
public var SendToPort : int = xxxx;
public var ListenerPort : int = yyyy;
public var controller : Transform;
public var gameReceiver = "Cube";

In the Start() function all the necessary scripts and components are connected. This will happen once you press Play.

public function Start ()
{
 var udp : UDPPacketIO = GetComponent("UDPPacketIO");
 udp.init(RemoteIP, SendToPort, ListenerPort);
 handler = GetComponent("Osc");
 handler.init(udp);
 handler.SetAllMessageHandler(AllMessageHandler);
}

The AllMessageHandler() function is where the Osc happens. This function unpacks the Osc signals, so you can address them in other functions. In this function you can command, whenever A happens, you want FunctionB() to be executed.

public function AllMessageHandler(oscMessage: OscMessage){
 var msgString = Osc.OscMessageToString(oscMessage);
 var msgAddress = oscMessage.Address;
 var msgValue = oscMessage.Values[0];

So you typed all that code and there are no errors but that stupid thing still won't do what it should - try Debug.Logs! Just add them everywhere! They can tell you what parts of your script are accessed after you press Play.

Debug.Log("Stakkars meg, som har skrevet 50 Debug.Logs");<br>

The lines will be written in the console section of Unity once they are accessed.

Example: Make an object jump on clapping

1. In Processing:
a) Install an additional library for sound. Click on Tools – Add Tools – Choose Libraries – Search for Minim and install it.
b) To your imported Libraries add

import ddf.minim.*;

c) Add Audio variables to your script. This script will also draw a circle depending on the audio volume.

float x;
float y;

Minim minim;
AudioInput input;

d) In the Setup() function add the values for the circle and create the audiotoolkit

size (320, 240);
smooth();
stroke (255, 25);
noFill ();

// Set start position
x = 0;
y = 20;

minim = new Minim (this);
input = minim.getLineIn (Minim.STEREO, 512);
background (0);

e) The draw() function will be the container of the circle’s size. It will only send the values to Unity if the circle is big enough.

void draw () {
 int i =0;
 float dim = input.mix.level () * width;<br> 

 if (dim >= 80){System.out.println("Loud enough: "+dim);
  OscMessage myMessage = new OscMessage("/");
    myMessage.add(dim);
    myMessage.add(true);
  oscP5.send(myMessage, myRemoteLocation);}

f) When you are ready, press Play.

2. In Unity:
a) Create an object in Unity. Drag this object onto the gameReceiver of your Osc Receiver Script. This object is now the gameReceiver and will behave as you define in the Osc Receiver script.

b) Open up the Osc Receiver Script. Define a new private variable.

private var moveSpeed : int = 0;

c) Create a new public function.

public function MoveObject(msgValue) : void
{
moveSpeed = msgValue;
}

d) In the Update() function add

 var go = GameObject.Find(gameReceiver);
  go.transform.Translate(0, moveSpeed, 0);

e) In the AllMessageHandler() function add

switch (msgAddress){
 default:
  MoveObject(msgValue);
  break;}

f) When you are ready, press Play.

Example: Use your mouse position to Control Objects

S O O O O O O O O O N