Our Unity SDK has undergone a major transition to a modular architecture in order to ensure its maintainability and extendability. As part of this transition, several breaking changes have been introduced from the previous Unity SDK 1.x.

This guide outlines these changes and provides instructions on how to migrate from the old Unity SDK 1.x to the new one.

The new Unity SDK

We reorganized the modules into Unity Packages, made a few necessary changes to the API and the Samples now can be imported on demand.

Modules

The Ready Player Me Unity SDK 2.0 has been split into separate modules to improve development processes and to better enable development on different parts of the SDK simultaneously. As such the Unity SDK consists of 2 main modules:

• Unity SDK Core
• Unity SDK Avatar Loader

Unity-SDK-Core

As the name suggests, Unity-SDK-Core holds all the core functionality of the Ready Player Me Unity SDK plus all the classes and structures that are commonly used in other modules. Here is a list of components included in the Unity-SDK-Core module

• Module update and install manager
• Custom editor window base class
• Optional editor analytics
• Core RPM Avatar classes and data structures
  • Avatar config and RPM settings classes

Unity-SDK-Avatar-Loader

This module contains all the classes and structures related to loading avatar models and avatar renders.

Ready Player Me plugins moved to Packages

The new SDK modules are no longer installed into Assets folder but rather it is now in the Packages folder with all the other Unity plugins.