Ready Player Me Unity SDK Core

This is an open source Unity plugin that contains all the core functionality required for and manages all the plugin updates and dependencies including Ready Player Me Avatar Loader and glTFast.

Please visit the online documentation and join our public discord community.

Online Documentation

Discord Channel

GitHub Discussions

Quick Start

Requirements

• Unity Version 2020.3 or higher
• Git needs to be installed to fetch the Unity package. Download here

1. To add the new Ready Player Me Unity SDK to your project you can use the Unity Package Manager to import the package directly from the Git URL.

2. With your Unity Project open open up the Package Manager window by going to Window > Package Manager.

3. In the Package Manager window click on the + icon in the top left corner and select Add Package From Git URL.

4. Paste in this url

https://github.com/readyplayerme/rpm-unity-sdk-core.git

5. Click add and wait for the import process to finish.

After the process is complete you project will have imported these packages:

• Ready Player Me Core
• Ready Player Me Avatar Loader
• Ready Player Me WebView
• glTFast

Alternate Installation

Using Git URL

1. Navigate to your project's Packages folder and open the manifest.json file.
2. Add this line below the "dependencies": { line

   • "com.readyplayerme.core": "https://github.com/readyplayerme/rpm-unity-sdk-core.git",

3. UPM should now install the package.

OpenUPM (using command line)

1. The package is available on the openupm registry.
2. Execute the openum command.

   • openupm add com.readyplayerme.core
     

OpenUPM (using editor)

1. Open Edit | Project Settings | Package Manager
2. Add a new Scoped Registry (or edit the existing OpenUPM entry)

   • Name     package.openupm.com
     URL      https://package.openupm.com
     Scope(s) com.readyplayerme.core
     

3. Click Save (or Apply)
4. Open Window/Package Manager
5. Click +
6. Select Add package by name... or Add package from git URL...
7. Paste com.readyplayerme.core into name
8. Click Add

OpenUPM (using manifest)

1. Add this to manifest

   • "scopedRegistries": [
        {
            "name": "package.openupm.com",
            "url": "https://package.openupm.com",
            "scopes": [
                "com.readyplayerme.core"
            ]
        }
     ],
     "dependencies": {
        "com.readyplayerme.core": "1.0.0"
       }
     }