Import Oculus Integration Package

All-In-One VR

The Oculus Integration package, OculusIntegration.unitypackage, is an all-in-one source for core VR features, components, scripts, and plugins to ease and enhance the Oculus app development process in Unity. It packages several vital SDKs that offer advanced rendering, social and community building, sample framework, audio, and avatar development support for your app. It includes: VR, Audio Manager, Avatar, Platform, Sample framework, Spatializer, and LipSync.

Import Latest Package Into New Project

This section details instructions to import the latest Oculus Integration package into a new Unity project. If you’re using any prior version of the package in your existing project, you can upgrade it to the latest version.

  1. Create a new 3D project in Unity.
  2. From the menu, go to Window > Asset Store.
  3. In the asset store, search for Oculus Integration.
  4. From the result, click Oculus Integration and then click Import.
  5. In the Import Unity Package window, leave all the files and folders selected, and click Import.
  6. When prompted to update the Oculus Utilities plugin, OVRPlugin, click Yes, and click Restart.

    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.

  7. When prompted to update Spatializer plugins, click Upgrade and click Restart.

Upgrade To Latest Package

This section details instructions to upgrade any prior versions of the Oculus Integration package, which you’re using in existing projects, to the latest version of the package.

  1. Close Unity, if open.
  2. On your computer, go to the folder where you’ve saved the project. For example, /username/sample-project/.
  3. In your project, go to the Assets folder and delete the Oculus folder.
  4. Within your project, search for files beginning with the following text and manually delete 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 manually delete them.
  5. Open the project in which you want to upgrade the package.
  6. Follow step 2 through step 7 from the Import latest package into a new project section.

    The reason for manual deletion of files of the prior version is to avoid the overwriting of certain files and to not have multiple plugins installed with different versions. This way you can ensure that your project is using the correct plugin version bundled with the package you’re installing.

Revert To Prior Versions Of Package

Unity Asset Store always offers the latest Oculus Integration package. To revert to any of the prior versions of the package, do the following:

  1. Go to Unity Integration Archive, select the version from the list, and click Download.
  2. To import prior version of the package in existing project, follow step 1 through step 4 from the Upgrade to latest package section.

    Note: You can skip this step if you are importing prior version in a new project.

  3. Open the project in which you want to import the prior version of the package. Alternatively, if you are importing it in a new project, create a new 3D project.
  4. From the menu, go to Assets > Import Package > Custom Package.
  5. Locate the prior 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 prior version number. For example, if you are importing Oculus Integration version 14.0, rename the package to OculusIntegration_v14.0.unitypackage.
  6. Follow step 5 through step 7 from the Import latest package into a new project section.

Update OVRPlugin Manually

The Oculus Integration package 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 (step 6 from the Import latest package section). If you’ve 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 Oculus > Tools > Update OVR Utilities Plugin.