LogoLogo
PlaygroundVideosBlogPricing
  • Welcome
  • Convai Playground
    • Playground Walkthrough
    • Get Started
    • Character Creator Tool
      • Create Character
      • Language and Speech
      • Knowledge Bank
      • Personality and Style
      • State of Mind
      • Memory
      • Actions
      • Narrative Design
      • Character Versioning
    • F.A.Q
  • Plugins & Integrations
    • Introduction
    • Unity Plugin
      • Pre-Requisites
      • Compatibility
      • Downloads
        • Limitations of WebGL Plugin
      • Setting Up Unity Plugin
      • Troubleshooting Guide
        • Disable Assembly Validation
        • Missing Newtonsoft Json
        • Microphone Permission Issues
        • Default Animations Incompatibility
        • Animations have Facial Blendshapes
        • Jaw Bone in Avatar is not Free
        • macOS Permission Issues
      • Creating a Convai Powered Scene from Template
      • Importing Ready Player Me (RPM) Characters
      • Importing Custom Characters
      • Adding Actions to your Character
      • Adding Lip-Sync to your Character
      • Adding Narrative Design to your Character
        • Narrative Design Keys
      • Adding NPC to NPC Conversation
      • Adding Scene Reference and Point-At Crosshairs
      • Utilities
        • Character Emotion
        • Player Data Container
        • Long Term Memory
        • Language Support
        • Managing sessionID Locally
        • Transcript UI System
        • Pre-built UI Prefabs
        • Input Management
        • Notification System
        • Settings Panel
        • Dynamic Information Context
      • Building For Supported Platforms
        • Building for iOS/iPadOS
        • Building for WebGL
        • Convai XR
          • Building for VR
            • VR Automatic Installation
            • VR Manual Installation
          • Building for MR
            • MR Automatic Installation
            • MR Manual Installation
          • Building for AR
          • Interacting with XR UI Elements
        • Building for macOS Universal apps
      • Changelogs
      • Tutorials
        • Narrative Design
        • NPC2NPC
    • Unreal Engine
      • Supported Platforms
      • Installation
      • Guides
        • Dynamic Environment Info
        • Change AI Character Movement Speed
        • Integration with Pixel Streaming
        • Adjust Interaction Radius
        • Creating MetaHuman Characters
          • Adding MetaHuman
          • Adding LipSync to MetaHuman (From plugin version 3.0.0 or later )
          • Change the Parent Class for MetaHuman
          • Change the parent class for Player.
          • Adding LipSync to MetaHuman (Deprecated)
        • Creating ReadyPlayerMe Characters
          • Download Plugins
          • Adding ReadyPlayerMe Character
          • Change the parent class for Player.
        • Creating Reallusion Characters
          • Creating a Reallusion Character
          • Importing Reallusion character and setting up the Convai plugin
          • Binding objects to Reallusion Character
        • Event-Aware Convai Characters
        • Operations Based on the Presence of Certain Words
        • Narrative Design
          • Narrative Design Trigger
          • Narrative Design Keys
        • Actions Guide
          • Stage 1: Default Actions
            • Moves To
            • Follows
          • Stage 2: Custom Actions
            • Simple actions
            • Adding Descriptions to Actions
          • Stage 3: Custom Actions with Single Parameter
          • Main Character and Attention Object
        • Customization
          • Push to Talk
          • Alter Character Response Audio Rate
        • Speech To Text Transcription
        • Enable Multiplayer Support
        • 3D Chat Widget
        • Long Term Memory
        • Saving and Loading Session
      • Blueprints Reference
        • Convai Player
        • Convai Chatbot
        • Convai Environment
        • Convai Object Entry
        • Convai Result Action
        • Convai Extra Params
        • Speech To Text
        • Text To Speech
        • Utility Functions
      • Troubleshoot Guide
        • Missing Unreal Engine Tool Set in Microsoft Visual Studio Toolchain
        • Convai Module Not Found
        • MetaHuman Plugin Conflict
        • Failure to Load Character IDs
      • Microphone Settings
        • Set Audio Gain
        • Set Microphone
        • Microphone test
        • List Microphone Devices
      • Mac Microphone Permission: Required for UE 5.0 and 5.3
      • Guides V2 (Under Development)
        • Getting Started
          • Installation
          • Simple Talking Cube
          • Adding Premade Chat and Settings UI
    • Web Plugin
      • PlayCanvas Plugin
        • Adding External Script
        • First Person View
        • Adding characters to scene
        • Character Animations
        • Convai Integration
        • Chat Overlay
      • Convai Web SDK
        • Getting Started
        • Facial Expressions
        • Actions
      • JavaScript Chat UI SDK
        • Getting Started
        • ChatBubble Props
      • Narrative Design Guide
        • Narrative Design Triggers
        • Narrative Design Keys
      • GLB Characters for Convai
      • GLB/FBX animations for Convai
    • Modding Framework
      • Modding Cyberpunk 2077
    • Other Integrations
      • Roblox
        • Sample Game 1
        • Sample Game 2
        • Code Example
          • Character Conversation API
      • Discord
        • Create a Discord Bot
        • Hosting Discord Bot from Personal Server
        • Hosting Discord Bot from Replit
      • Omniverse Extension
      • Third-Party API Integrations
        • ElevenLabs API Integration
  • Reference
    • Core API Reference
      • Character Base API
      • Interaction API
      • Core AI Setting API
      • Backstory API
      • Chat History API
      • Knowledge Bank API
      • Narrative Design API
      • Action API
      • Language List API
      • Voice List API
      • Character List API
      • Evaluation API
