Upgrade Guide

3.x to a higher 3.x (01-23-2024)

1. Close the Unity Editor

Before initiating the upgrade process, please ensure that you exit the Unity Editor.

2. Remove Obsolete Files

Navigate to your Unity Project files and delete the folder: Assets/FrameplaySDK/Native

3. Open the Unity Project in Safe Mode

1. Open your Unity Project. Unity will prompt you to Enter Safe Mode (opens new window) due to the temporary missing references. Unity automatically exits Safe Mode when you have resolved all the compilation errors
2. Select Enter in Safe Mode

4. Import the Upgrading Frameplay SDK

1. Download the latest version of the Frameplay plugin from the downloads page (opens new window)
2. Drag and drop the .unitypackage into the Project Window and select Import. This will automatically resolve any compilation errors

2.x to 3.x (12-09-2023)

If you have configured an Instanced Override (opens new window) of a Prefab containing an Ad Space Game Object, please follow this prerequisite step

1. Remove Obsolete Files

Delete the following folders from your project: FrameplaySDK/DLL, FrameplaySDK/Editor, FrameplaySDK/Example, FrameplaySDK/Materials, FrameplaySDK/Plugins, FrameplaySDK/Scripts, FrameplaySDK/Shaders and FrameplaySDK/Textures. Compile errors and missing assets will be fixed by the updated asset.

2. Import the Updated SDK Asset

1. Download the latest version of the Frameplay plugin from the downloads page (opens new window)
2. Open your project in the Unity editor.
3. Select Assets > Import Package > Custom Package and locate the FrameplayPlugin.unitypackage.
4. Make sure all files are selected and click Import.

3. Update Project Data

1. Select the editor menu Frameplay > Upgrade Frameplay Project Data
2. Select the editor menu Frameplay > Developer Settings

This completes the SDK upgrade. After successfully upgrading your project, the following logs will appear in the Console:

4. (Additional) Update Script References

If you have customized your integration with Frameplays API, you may need to update your scripts. The Frameplay SDK is now initialized by calling Frameplay.Session.Start(). We have provided an example script FrameplaySDK/Example/Scripts/FrameplayStartSession.cs that will initialize the SDK and register the in-game camera.

Please update your references to the Frameplay API. Full API details can be found here

TroubleShooting

If you encounter any issues while upgrading the SDK, please contact our Integration Team for support. Please attach the FrameplayUpgradeProject.xml file located at the root of your project.