Unity SDK 3.0.0 Migration guide

Since the initial release of the modular Ready Player Me Unity SDK, it was comprised of 3 separate modules that included Core, Avatar Loader, and WebView. We have learned that the dependency between Core and Avatar Loader causes several difficulties both for maintenance and package installation. As a result, the 3.0 update merges all of the Avatar Loader assets and logic into the Core module.

This guide will outline these changes and provide instructions on how to migrate from the old Ready Player Me Core 1.X.X and Avatar Loader 1.X.X versions.

The new Ready Player Me Core

We merged the Avatar Loader and Core packages into one single Ready Player Me Core 3.0 package.

Modules

As a result of the merge, the Ready Player Me Unity SDK now consists of only 2 modules.

• Unity-SDK-Core

• Unity-SDK-WebView

Ready Player Me Core

This Module contains all the core functionality required for using Ready Player Me avatars in Unity, including features such as:

• Module management and automatic package setup logic

• Avatar loading from .glb files

• Avatar and 2D render requests

• Optional Analytics

• Custom editor windows

• Sample scenes and assets

API changes

AvatarLoader namespace removed

Since Avatar Loader module has been removed and merged into Core, all API's previously under the ReadyPlayerMe.AvatarLoader namespace will now be under the ReadyPlayerMe.Core namespace.

Sample Scenes

All sample scenes can now be found under the Ready Player Me Core section of the Unity package manager window.

Imported samples from Ready Player Me Core will be located at the following path.

Assets/Samples/Ready Player Me Core/PACKAGE_VERSION_NUMBER/SAMPLE_NAME

Update guide

Follow the steps below to import the Unity SDK into a fresh or existing project that already has the old SDK.

1. Backup

It is recommended that you back up your project before updating to the new Unity SDK if you are not using source control, as there are a lot of big changes both in architecture and with the APIs.

2. Remove Avatar Loader (if present)

As mentioned above, this update merges Avatar Loader into Core, so it is important that you first remove the Avatar Loader Package if it currently exists in your project. This can be done from the Unity package manager window.

Also, if you have any of the Avatar Loader samples, be sure to remove them also.

3. Update or import the latest Ready Player Me Core

1. With Unity Editor open go to Window>Package Manager.

   
2. Click the + icon in the top left corner of the Package Manager window.

   
3. Click Add package from git URL.

4. Paste this URL to our Core module: https://github.com/readyplayerme/rpm-unity-sdk-core.git.

   
5. Click Add and wait for the plugins and all required dependencies to be installed.

6. Once the import process is complete, you will notice that it automatically created two assets.

   • AvatarLoaderSettings (scriptable object)

   • CoreSettings (scriptable object)

7. If the upgrade was successful you should see the following 3 in the package manager window

   1. gltFast

   2. Ready Player Me Core

   3. Ready Player Me WebView

      

Compilation errors or failed install

If you have any compile errors as a result of removing the Ready Player Me Avatar load the module installer might fail to install some package dependencies. If you have this issue you can manually import the other packages by adding the by Git URL from the Unity package manager

1. With Unity Editor open, go to Window > Package Manager.

2. Click the + icon in the top left corner of the Package Manager window.

3. Click Add package from git URL.

4. Paste this the URL to our Core module: https://github.com/readyplayerme/rpm-unity-sdk-gltFast.git

5. Click Add and wait for the plugins to be installed.

6. If you are targeting Mobile devices and require a WebView to display the avatar creator you can also add the WebView module https://github.com/readyplayerme/rpm-unity-sdk-webview.git