Unity SDK Update guide

This guide provides instructions for updating the MultiSet Unity SDK in your Unity project using the Unity Package Manager (UPM) and how to safely work with the included sample scenes.

SDK Update Guidelines

The MultiSet Unity SDK is installed via a Git URL through the Unity Package Manager. To ensure you have the latest features and bug fixes, you can update the SDK directly from the Package Manager.

1. Open the Package Manager: In the Unity Editor, navigate to Window > Package Manager.

2. Locate the SDK: In the Package Manager window, find and select "MultiSet-SDK" from the list of packages in your project.

3. Update the Package: If an update is available, a "Update" button will be visible. Click this button to download and install the latest version of the SDK.

Alternatively, you can remove the existing package and re-add it using the Git URL to ensure you have the most recent version.

Working with Sample Scenes

The MultiSet Unity SDK includes several sample scenes to help you understand and integrate its features.

Location of Sample Scenes

After installing the SDK via the Unity Package Manager with the GitHub URL (https://github.com/MultiSet-AI/multiset-quest-sdk.git), you can find the sample scenes in the following directory: Assets/Samples/MultiSet-SDK/x.x.x/Sample Scenes/

Important Steps for Using Sample Scenes Safely

To avoid losing your work when updating the SDK, it is crucial that you do not edit the sample scenes directly in their original location. The contents of this folder are managed by Unity and will be replaced when the SDK is updated.

1. Locate the Sample Scenes: Navigate to the Assets/Samples/MultiSet-SDK/x.x.x/Sample Scenes/ directory within your Unity project.

2. Copy, Don't Edit Directly: Copy any sample scene you wish to modify from the SDK's sample folder to a new folder within your project's Assets directory. For example, you can create a folder named Assets/MultiSetDemoScenes/ and paste the copied scene there.

3. Modify the Copied Scene: Open and edit the copied scene from its new location (Assets/MultiSetDemoScenes/).

By following this process, your modified scenes will be preserved and remain unaffected when you update the MultiSet SDK in the future.

Any modifications made directly to the sample scenes within the Assets/Samples/MultiSet-SDK/1.9.2/Sample Scenes/ directory will be lost when the SDK package is updated or re-imported.