Custom Avatar Creator
Integrate and customize the Ready Player Me Avatar Creator with your Unreal Engine application.
Last updated
Was this helpful?
Integrate and customize the Ready Player Me Avatar Creator with your Unreal Engine application.
Last updated
Was this helpful?
You can integrate the Ready Player Me Custom Avatar Creator using AvatarCreator open-source plugin. The plugin is an in-engine implementation of the web avatar creator.
Note that same as the SDK the Custom Avatar Creator in Unreal Engine works from UE 4.27 and higher and works on all the supported platforms. It also requires projects with the SDK already integrated into them.
You can Add the latest released version of the AvatarCreator open-source plugin to your project and see it working in the AvatarCreatorDemo map.
Follow the steps in the ReadMe and learn how it works and how it is set up.
A demo map is included in the plugin for demonstrating how the Sample Avatar Creator opens at runtime. It is located in the RpmAvatarCreator\Content\Maps folder. To add the AvatarCreator widget to your project simply copy the existing blueprint logic from the demo map into your project.
AvatarCreator is a widget that can be added to a map or another widget. Inside the DemoMap we create and add the widget to the viewport. AvatarCreator can be customized by providing default values when the widget is created. We need to subscribe to the Avatar Saved event to get the URL when the avatar is saved. We need to subscribe to the Avatar Selected event as well to get the URL when the avatar is selected from the list of user avatars. Additionally, we can load an avatar with this URL afterward.
When spawning the Avatar Creator widget, it's possible to configure it with the specified parameters.
Customization options:
Partner Domain Specify your partner domain
Select Body Type Allows skipping the body type selection screen
Select Gender Allows skipping the gender selection screen
Allow Close Button Hides the close button
Allow Webcam Enables the selfie selection screen if the webcam is available
Default Avatar Ids Specify the avatars that will be shown on the Pick An Avatar page. Default avatars are the template avatars that will be used for creating new avatars. Important this field needs to be filled with the avatar ids from the demo map.
The plugin Content represents a sample project, if you want to have a completely different UI, you can duplicate the sample project and change the UI. If you duplicated the sample and customized the UI in an older version of the plugin, you can check the change log and update manually your custom UI according to the changes.
AvatarCreator sample uses AvatarCreatorApi C++ class for communicating with the Ready Player Me Backend. The plugin Content can be completely rewritten to suit your project needs while using the AvatarCreatorApi for communication with the Backend.
