banyapon / rpm-unity-sdk-photon-support

Ready Player Me Unity SDK - Photon Support

Photon Unity Networking 2 support for Ready Player Me avatars.

Photon requires characters to be ready prefabs to be instantiated when a player joins a room, and RPM avatars are used by loading them in runtime. This package helps solve this problem by providing a RPM avatar prefab and a component that handles avatar loading and mesh and material transfer to the character prefab.

This package provides a RPM_Character prefab to be instantiated, a NetworkPlayer component to handle the avatar loading and Avatar Control sample scene to test the avatar in a multiplayer environment.

Requirements

• Photon Unity Networking 2 (PUN2)
• Photon Settings configured with App ID and Region
• Ready Player Me Unity SDK

Installation

• Copy git URL by clicking on green CODE button and then by clicking on copy button as shown.

  

• Open Windox > Package Manager menu, click on Plus (+) button and select Add package from git URL.

  

• Paste the URL in and then click on Add button.

  

• After package installed you should see it under Ready Player Me block.

  

Testing the Sample Project

• Select Ready Player Me Photon Support in Package manager and import the Avatar Control sample.

• Open the Avatar Control scene.

  

• Run the scene, paste your avatar URL and click on load button.

• Build the scene and run it on another device to observe multiple avatars in the same scene.

  

Custom Use

From Ready Player Me menu you can copy an instance of Ready Player Me Character Prefab into Ready Player Me/Resources/RPM_Character.prefab file and modify it for your use case.

To start with the prefab comes with NetworkPlayer, Animator, PhotonView, PhotonAnimatorView and PhotonTransformView components attached. You might further modify it, add or remove components and change the aniamtion controller you are using.

The NetworkPlayer component requires a AvatarConfig and works only with Atlased avatars. You can create a new AvatarConfig to use with your multiplayer characters and use it with your NetworkPlayer component.

In your code, where you instantiate your multiplayer character prefab, you can load the RPM_Character.prefab and call the LoadAvatar method with your avatar URL. This will run a Remote Procedure Call and cause all players to load their own avatars on other players.

GameObject character = PhotonNetwork.Instantiate("RPM_Character", Vector3.zero, Quaternion.identity);
character.GetComponent<NetworkPlayer>().LoadAvatar(inputField.text);

Known Issues

• Avatar Partially Loading: If you did not use a Texture Atlas size selected in yout Avatar Config, you will receive avatar in multiple meshes and you might observe only eyes of the avatar being loaded and that you are getting an IndexOutOfRangeException: Index was outside the bounds of the array. error message. Multiple mesh avatars are not yet supported in the package so please use a config with atlas size selected.
• Shared Access Violation Error: When you test your build locally, all the game instances will try to write avatar file at the same time due to first time download and cause a file read error. Even though remote players won't experience this issue it is troubling while testing your app. You might test with same avatars and after they are cached this issue should not occur.