> For the complete documentation index, see [llms.txt](https://docs.convai.com/api-docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.convai.com/api-docs/plugins-and-integrations/asset-uploader.md).

# Asset Uploader

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 <code class="expression">space.vars.asset\_uploader\_unreal\_version</code> project, and upload your first asset.

{% hint style="danger" %}
The Asset Uploader is available only on the Professional Plan and above.
{% endhint %}

{% embed url="<https://youtu.be/eFK9RFHDdco>" %}
Convai Asset Uploader tool walkthrough
{% endembed %}

***

### Prerequisites

Before running the Asset Uploader, confirm the following:

* Unreal Engine <code class="expression">space.vars.asset\_uploader\_unreal\_version</code>
* A Convai API key from the [Convai Dashboard](https://convai.com/)
* .NET 6.0 Runtime (Console Applications) — [download the .NET 6.0 console runtime](https://dotnet.microsoft.com/en-us/download/dotnet/6.0/runtime?cid=getdotnetcore\&os=windows\&arch=x64)
* The Unreal Engine <code class="expression">space.vars.asset\_uploader\_unreal\_version</code> [cross-compile toolchain requirements](https://dev.epicgames.com/documentation/en-us/unreal-engine/linux-development-requirements-for-unreal-engine?application_version=5.8), including the [toolchain version history](https://dev.epicgames.com/documentation/en-us/unreal-engine/linux-development-requirements-for-unreal-engine#version-history)
* The Linux binaries for Unreal Engine <code class="expression">space.vars.asset\_uploader\_unreal\_version</code>, available from the Epic Games Launcher

***

### Download and run the tool

{% stepper %}
{% step %}

#### Download the Asset Uploader

Download the latest `AssetUploaderTool.exe` from the [Convai Asset Uploader GitHub Releases](https://github.com/Conv-AI/Convai-UnrealEngine-ModdingTool/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.
{% endstep %}

{% step %}

#### 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.
{% endstep %}

{% step %}

#### 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.
   {% endstep %}
   {% endstepper %}

***

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

```
Unreal Compilation completed successfully
```

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](https://dotnet.microsoft.com/en-us/download/dotnet/6.0/runtime?cid=getdotnetcore\&os=windows\&arch=x64).

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

{% content-ref url="/pages/7RiOQDqXiSshcIxvesJU" %}
[Metahuman Avatars](/api-docs/no-code-experiences/avatar-studio-experiences/customizing-your-avatar/configure-avatar/uploading-avatars/metahuman-avatars.md)
{% endcontent-ref %}

{% content-ref url="/pages/KaEFOuvtwU0O5irCjn9v" %}
[Reallusion Avatars](/api-docs/no-code-experiences/avatar-studio-experiences/customizing-your-avatar/configure-avatar/uploading-avatars/reallusion-avatars.md)
{% endcontent-ref %}

***

### Need help?

If you run into issues or have questions, reach out through the [Convai Developer Forum](https://forum.convai.com/).


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.convai.com/api-docs/plugins-and-integrations/asset-uploader.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
