Installing Tobii Ocumen

This page explains how to get started with Tobii Ocumen.

Table of Contents

Do not drag-drop the Unity code into your Assets folder; instead use the Unity Package Manager.

Uninstall any Tobii XR SDK you might have in your project. Tobii Ocumen comes bundled with its own Tobii XR SDK.


Download

Tobii Ocumen will be made available to you via the Tech Portal from which you can download the latest release, for example:

Inside this bundle you will find various files and folders. The exact details might change with each release and the contained README will give definitive insights on what’s included. However, all Unity code presented on this web site refers to content you can find in the contained /Packages/ folder, marked below.


Package Installation

Once you have unpacked Ocumen you need to import the Unity components into your project.

  • Step 1: Open Package Manager

  • Step 2: “Add package from disk …”

  • Step 3: Select the package.json in the /Packages/ hierarchy (starting with /Packages/Core/)

  • Step 4: Repeat for each bundled package

You will need to repeat these steps for all included packages.


  • Step 5 (Optional): Confirm Dependencies

Some packages require you to make additional choices after installation, e.g., resolving dependencies. You should usually confirm these dialogs, e.g., by clicking “Agree” or importing “Essentials”.


Import Samples

Some packages come with samples and the remaining pages often refer to these examples. You should import them into your project by pressing the Import-button in the Package Manager.


Add your License

To use Ocumen you need a license, both the legal agreement and a technical license file, which you should find in our Tech Portal.

Once you have obtained your license file, add it to your Unity project and drag it to the License Asset field in the TobiiXR Initializer prefab in your scene.

The license must have the file extension “.bytes”.


Add Pico Unity SDK

Current Ocumen examples are set up without any external SDK dependency. To be able to run them on your Pico Neo 2 Eye, you will need to download and import the PicoVR Unity SDK.

Once you have imported the Pico Unity SDK, remove the Main Camera in the example scene and replace it with the Pvr_UnitySDK prefab, found in /PicoMobileSDK/Pvr_UnitySDK/Prefabs.

Some examples, such as the Calibration example, contains content under the Main Camera. Be sure to move this to the Head of the Pvr_UnitySDK prefab when replacing the Main Camera with the Pvr_UnitySDK prefab.