Powered by GitBook
On this page
  • Introduction
  • Prerequisites
  • Step-by-Step Guide
  • Step 1: Install Ready Player Me SDK in Unity
  • Step 2: Configure the RPM Avatar
  • Step 3: Import the RPM Character
  • Step 4: Integrate Convai Components
  • Conclusion

Was this helpful?

  1. Plugins & Integrations
  2. Unity Plugin

Importing Ready Player Me (RPM) Characters

This guide walks you through the process of importing Ready Player Me (RPM) characters into a Convai-powered Unity project, configuring them, and integrating Convai NPC components.

PreviousCreating a Convai Powered Scene from TemplateNextImporting Custom Characters

Last updated 1 month ago

Was this helpful?

Introduction

Ready Player Me (RPM) allows users to create and customize 3D avatars easily. By integrating RPM characters into Convai's Unity SDK, you can bring dynamic NPCs to life with advanced AI-driven interactions. This guide covers the step-by-step process to set up RPM characters in your Unity project with Convai.

Prerequisites

Before getting started, ensure you have the following:

  • A account

  • A model link for your RPM character

  • A Unity project with the Convai SDK installed and working

Step-by-Step Guide

Step 1: Install Ready Player Me SDK in Unity

  1. Open Unity and navigate to Window > Package Manager.

  1. Click the (+) icon and select Install Package from Git URL.

  1. Enter the following Git URL and click Install:

https://github.com/readyplayerme/rpm-unity-sdk-core.git#f6ea3c4b0a8891b7c4c1d7b269cee545185549fb

  1. Wait for the installation to complete.

Step 2: Configure the RPM Avatar

  1. In the Project Panel, navigate to: Assets > Ready Player Me > Resources > Settings

  1. Right-click inside the folder and go to Create > Ready Player Me > Avatar Configuration.

  1. This will generate an Avatar Config asset.

  2. Select the created asset and, under the Inspector Panel, locate the Morph Targets section.

  3. Click Add, select the required morph targets (Oculus Visemes and ARKit), and save the asset.

  1. Locate Assets > Ready Player Me > Resources > Settings > AvatarLoaderSettings and assign the Avatar Config asset to the Avatar Config field.

  1. Save the asset.

Step 3: Import the RPM Character

  1. Navigate to Tools > Ready Player Me > Avatar Loader.

  1. Paste or enter your RPM Model Link in the provided input field.

  1. Click Load Avatar into Current Scene to import your character.

Step 4: Integrate Convai Components

  1. Select your imported RPM GameObject in the Hierarchy Panel.

  2. Add the Convai NPC component to the GameObject.

  3. Fill in the name and ID of the Convai NPC you wish to integrate.

  1. Click Add Components inside the Convai NPC component.

  1. Choose the components you want and click Apply Changes.

  1. Attach a Capsule Collider to the GameObject and configure its size and center to align with the character's body proportions. Ensure that the collider accurately encapsulates the character for optimal physics interactions and collision detection.

  1. Assign an Animation Controller to the Animator component of the GameObject. The Convai SDK offers two predefined animation controllers (Feminine and Masculine) that you can use. Alternatively, you can integrate a custom controller tailored to your requirements.

Enhance your character with additional features:

Conclusion

Add LipSync: Follow to integrate LipSync into your character.

Implement Narrative Design: Check out to add Narrative Design.

Set up Actions: Explore action-based interactions using .

You have successfully integrated a Ready Player Me character into your Convai-powered Unity project. You can now leverage Convai’s capabilities to bring intelligent, interactive NPCs to life.

For more details about Ready Player Me, visit .

🎉
😎
this guide
this guide
this guide
Ready Player Me
Ready Player Me