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
  • Load 3D avatars
  • Skeletal Mesh Component
  • Ready Player Me Component
  • Loading the avatar
  • Load 2D avatars
  • Avatar Render Properties

Was this helpful?

  1. Integration Guides
  2. Unreal Engine

Load Avatars

Load 3D and 2D avatars into your Unreal Engine project.

PreviousWebView Avatar CreatorNextAnimations

Last updated 19 days ago

Was this helpful?

In this guide, you learn how to load avatars into your Unreal Engine project.

  • .

  • .

Load 3D avatars

The Ready Player Me Unreal Engine plugin comes with sample actor blueprints BP_RPM_SimpleActor and BP_RPM_Character, which demonstrates how to load the Ready Player Me avatars at runtime. You can refer to those sample actors when implementing your actor.

Similar to these samples you can set your actor to load the Ready Player Me avatars at runtime. To do so, make sure that your actor blueprint has at least one SkeletalMeshComponet, then add a ReadyPlayerMeComponent to your actor.

Skeletal Mesh Component

  1. Select the SkeletalMeshComponent. The SkeletalMeshComponent is required and holds all the skeletal mesh data once the avatar has been loaded.

  2. Examine its Details and under the Animation heading, find the AnimClass property. Its default value is BP_RPM_Animation. You need to set this to the Animation Blueprint you want to use for the character.

  3. In the same details panel search for the Phisycs Asset Override parameter and set it to the RPM_Mixamo_PhysicsAsset. This will prevent issues with the shadows on the loaded avatar.

Ready Player Me Component

The ReadyPlayerMeComponent is an ActorComponent that you can add to any existing actor.

  1. Select the ReadyPlayerMe Component. The ReadyPlayerMeComponent has all the functionality required for loading a Ready Player Me avatar with a single function call.

  2. Examine its details under the Ready Player Me heading. Find the Url and Target Skeleton properties.

  • Url contains the Ready Player Me Avatar Url or ID of an avatar created with the Avatar Creator.

  • Target Skeleton defines the skeleton that the loaded character will use with skinning and animation.

The ReadyPlayerMeComponent requires a SkeletalMeshComponent to work properly. If you have more than one SkeletalMeshComponent in your actor, you need to explicitly set the SkeletalMesh property of the ReadyPlayerMeComponet before loading an avatar.

If you want to create or use your own target skeleton, it must perfectly match the skeleton that you are loading from the URL. We do not recommend that you change this property.

Loading the avatar

You can use two different methods for loading an avatar using the ReadyPlayerMeComponent: LoadAvatar or LoadNewAvatar

  • LoadAvatar only requires a reference to the ReadyPlayerMe Component you wish to run it on. This function assumes that you have already set the Url to use for loading the avatar model.

  • LoadNewAvatar has an additional Url parameter so that you can update the ReadyPlayerMeComponent's Url variable before loading the avatar.

Both of these functions have success and failure callback events that you can subscribe to.

Load 2D avatars

You can load a 2D render of your avatar using the LoadAvatarRenderAsync async action node which obtains a rendered image of your avatar via the Render API.

The URL of the avatar needs to be provided for rendering the avatar.

void Load(const FString& Url, const FRpmAvatarRenderProperties& Properties, const TMap<EAvatarMorphTarget, float>& BlendShapes, const FDownloadImageCompleted& OnCompleted, const FDownloadImageFailed& OnFailed)

Avatar Render Properties

You customize the look and quality of the rendered image by customizing AvatarRenderProperties.

👩‍💻
Load 3D avatars
Load 2D avatars