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
  • 1. Get, download, and install the plugin to your engine
  • 2. Setup plugin for your project
  • 3. Enter your subdomain
  • 4. Help us improve the SDK
  • 5. Integration guide
  • 6. Run the Quickstart Map
  • 7. Load your personal avatar into the scene
  • Explore Ready Player Me plugin content
  • Next steps

Was this helpful?

  1. Integration Guides
  2. Unreal Engine

Quickstart

Import and configure the Unreal Engine SDK for your project.

PreviousUnreal EngineNextImport SDK Manually

Last updated 12 months ago

Was this helpful?

Before you begin

  • Verify your Unreal Version is Unreal Engine 4.27, 5, or higher.

1. Get, download, and install the plugin to your engine

Unreal Marketplace only supports 3 latest versions of Unreal Engine (5.2, 5.3, 5.4). If you want to install the SDK for the other versions, check out how to .

Ready Player Me is available in the marketplace if you search for the . You can get it for free. Once you have downloaded it, install it to your preferred engine.

2. Setup plugin for your project

Ready Player Me Plugin is added to your Engine as a plugin. To enable the plugin for your project, you need to open your project and enable the Ready Player Me plugin.

Once you have enabled it, you need to restart the engine. Once done, you have successfully enabled the plugin for your project.

3. Enter your subdomain

When you integrate the SDK for the first time, you will be greeted with our Setup Guide editor window to guide you through the setup process.

If you want to sign up later, you can also write "demo" in the field.

These fields are needed for the avatar creator to work properly. You can always update the app ID and the subdomain from the project settings.

Then click the next button.

4. Help us improve the SDK

Next, you can enable/disable analytics. This helps us improve the SDKs.

Click the Finish Setup button.

5. Integration guide

The integration guide will help you find the most essential material to integrate Ready Player Me successfully.

The quickest way to see our Ready Player Me avatars in action is to open the Quickstart map by clicking the Load Quickstart Map button.

6. Run the Quickstart Map

Open the QuickStart map and click Play. You can see the default avatar and move around with it.

7. Load your personal avatar into the scene

  1. Press the Q key on the keyboard. This will open the avatar creator window.

  2. Create your personal avatar and click the Save button when you are done.

  3. After loading is complete, you will see your avatar.

The third-person controller is currently designed to work with a keyboard and mouse using the deprecated Unreal Input system. This is done intentionally to support Unreal Engine 4.27.

Explore Ready Player Me plugin content

  • In the Content Browser click Settings (cogwheel icon on the far right)(View Options in UE4). Make sure Show Plugin Content and Show Engine Content are both checked.

Next steps

Next, you will learn in more detail how to:

Please enter your own subdomain and app ID you got from (Developer Dashboard). In the images below you can see where you get the Subdomain and App ID.

Check out the to learn how to integrate Ready Player Me avatars in different projects.

In the Content Browser, expand Engine Plugins(Plugins folder, if you installed the plugin manually) and scroll or use search until you find the ReadyPlayerMe Content folders.

integrate and customize the in your game or app,

load ,

load (e.g., for profile pictures),

your avatars

And the avatars for better performance

If you have trouble creating your project, see for straightforward solutions.

👩‍💻
Studio
Code Samples
Avatar Creator
3D avatars
2D avatars
animate
optimize
Troubleshooting
install it manually
Ready Player Me Avatar and Character Creator
Open your Application
On the top you find the Application Details (Subdomain and App ID)