Wolf3D Ready Player Me Unity SDK is an extension to www.readyplayer.me avatar platform to load created avatars in Unity.

For upcoming features please visit https://readyplayer.me/roadmap or say hi on our Discord!

Previous Documentation Versions

Requirements

• The SDK supports Unity 2018LTS and newer versions of the Unity3D game engine.
• A valid avatar URL created from www.readyplayer.me to import an avatar to Unity scene.

<aside> 💡 Currently, a URL is required to load an avatar. Downloading avatars via avatar shortcode (i.e. ABC123) will be available shortly. Visit https://readyplayer.me/roadmap for more info.

</aside>

<aside> ⚠️ For IOS builds Microphone Usage Description field in Player Settings must be filled with appropriate message. VoiceHandler component requires microphone permission and if this area is not filled the build will fail. To build without mic permission, simply remove this script.

</aside>

How to use

RPM Unity SDK editor window can be launched from ReadyPlayerMe > Avatar Loader menu. To create and save your avatar in editor time, simply paste your avatar URL and click on Load Avatar button.

To be able to load an avatar during play time, create an instance of AvatarLoader and call LoadAvatar method from the instance with the URL of the avatar to load.

private void LoadAvatar()
{
	AvatarLoader avatarLoader = new AvatarLoader();
	avatarLoader.LoadAvatar(avatarUrl, AvatarLoadedCallback);
}

private void AvatarLoadedCallback(GameObject avatar)
{
	Debug.Log("Avatar Loaded!");
}

This operation will download and load the avatar model to the scene and via a callback method you can get access to the avatar game object in the scene.