LogoLogo
PlaygroundVideosBlogPricingForum
  • 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
    • Convai Pixel Streaming Embed
      • Whitelisting & Publishing an Experience
      • React Typescript
      • ReactJS (JavaScript)
      • Vanilla JavaScript (ES Modules)
      • CDN (UMD Script)
      • On Premise Deployment
      • API Reference
  • User Generated Content (UGC)
    • Avatar Studio
      • Creating a Convai Character
      • Customizing Your Avatar
        • Configure Avatar
          • Uploading Avatars
            • Metahuman Avatars
            • Reallusion Avatars
        • Face Filter
        • Environment
        • Lighting Adjustments
        • Animation & Expression Settings
        • Interface Configuration
        • Experience Settings
        • Publishing an Experience
    • Convai Sim
      • Creating a Convai Character
      • Creating Your AI Simulation with Convai Sim
      • Avatar Customization
      • Tour Guide
      • Publishing an Experience
    • Modding Tool
  • 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
  • Getting Started
  • 1. Download & Launch
  • 2. Follow the Prompts
  • What Happens Next
  • Project Location
  • .NET Runtime Errors
  • Important Notes
  • Next Steps
  • Need Help?

Was this helpful?

  1. User Generated Content (UGC)

Modding Tool

Upload Metahumans, Reallusion characters, and Scenes from Unreal Engine to Convai Sim and Avatar Studio with ease.

PreviousPublishing an ExperienceNextCore API Reference

Last updated 1 month ago

Was this helpful?

Introduction

The Convai Modding Tool enables developers to upload their custom avatars and levels directly from Unreal Engine 5.3 to Avatar Studio and Convai Sim. It automates project creation, plugin integration, and asset packaging through a command-line interface, making the entire process simple and reliable.

Whether you're uploading a scene, a Metahuman, or a custom Reallusion character, this tool ensures your assets are packaged and transferred in a compatible and Convai-ready format.


Prerequisites

Before getting started, ensure you have the following:

  • Unreal Engine 5.3

  • Convai API Key – You can generate one from your

  • .NET 6.0 Runtime (Console Applications) –

  • Unreal Engine 5.3 Cross-Compile Toolchain -

  • Download Linux Binaries for Unreal Engine 5.3 - You can download it from Epic Games Launcher

Currently, only Unreal Engine 5.3 is supported. Support for other versions is in progress.


Getting Started

1. Download & Launch

  • Download ConvaiModdingToolfrom here.

  • Move the .exe file to the directory where you want your new Unreal project to be created.

  • Double-click to run it.

  • If you see a “Windows protected your PC” screen, click More Info > Run Anyway.

Don’t worry! The executable is safe to use. The warning appears because the tool is currently in beta and not digitally signed.


2. Follow the Prompts

The Modding Tool will open in a terminal window. You’ll go through the following steps:

  1. Unreal Engine Path Detection You'll see a message like: Found Valid Unreal Engine Path: C:/Program Files/Epic Games/UE_5.3

    • Confirm with Y if correct

    • Enter N to provide a different path manually

  2. Project Configuration

    • Enter the Project Name (this will be your new Unreal project)

    • Enter your Convai API Key from your Convai account

  3. Select Asset Type

    • Press 1 for uploading a Scene

    • Press 2 for uploading an Avatar

  4. Choose Avatar Type If you selected Avatar:

    • You’ll be asked: Are you using a Metahuman for your Avatar?

      • Press Y for Metahuman setup

      • Press N for Reallusion setup


What Happens Next

Once your configuration is complete, the tool will:

  • Generate a new Unreal Engine project

  • Automatically install and configure all necessary Convai Plugins

  • Begin compiling the project

When you see the message:

Unreal Compilation completed successfully

your setup is complete. Press Enter to exit.


Project Location

Your new project will be created in the same directory as the .exe.

Example: If the tool is placed in Downloads, your project will be generated inside Downloads.


.NET Runtime Errors

If you encounter an error related to the .NET Runtime:


Important Notes

  • Do not delete or rename the ConvaiEssentials folder.

  • Do not change global project settings outside the plugin folder.

  • Support for other Unreal Engine versions is in development.


Next Steps

Continue to one of the following guides:

Currently, only Metahuman and Reallusion avatars are supported for upload.


Need Help?

Install the .NET 6.0 Runtime for Console Apps from .

If you run into any issues or have questions, don’t hesitate to reach out via the .

Convai Dashboard
Download it here
Download it here
this link
Uploading Metahuman Avatars
Uploading Reallusion Avatars
Convai Developer Forum
10MB
ConvaiModdingTool.zip
archive