For the complete documentation index, see llms.txt. This page is also available as Markdown.

Asset Uploader

Upload Metahumans, Reallusion characters, and scenes from Unreal Engine to Convai Sim and Avatar Studio using the Convai Asset Uploader tool.

The Convai Asset Uploader uploads Metahumans, Reallusion characters, and scenes from Unreal Engine directly to Avatar Studio and Convai Sim. The tool automates project creation, plugin integration, and asset packaging through a command-line interface. Use this page to install the tool, run it against an Unreal Engine 5.8 project, and upload your first asset.

Convai Asset Uploader tool walkthrough

Prerequisites

Before running the Asset Uploader, confirm the following:


Download and run the tool

1

Download the Asset Uploader

Download the latest AssetUploaderTool.exe from the Convai Asset Uploader GitHub Releases. Move the file to the directory where you want your new Unreal Engine project to be created — the tool creates and configures the Convai Unreal Engine project automatically.

2

Run the uploader tool

Double-click AssetUploaderTool.exe to run it. If Windows shows a "Windows protected your PC" screen, select More info > Run anyway. The tool is safe to run — the warning appears because the tool is currently in beta and not digitally signed.

3

Follow the prompts

The tool opens in a terminal window and walks through:

  1. Unreal Engine path detection — confirm a message such as Found Valid Unreal Engine Path: C:/Program Files/Epic Games/UE_5.8. Enter Y to confirm the path or N to provide a different path.

  2. Project configuration — enter the project name and your Convai API key.

  3. Asset type selection — press 1 to upload a scene or 2 to upload an avatar.

  4. Avatar type selection (avatars only) — respond to Are you using a Metahuman for your Avatar? with Y for a MetaHuman setup or N for a Reallusion setup.


Verify the upload

Once configuration is complete, the tool generates a new Unreal Engine project, installs and configures the Convai plugins, and begins compiling the project. The upload is complete once the terminal shows:

Press Enter to exit.

The new project is created in the same directory as AssetUploaderTool.exe. For example, if the tool is placed in Downloads, the project is generated inside Downloads.


Troubleshooting

.NET Runtime error appears when running the tool

Symptom: The tool reports a missing .NET Runtime error.

Cause: The .NET 6.0 Runtime for console applications is not installed.

Fix: Install the .NET 6.0 Runtime for console apps.

Verify: Rerun AssetUploaderTool.exe — the tool starts without the runtime error.


Project and plugin constraints

  • 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

Only MetaHuman and Reallusion avatars are supported for upload.

Metahuman AvatarsReallusion Avatars

Need help?

If you run into issues or have questions, reach out through the Convai Developer Forum.

Last updated

Was this helpful?