Asset Uploader

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

Introduction

The Convai Asset Uploader enables developers to upload their custom avatars and levels directly from Unreal Engine 5.5 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.5

• Convai API Key – You can generate one from your Convai Dashboard

• .NET 6.0 Runtime (Console Applications) – Download it here

• Unreal Engine 5.5 Cross-Compile Toolchain - Download it here

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

Linux Binaries for Unreal Engine 5.5

---

Getting Started

Step 1: Download the Asset Uploader

Download the latest version of AssetUploaderTool.exe from our GitHub Releases.

Asset Uploader Tool will create and configure your Convai Unreal project automatically.

---

Step 2: Update BuildConfiguration.xml

Before running the tool, you must update your Unreal Engine Build Configuration settings.

1. Navigate to the following path:

   <USER>/AppData/Roaming/Unreal Engine/UnrealBuildTool/BuildConfiguration.xml

2. Open the file in a text editor (e.g., Notepad).

3. Add the following block inside the <Configuration> tag:

   <BuildConfiguration>
       <bAllowUBALocalExecutor>false</bAllowUBALocalExecutor>
   </BuildConfiguration>

After editing, it should look like:

<?xml version="1.0" encoding="utf-8"?>
<Configuration xmlns="https://www.unrealengine.com/BuildConfiguration">
    <BuildConfiguration>
        <bAllowUBALocalExecutor>false</bAllowUBALocalExecutor>
    </BuildConfiguration>
</Configuration>

This change is required to avoid errors during project compilation caused by Unreal’s parallel executor on some systems.

---

Step 3: Run the Uploader Tool

Once dump_syms.exe has been replaced:

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

2. Double-click to run the .exe.

3. 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.

---

Step 4: Follow the Prompts

The Asset Uploader 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.5

   • 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:

• Install the .NET 6.0 Runtime for Console Apps from this link.

---

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:

• Uploading Metahuman Avatars

• Uploading Reallusion Avatars

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

---

Need Help?

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