OSCulator Wiki

This page is read only. You can view the source, but not change it. Ask your administrator if you think this is wrong.
====== Quick Start Guide ======

===== Obtaining the software =====

  * [[https://osculator.net/download|Download the latest version here]]
  * Open the file you just downloaded and drag OSCulator to your Applications folder
  * Launch the application

===== Start from a Sample =====

The OSCulator software comes with many "ready to go" example files.
Although it is recommended to read through this entire Quick Start Guide, you can start by using these sample files, located in the "Samples Library" folder.

{{ :quickstart:samples_library_201701.zip | Download the Samples Library (January 2017) }}

===== Input Setup =====

When launched OSCulator shows an empty window.  It is actually listening for incoming messages.  It can be OSC messages on default port 8000 or MIDI messages sent to the virtual port "OSCulator In (8000)".
As soon it receives data, you can use it to trigger events (see [[#Output Setup|that section]]).

==== Wiimote ====

  - Open the Parameters Window (click the gear icon ⚙ in the toolbar) ;
  - In Devices, go to Wiimote ;
  - Pair your Wiimote with your computer (you don't have to do this again) ;
  - Once paired, just press any button of your Wiimote twice to connect it ;
  - Proceed to [[#Output Setup|configuring the events]].

==== iPhone / iPod Touch / iPad ====

  - Unless you have it already, download an OSC compatible application on the App Store like:
    * [[http://hexler.net/touchosc|TouchOSC]]
    * [[http://lux.vu/blog/oscemote/|OSCemote]]
    * [[http://poly.share.dj/wiki/index.php/Mrmr|mrmr]]
  - Connect your iPhone to the same Airport network as the computer that is running OSCulator ;
  - Configure the iOS app so it sends OSC messages to that computer (you can follow [[tutorial:1:|that tutorial]] that has been written for TouchOSC, other applications work about the same) ;
  - Touch some controls on the application running of the iPhone to test if the messages are well received by OSCulatorn they should appear in the list ;
  - Proceed to [[#Output Setup|configuring the events]].

==== Logitech SpaceNavigator ====

  - Connect the SpaceNavigator to an USB port ;
  - Click on the menu item Window -> Use SpaceNavigator ;
  - Proceed to [[#Output Setup|configuring the events]].

==== OSC enabled software or device like the Lemur ====

  * Any OSC enabled software or device can natively send data to OSCulator.  All you have to do is to make sure that the OSC output port of your device matches the OSC input port of OSCulator.
  * Software based on the TUIO protocol will work out of the box too, though it might be easier for you to use the OSC input port ''3333''.
  * The [[http://www.jazzmutant.com/|JazzMutant Lemur]] is usually sending its data on port ''8000''.
  * To know the IP address of your computer, open the Network Utility application ((located in /Applications/Utilities)) and look for the IP Address.
    * if your computer is connect with Airport, drop the menu down to ''Network Interface (en1)''
    * if your computer is connect with Ethernet, drop the menu down to ''Network Interface (en0)''


===== Output Setup =====

Now that you have a working input, you can transform the incoming data to something useful.

Each line in OSCulator represents a received message.  There is a blinking light to indicate when activity has changed, so you know when data comes in.  The Event Type and Value columns are important, the first lets you choose the nature of the action you want to perform with your controller, and the second lets you configure it.

For the sake of keeping the quick start guide minimal, we will only describe the MIDI Control Change event.


==== MIDI Control Changes ====

To be able to send MIDI Control Change events:
  - locate the message that corresponds to the particular control you want to bind and choose ''MIDI CC'' in the Event Type column ;
    * for example if you want to use the Roll of the Wiimote to control MIDI CC #16, select the message "1: roll" under ''/wii/1/accel/pry'' ;
  - in the Value column, choose a control change number that is not used yet ;
  - now go to the software that will receive the control changes (Ableton Live for example), and open the preference for this software.  There should be a MIDI panel where you must activate the "OSCulator Out" virtual MIDI port ;
  - depending on how the target software work, you may want to activate a MIDI learn mode((like in Live)), or manually configure the control change number((like in Traktor)).