Import Oculus Integration SDK Package (Legacy)
Updated: Jul 8, 2024
Oculus Integration SDK Release Deprecation
The Oculus Integration SDK releases have been deprecated after the version 57 release. Version 59 and newer Meta XR SDKs are available using the Unity Package Manager.For release v57 and earlier, the Oculus Integration SDK, OculusIntegration.unitypackage
, is an all-in-one source for core VR features, components, scripts, and plugins to ease and enhance the app development process in Unity. It packages several SDKs, such as utilities package, Interaction SDK, Voice SDK, Platform SDK, and many other features that offer advanced rendering, social and community building, and provides capabilities to build immersive experiences.
Import the latest all-in-one SDK in a Unity project from the
Downloads page. If you’re using any prior version of the Oculus Integration SDK in your existing project, and prefer to upgrade to the latest SDK without creating a new project, go to
Upgrade to Latest SDK section.
Import SDK from Unity Asset Store
The Unity Asset Store contains a wide variety of assets, including SDKs and frameworks. The Oculus Integration SDK is packaged as one file with .unitypackage
extension and is available on the Unity Asset Store.
- Create a new 3D project in Unity.
- Go to the Unity Asset Store, sign in using your Unity credentials, and then click Open in Unity.
Unity opens the Package Manager window in the Unity editor.
- Enter Unity credentials, if prompted.
- On the Package Manager window, expand Oculus Integration, select the latest version, and then on the bottom-right side of the window, click Download.
- After the download completes, click Import to import the latest SDK into your project.
- On the Import Unity Package window, leave all the files and folders selected, and click Import.
When prompted to update the Oculus Utilities plugin, click Yes.
This step ensures that you’re using the Oculus Utilities plugin that is bundled with the package you’re installing. If you choose not to update the plugin at this point, you need to
manually update it later.
- When prompted to use OpenXR as the backend, click Use OpenXR to set the backend to use OpenXR. If you wish to continue using the legacy VRAPI backend, click Cancel. For more information about how Oculus XR Plugin interacts with OVRPlugin, see Install, Uninstall, and Upgrade XR Plugin.
- When prompted to clean up old Interaction SDK assets, click Show Assets, and then click Delete Assets.
- When prompted to update Spatializer plugins, click Upgrade, and then click Restart.
Import SDK from Downloads page (developer center)
The Downloads page serves as a one-stop shop for a wide variety of SDKs and tools that can aid your app development.
- Go to the package page in the developer center page and then click Download.
- Create a new 3D project in Unity.
- On the menu, go to Assets > Import Package > Custom Package.
- Locate the downloaded .unitypackage file and click Import.
- On the Import Unity Package window, leave all the files and folders selected, and click Import.
When prompted to update the Oculus Utilities plugin, click Yes.
This step ensures that you’re using the Oculus Utilities plugin that is bundled with the package you’re installing. If you choose not to update the plugin at this point, you need to
manually update it later.
- When prompted to use OpenXR as the backend, click Use OpenXR to set the backend to use OpenXR. If you wish to continue using the legacy VRAPI backend, click Cancel. For more information about how Oculus XR Plugin interacts with OVRPlugin, see Set Oculus Utilities Plugin to OpenXR.
- When prompted to clean up old Interaction SDK assets, click Show Assets, and then click Delete Assets.
- When prompted to update Spatializer plugins, click Upgrade, and then click Restart.
This section details instructions to upgrade any prior versions of the Oculus Integration SDK, which you’re using in the existing project, to the latest version.
- Close Unity, if open.
- On your computer, go to the folder where you’ve saved the project. For example,
/username/sample-project/
. - In your project, open the
Assets
folder, and then delete the Oculus
folder. - Within your project, search for files beginning with the following text and manually remove them:
Oculus
and OVR
. In addition, if you’re building an Android app, search for filenames starting or matching with AndroidManifest
, vrapi
, vrlib
, and vrplatlib
. These files are usually located in different folders of your project so it’s best to search by the filename and then remove them. - Open the project in which you want to upgrade the package.
The manual deletion of the files from the prior version avoids the overwriting of certain files and multiple plugin versions.
Revert to earlier SDK Version
Unity Asset Store always offers the latest Oculus Integration SDK version. To revert to any of the earlier versions, do the following:
- Go to the Meta Quest Developer Center page, select any earlier version from the list, and then click Download.
Remove the existing Oculus Integration files by following step 1 through step 4 from the
Upgrade to Latest SDK section.
Note: You can skip this step if you are importing an earlier version in a new project.
- Open the project in which you want to import the SDK. Alternatively, if you are importing it in a new project, create a new 3D project.
- From the menu, go to Assets > Import Package > Custom Package.
- Locate the earlier version of the package on your computer and click Open. The package name is set to
OculusIntegration.unitypackage
. We recommend that you rename the package with the relevant version number. For example, if you are importing Oculus Integration version 14.0, rename the package to OculusIntegration_v14.0.unitypackage
. - Follow step 5 onwards from the Import from Unity Asset Store or Import SDK from Meta Quest Developer Center section.
Update OVRPlugin manually
The Oculus Integration SDK contains utilities plugin, OVRPlugin
, which provides built-in editor support and several additional features. It is versioned to ensure compatibility with the package, and with each new release of the package, its version upgrades. We highly recommend that you always use OVRPlugin that is bundled with the package.
During the package installation process, Unity prompts to update the OVRPlugin. If you clicked Yes and restarted Unity, you’re all set and you don’t need to take any action. In case you clicked No at that point, you can update it manually:
- In Unity, go to Meta > Tools > OVR Utilities Plugin > Manual Update OVR Plugin.
Oculus Integration SDK releases have been deprecated since version 57. We recommend that you migrate your projects to Meta XR SDKs as soon as possible in order to access the latest features and improvements, including new SDKs such as
Mixed Reality Utility Kit.
Note: Migrating from the Oculus Integration SDK to Meta XR SDKs requires the removal of existing content. We recommend creating a backup of your existing Unity project before upgrading.
To migrate to Meta XR SDKs:
- Close Unity, if open.
- On your computer, go to the folder where you’ve saved the project. For example,
/username/sample-project/
. - In your project, open the
Assets
folder, and then delete the Oculus
folders. - In your project, open the
Library
folder, and then delete /Library/PackageCache/
. - Re-open the project. Open in Safe Mode if prompted, as the project is likely to have compile errors.
- Follow the steps here to install Meta XR SDKs as UPM packages. We recommend starting with the Meta XR All-in-One SDK, as that package includes a similar feature set to the legacy Oculus Integrations SDK.
- If your project has errors or missing assets, this is likely because larger sample assets (such as SampleFrameworks) have been moved to Github as Unity StarterSamples. Follow the instructions here to import the assets into your project.
Common issues with migration If you followed the migration steps and are still running into issues, try the following:
- If any custom modifications were made to existing Meta XR SDK files, these custom changes must be manually merged into the new UPM-distributed Meta XR SDK files. For more information, see Import Meta XR Packages.
- There may be legacy Oculus files being referenced outside of the
Assets/Oculus
folder. To clean these up, search for files beginning with the following text and manually remove them: Oculus
and OVR
. In addition, if you’re building an Android app, search for filenames starting or matching with AndroidManifest
, vrapi
, vrlib
, and vrplatlib
. These files are usually located in different folders of your project so it’s best to search by the filename and then remove them.
Note: Reverting to the Oculus Integration SDK requires removal of Meta XR SDK packages from your project using the Unity Package Manager.
To revert to Oculus Integration SDK:
- Navigate to Window > Package Manager.
- Select installed Meta XR SDK.
- Click Remove button to uninstall the Meta XR SDK.
- Repeat for all installed Meta XR SDKs.
- Follow the Import SDK from Developer Center instructions on the Import Oculus Integration SDK page.