Develop

Oculus Integration SDK (Legacy)

Updated: Nov 15, 2018|
Version
1.31.0
Oculus Integration SDK has been replaced by Meta XR UPM packages as of v59. Please download the UPM packages instead. The latest Oculus Integration SDK for Unity packages OVRPlugin, Interaction SDK (Experimental), Platform SDK, Voice SDK, Audio SDK, and Lipsync SDK.

Version 1.31.0 Release Notes

The Oculus Integration for Unity is available in the Unity Asset Store. Download the package from the Oculus Integration page, or by searching for Oculus Unity Integration in the Asset Store tab of the Unity Editor.

Please see Compatibility and Version Requirements for important known Unity issues and support information.

The Oculus Utilities for Unity package includes includes scripts, prefabs, and other resources to supplement Unity’s built-in support. The package includes an interface for controlling VR camera behavior, a first-person control prefab, a unified input API for controllers, advanced rendering features, object-grabbing and haptics scripts for Touch, debugging tools, and more.

New Features

  • Added cross-platform development support to the Unity Integration. Starting with 1.31 developers can use the Oculus Integration and Utilities to develop VR apps for multiple platforms. Please see the Unity Cross-Platform Development guide for more information.
  • Added SetColorScaleAndOffset() to OVRManager. Use SetColorScaleAndOffset() to apply post-rendering effects to the scene. Additional information can be found in the OVRManager guide.
  • Integration Changes

  • 1.31 contains changes to the structure of the Oculus Integration package and includes new assembly definition files (.asmdef). These files will package the Oculus Utilities scripts into 3 DLLs: Oculus.VR.dll, Oculus.VR.Editor.dll and Oculus.VR.Scripts.Editor.dll. Developers who use their own assembly definitions will need to add references to Oculus.VR.. Information about how Unity uses assembly definition files can be found in Unity's Script compilation and assembly definition files page.
  • The Unity Integration 1.31 contains the following changes to the Oculus Integration for Unity package:
  • Update the Oculus Utilities to 1.31
  • Update the Platform SDK to 1.31
  • Update the Avatar SDK to 1.31
  • Update the Audio Spatializer to 1.31
  • Bug Fixes

  • Added support for Mobile sRGB. This fixes a conversion issue where on Mobile and when the rendering Color Space was set to 'Linear', the resulting scene was overly dark from an improper linear to gamma conversion.
  • Angular Velocity and Acceleration in the Unity Integration 1.31


    Angular velocity and angular acceleration values are reported in 1.31 in degrees, not radians.

    Import instructions


    To import Oculus Integration for Unity into your project, perform the following steps:

    1. Manually Delete any Previous Versions


    If you have previously imported another version of the Integration or Utilities package into your project, delete the following Oculus content from your Unity project folder before importing a new version:

    Note: Be sure to close the Unity Editor before proceeding.
    Files to delete in Utilities version 1.22 or earlier
    Files to delete in Utilities versions after 1.22

    2. Open or Create a Unity Project


    If you're already working in a Unity project, save your work before importing. Otherwise, create a new project:

  • From the Unity menu, select File > New Project.
  • Click the Browse button and select the folder where the Unity project will be located.
  • Make sure that the Setup defaults for: field is set to 3D.
  • Click the Create button.
  • 3. Import the Unity Package


    The latest Oculus Integration for Unity is available in the Unity Asset Store. Download the package from the Oculus Integration page, or by searching for Oculus Unity Integration in the Asset Store tab of the Unity Editor.

    When the Importing package dialog opens, leave all of the boxes checked and select Import.

    4. Update OVRPlugin (Optional)


    The Oculus OVRPlugin provides built-in Editor support and some additional features. The latest version is included in the Utilities for Unity package, and if it is later than the detected version in the Editor, you're given the option to automatically update your project. We always recommend using the latest version.

    Version-Specific Known Issues


    This section details known issues with specific versions of Unity.

    General Unity Known Issues


    This section details known issues with Unity that are not tied to a specific version. Issues are grouped by most closely related subject.

    Package Description


    Unity versions 5.1 and later provide built-in VR support for the Oculus Rift, Samsung Gear VR, and Oculus Go. The Unity package includes prefabs, C# scripts, sample scenes, and more to assist with development. For more information, see our Unity Getting Started Guide.

    For information on which versions of the Unity Editor are supported, please see Compatibility and Version Requirements.

    Be sure to review our Downloads page for other useful tools to assist development, such as the Unity Sample Framework. For more information on Oculus resources for Unity developers, please see Other Oculus Resources for Unity Developers.