LogoLogo
WebsiteBlogForumsSign up
  • Welcome
  • How Ready Player Me works
  • FAQ
  • 👩‍💻Integration Guides
    • Overview
    • Unity
      • Quickstart
      • Avatar Creator Integration
        • WebView Avatar Creator
          • Avatar Creator for Android & iOS
          • Avatar Creator for WebGL
        • Build your own Avatar Creator
          • Start with the sample
          • Elements
            • Asset Selection Element
            • Color Selection Element
            • Template Selection Element
            • Body Shapes Selection Element
            • Gender Selection Element
            • Avatar List Element
            • Photo Capture Element
            • Signup Element
            • Login Element
            • Logout Element
          • User Management
      • Load 2D Renders
      • Avatar Loader Window
      • Setup Multiplayer
      • Setup for XR (Beta)
        • Setup the Player Avatar
        • Setup Meta Movement SDK
        • Setup Final IK
        • Setup XR Hands
          • RpmHandDriver script
        • Facial Animations
        • VR Avatar Creator
      • Animations
        • Ready Player Me Animation Library
        • Mixamo Animations
      • Optimize
        • Avatar Configuration
        • Avatar Caching
        • Defer Agents
      • Code Samples
        • Loading 3D Avatars
        • Loading 2D Avatars
        • Avatar Creator (WebGL)
        • Avatar Creator (Desktop)
        • Avatar Creator (Mobile)
        • Distance-based LODs
      • Troubleshooting
        • Editor UI Window Issues
        • Avatar loading issues
        • iOS issues
        • WebGL issues
        • Firewall issues
        • Updating the SDK
          • Unity SDK 3.0.0 Migration guide
          • Unity SDK 4.0.0 Migration guide
          • Unity SDK 5.0.0
          • Unity SDK 7.0.0
          • WebView 2.0 Migration
        • Package installation issues
      • Help us improve the Unity SDK
      • FAQ for Unity
      • Early Access Features
    • Unreal Engine
      • Quickstart
        • Import SDK Manually
      • Avatar Creator Integration
        • Build your own Avatar Creator
          • Sample Structure
          • Customization Guide
        • WebView Avatar Creator
      • Load Avatars
      • Animations
        • Ready Player Me Animation Library
        • Loading Mixamo animations
        • Mannequin animation retargeting
        • Blender FBX export to UE
        • Oculus Lipsync integration
      • Optimize
        • Avatar configuration
        • Avatar caching
        • Avatar preloading
      • Code Samples
        • Unreal Engine 5 samples
        • Lyra project integration example
        • VR Avatars
        • Unreal Engine 4
      • Troubleshooting
        • Project compilation issues
        • Missing materials on built applications
        • Avatar loading issues
        • Animation issues
        • Unreal SDK breaking changes
        • Avatar lighting issues
        • Updating from earlier versions
          • Unreal SDK 3.0.0 Migration guide
        • Auto LOD issues
      • Help us improve the Unreal Engine SDK
      • FAQ for Unreal Engine
      • Early Access Features
    • React
      • Quickstart
    • React Native
    • iOS Native
    • Android Native
    • Web Integration
      • Quickstart
      • User Management
        • Guest Accounts
        • Account Linking
      • Avatar Creator integration
      • Optimize
    • API Integration
      • Quickstart
      • Custom Avatar Creator
      • User management
        • Ready Player Me Account
        • Anonymous Accounts
    • UX/UI Guidelines
      • Summary & quick tips
      • UX and UI guidelines and essentials
        • Foundation for good user experience
          • Layout
          • Colors
          • Typography
          • Icons
          • Dark mode and light mode
        • Mobile best practices
          • Layout
        • Making Ready Player Me feel native
          • Seamless Avatar Integration
          • Consistent Branding
          • Responsive Layout
          • Performance Optimization
        • Discoverability of the avatar editor
          • Onboarding tutorial
          • Clear navigation
          • Contextual Placement
  • 🖌️Customizing Guides
    • Studio (Developer Dashboard)
    • Avatar Creator Appearance
      • Avatar URLs
      • Avatar Shortcodes
    • Upload and Manage Custom Assets
      • Asset Manager in Studio
      • Configure in Studio
      • Manage custom assets using the API
      • Unlocking assets through API (Beta)
    • Create Custom Assets
      • Fullbody Outfits
        • Checking Skin Weights
      • Tops, Bottoms, Shoes
        • Editing templates
      • Hairstyle
      • Headwear
      • Facewear
      • Glasses
      • Hero Characters
      • Modeling Guidelines
  • 🔃API Reference
    • REST API
      • Authentication
      • Avatars
        • GET - 3D avatar
        • GET - 2D Render of an Avatar
        • GET - Metadata
        • PUT - Equip an asset
        • PUT - Unequip an asset
      • Assets
        • Asset Entity Properties
        • POST - Create Asset
        • GET - List Assets
        • PATCH - Update Asset
        • POST - Upload Asset Files
        • POST - Add Asset to Application
        • DELETE - Remove Asset from Application
        • PUT - Unlock asset for a user
        • PUT - Lock asset for a user
      • Users
        • POST - Create User
      • Auth
        • GET - Token
      • Changelog
    • Avatars
      • Full-body avatars
      • Full-body XR avatars
      • Half-body avatars
      • Morph targets
        • Apple ARKit
        • Oculus OVR LipSync
    • Avatar Creator
  • 🔉Support
    • Forums
    • Licensing & Privacy
Powered by GitBook
On this page
  • The new Ready Player Me Core
  • Modules
  • API changes
  • Sample Scenes
  • Update guide
  • 1. Backup
  • 2. Remove Avatar Loader (if present)
  • 3. Update or import the latest Ready Player Me Core
  • Compilation errors or failed install

Was this helpful?

  1. Integration Guides
  2. Unity
  3. Troubleshooting
  4. Updating the SDK

Unity SDK 3.0.0 Migration guide

PreviousUpdating the SDKNextUnity SDK 4.0.0 Migration guide

Last updated 1 year ago

Was this helpful?

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.

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

Dependencies will only be installed if you do not have any compile errors.

  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)

  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

If you have customized avatar configurations or made changes to the animator that’s delivered with the SDK, you should back them up so that you can refer to them after you have updated to the new SDK.

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

For this, to work you need to have Git installed on your machine. After installation, you will also need to restart Unity. Git can be downloaded from .

CoreSettings (scriptable object)

👩‍💻
Unity-SDK-Core
Unity-SDK-WebView
here