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 public Tobii XR SDK you might have in your project. Tobii Ocumen comes bundled with its own Tobii XR SDK.

Add VR support

Install the XR Plugin Management which can be found in the Project Settings tab.

Remember to enable the corresponding Plugin Provider for your headset, for more detailed instructions on how to set up VR support for your headset, see our getting started guides.

When following the getting started guide, skip the step of importing the Tobii XR SDK, it comes bundled in the Ocumen package.

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: Import the package.json files in /Packages/ in the following order:

    1. XR SDK
    2. Ocumen
    3. Other packages (if any)

Import Samples

Most packages come with samples and other Ocumen documentation often refer to these. You should import them into your project by pressing the Import-button in the Package Manager.

Some samples might require you to make additional choices after importing, e.g., resolving dependencies. You should usually confirm these dialogs, e.g., by clicking “Agree” or importing “Essentials” and reload the scene.

If your project is using Universal Render Pipeline (URP) remember that you might need to upgrade certain shaders in the samples.


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 script in your scene.

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


Hardware-Specific Setup

The Tobii Ocumen packages and samples are set up without any external SDK dependency. For some platforms additional steps need to be taken:

Pico Neo

To be able to run them on your Pico Neo device, follow the guide by clicking one of the links below

  • Pico Neo 2 Eye, skipping Step 4 of importing the XR SDK since it is already bundled in Tobii Ocumen.
  • Pico Neo 3 Pro Eye, skipping Step 4 of importing the XR SDK since it is already bundled in Tobii Ocumen.