How to Update the Pley SDK

📘
Which guide do I follow?
Check how the SDK is installed in your project:

If Window > Package Manager lists Pley SDK, you're on the package version (5.11.0 or newer). Follow Updating the Pley SDK.

If your project has an Assets/Pley/SDK folder, you installed an older .unitypackage version. Follow Moving from the .unitypackage to the package version.

Updating the Pley SDK

The Pley SDK window shows a ⚠️ icon next to the version number when a newer SDK is available. Click it to go to the downloads page.

1) Download the new SDK version from the Game Manager Downloads.

2) Close Unity.

3) Replace the old tarball in your project folder with the new one (for example, replace LocalPackages/com.pley.unity-sdk-5.11.0.tgz with LocalPackages/com.pley.unity-sdk-5.12.0.tgz).

4) Open Packages/manifest.json in a text editor and point the com.pley.unity-sdk entry at the new file:

{
  "dependencies": {
    "com.pley.unity-sdk": "file:../LocalPackages/com.pley.unity-sdk-5.12.0.tgz",
    ...
  }
}

5) Open your project in Unity. The new SDK version is shown at the top of the Window > Pley > SDK window.

6) Commit the new tarball and Packages/manifest.json, and delete the old tarball. When the new version loads, the SDK also updates its files in Assets/Pley/Plugins and Assets/WebGLTemplates/Pley. Commit those changes too. Your settings in Assets/Pley/Resources and pley.yaml are kept.

👍
Why close Unity first?
The Pley SDK includes native Editor libraries. Once Unity has loaded them, they stay loaded until Unity restarts. Updating with Unity closed is the surest way to make Unity load the new version cleanly.

Alternative: update from inside Unity

You can also update without closing Unity:

1) Copy the new tarball into your project folder, next to the old one.

2) Open Window > Package Manager, click +, select Install package from tarball... (Add package from tarball... on Unity 2021 and 2022), and pick the new .tgz file. Unity replaces the existing Pley SDK with the new version.

3) Restart Unity so the new native Editor libraries are loaded.

4) Check that Packages/manifest.json uses a relative path to the new tarball (for example file:../LocalPackages/com.pley.unity-sdk-5.12.0.tgz). Commit it, the new tarball, and the updated files in Assets/Pley/Plugins and Assets/WebGLTemplates/Pley, then delete the old tarball.

Moving from the .unitypackage to the package version

Pley SDK 5.11.0 and newer are installed with the Unity Package Manager instead of a .unitypackage. You only need to do this migration once.

1) Open Window > Pley > Advanced Settings and write down any settings you have changed. These settings are stored inside the old SDK folder and will reset to their defaults.

2) Download the new SDK version from the Game Manager Downloads.

3) Close Unity.

4) Delete the old SDK folder: Assets/Pley/SDK (and Assets/Pley/SDK.meta).

Keep the rest of the Assets/Pley folder. Assets/Pley/Resources holds your Pley configuration.

📘
Updating from 5.1.0 or earlier?
The folder structure is different in these versions. Delete the entire Assets/Pley folder instead of just Assets/Pley/SDK.

5) Open your project in Unity. If the Console shows errors from Pley scripts, they're coming from leftover files of the old SDK. Delete those files before continuing.

6) Install the new SDK version (Read how to here).

7) Open Window > Pley > Advanced Settings and re-apply the settings you wrote down in step 1.

Your selected game is stored in pley.yaml in your project root, so you don't need to select it again.