Immerse

Upgrading the Immerse SDK

Step 1 of 13 | 30 mins

Setting up an Immerse Scene

📘

As of December 2019, the Immerse SDK supports Unity version 2018.4.12

🚧

Always create a backup before upgrading a project!

🚧

This version contains some breaking changes.

Project Settings:

  • Some settings that previously used ConfigComponent or are now found under the Immerse section of Unity's Project Settings window. As a result, these components have been removed and their settings will need to be reapplied in the Project Settings window.
  • FreeTeleportSettingsConfig, HandMenuSettingsConfig and ControllerSettingsConfig scripts which previously were children of the App script have all been moved to Project Settings.

To identify which version of the Immerse SDK is being used in an existing project look in Immerse > About in the Unity editor menu.

Upgrading to v3.9.0

  1. Download the v3.9.0 SDK package from vr.immerse.io/downloads .
  • Backup Unity project(s)
    Note: If you have made any avatar recordings in your project, you will need to move them out of the ImmerseSDK folder and elsewhere in your project while you upgrade.
  • Open File Explorer and navigate to the Unity project.
  • Delete both the Assets/ImmerseSDK and Assets/SteamVR folders
    ( Do not delete these within the Unity editor, use Windows File Explorer instead)
  • Set the Scripting Runtime Version to '.NET 4.x Equivalent' in Player Settings > Other Settings > Configuration > Scripting Runtime Version
  • Set the API Compatibility Level to '.NET 4.x' in Player Settings > Other Settings > Configuration > API Compatibility Level
  • Import the new Immerse SDK package using the usual process by selecting Assets > Import Package > Custom Package from the menu in the Editor.
  • If SteamVR was previously installed, follow the steps below:
  • Delete the SteamVR folder in your project.
  • Find the App object in your scene and remove the SteamVRConfig component if it is there.
  • Find the App object in your scene and add the UnityXRConfig component if it is not already there.
  • Open the Player Settings, and remove the scripting define IMMERSE_STEAM_VR for all platforms
  • Open the Package Manager, and add OpenVR, Oculus (Desktop) and TextMesh Pro. Also ensure you have the latest of these packages.
  • If SteamVR wasn't previously installed in the Unity project, go to Windows > Package Manager and [Install OpenVR]
  • Open your project in Unity
  • At this stage, if you still have compiler errors, they should be in your own code only, and would need to be fixed before we can continue.
  • You will see a prompt asking if you would like to go ahead with upgrading the project. Select [Yes]
    Note: The upgrade process will go through all your scene and prefab files and fix references to scripts.
  • At a later stage, if you want to copy scene files from another older project, and you see missing script references, you can run Immerse > Utils > Fix Missing Scripts from the menu in the Editor to fix them

Please note, you may get an error with the following message when installing SDK 3.6.0: System.InvalidOperationException: Operation is not valid due to the current state of the object. Please just clear your console to get rid of this.

We are aware of this issue and are working to fix this as soon as possible.

Setting up an Immerse Scene

Updated 3 months ago

Upgrading the Immerse SDK


Step 1 of 13 | 30 mins

Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.