# Building for AR

## AR Installation

If you want to make your Convai Plugin compatible with AR, you can do so in two ways. Please see the instructions below or check out our [*latest tutorial video*](https://www.youtube.com/watch?v=j0l_paOQxvI) on YouTube.

{% embed url="<https://www.youtube.com/watch?v=j0l_paOQxvI>" %}

### Method 1 : Automatic Setup

{% hint style="success" %}
Recommended for new projects.
{% endhint %}

{% hint style="danger" %}
The following processes will be performed:

* Universal Render Pipeline (URP)
* ARCore Plugin
* Convai Custom AR Package
* Convai URP Converter

**If these packages are not present, they will be installed.**
{% endhint %}

{% hint style="danger" %}
**If the target build platform is not Android, it will be switched to&#x20;*****Android.***
{% endhint %}

{% hint style="warning" %}
Make sure to download the Android platform support from Unity Hub for your project's version.
{% endhint %}

1. Click on " *Convai / Convai Custom Package Installer / Install AR Package* "

<figure><img src="/files/N2LVjizUtVnoz2lekauf" alt=""><figcaption></figcaption></figure>

<figure><img src="/files/biZisVIU0gYjFSNVIx9h" alt=""><figcaption></figcaption></figure>

2. Confirm the changes and processes to be made. If you agree, the process will start. Click " **Yes, Proceed** " and the process will begin. You'll see logs in the console.

<figure><img src="/files/o1mP4ocfRITNE2tJSYbj" alt=""><figcaption></figcaption></figure>

3. If you encounter an error like "Failed to Resolve Packages," don't worry. The process will continue, and the error will be resolved automatically after the package installations are complete.

<figure><img src="/files/GEv05IsM3S4AMLcS9x9y" alt=""><figcaption></figcaption></figure>

4. Open the " *Convai / Scenes / Convai Demo - AR* " demo scene. If the TMP Importer window appears ( It will appear if TMP Essentials is not installed in your project ), click " **Import TMP Essentials** " to install TextMeshPro Essentials for UI text objects.

<figure><img src="/files/ArFhTnejdTTtnjx4teOr" alt=""><figcaption></figcaption></figure>

Alternatively, you can use the " *Window / TextMeshPro / Import TMP Essential Resources* " to install it.

<figure><img src="/files/JOvMpKQjM4y2AIVKfTmt" alt=""><figcaption></figcaption></figure>

5. After importing TMP Essentials, you can remove the empty GameObject in your scene that triggers the Prompt window to appear.

<figure><img src="/files/ZQKX5iSqSchTx7xptPxJ" alt=""><figcaption></figcaption></figure>

6. Build your project by going to " *File / Build Settings / Build* " Ensure that the " **Convai Demo - AR** " scene is included in the Scenes in Build section.

<figure><img src="/files/jrQpMsRwAlu1DScC18qZ" alt=""><figcaption></figcaption></figure>

{% hint style="warning" %}
Ensure you've set up your API Key. ( Convai / Convai Setup )
{% endhint %}

Now everything is ready for testing. 🙂✅

### Method 2 : Manual Setup

{% hint style="danger" %}
Ensure you have the following packages installed in your project:

* ARCore
* URP (Universal Render Pipeline) - Recommended for optimization, though not mandatory
  {% endhint %}

1. Double-click on " Convai / Convai Custom Unity Packages / ConvaiVRUpgrader.unitypackage "

<figure><img src="/files/gklrUGKv7Be1dDv7qIRD" alt=""><figcaption></figcaption></figure>

2. You'll see a warning that the settings will overwrite your project settings. You can either allow it by clicking " **Import** " or create a temporary project by clicking " **Switch Project** "

<figure><img src="/files/RrgjjIzv5irKsOhCGBU8" alt=""><figcaption></figcaption></figure>

3. In the Import Unity Package window, review the assets to be imported and click " **Next** "

<figure><img src="/files/PYSoy5l7nOSOBr56L9oE" alt=""><figcaption></figcaption></figure>

4. Select all settings to be changed in the Project Settings and complete the installation by clicking " **Import** "

<figure><img src="/files/TyVXY5snorZRgw4tnvVL" alt=""><figcaption></figcaption></figure>

5. Open the " *Convai / Scenes / Convai Demo - AR* " demo scene. If the TMP Importer window appears ( It will appear if TMP Essentials is not installed in your project ), click " **Import TMP Essentials** " to install TextMeshPro Essentials for UI text objects.

<figure><img src="/files/ArFhTnejdTTtnjx4teOr" alt=""><figcaption></figcaption></figure>

Alternatively, you can use the " *Window / TextMeshPro / Import TMP Essential Resources* " to install it.

<figure><img src="/files/JOvMpKQjM4y2AIVKfTmt" alt=""><figcaption></figcaption></figure>

6. After importing TMP Essentials, you can remove the empty GameObject in your scene that triggers the Prompt window to appear.

<figure><img src="/files/ZQKX5iSqSchTx7xptPxJ" alt=""><figcaption></figcaption></figure>

7. If you see 3D objects in pink, it's a shader issue. If you're using URP, convert the materials to URP by double-clicking on " *Convai / Convai Custom Unity Packages / ConvaiURPConverter* " and importing all assets in the window that appears.

<figure><img src="/files/U08PayD8bA6RelX358ND" alt=""><figcaption></figcaption></figure>

8. Ensure you've set up your API Key ( Convai / Convai Setup ).
9. Build your project by going to " *File / Build Settings / Build* " Ensure that the " **Convai Demo - AR** " scene is included in the Scenes in **Build** section.

<figure><img src="/files/jrQpMsRwAlu1DScC18qZ" alt=""><figcaption></figcaption></figure>

Now everything is ready for testing. 🙂✅

## How to Add and Adjust Size Of My Own Character?

If you've created a Ready Player Me character on convai.com playground and want to add it to your AR project, follow these steps:

1. Right-click on the " *Convai / ConvaiAR / Prefabs / Convai NPC AR Base Empty Character* " prefab.
2. Click on " *Create / Prefab Variant* "

<figure><img src="/files/3bbpLs5aGOwesIZSZnOM" alt=""><figcaption></figcaption></figure>

3. You'll see a prefab variant created for " **Convai NPC AR Base Empty Character** "
4. Double-click on this prefab variant.

<figure><img src="/files/tacSoDZKwchiZRWMzYKk" alt=""><figcaption></figcaption></figure>

5. In the Hierarchy section, add your imported character as a child to this prefab variant.

<figure><img src="/files/nlTkis9cNdfh8x3w18KK" alt=""><figcaption></figcaption></figure>

{% hint style="info" %}
Use the " [Importing Ready Player Me (RPM) Characters](/api-docs/plugins-and-integrations/unity-plugin/unity-importing-ready-player-me-rpm-characters.md) " guide to add your character to your project.
{% endhint %}

6. After adding your character, click on your character.
7. In the Inspector, adjust the Scale settings as needed. To prevent your character from moving with animation while talking, disable the " **Apply Root Motion** " option in the Animator.

<figure><img src="/files/WCBPRX5jgwjARImgKv3h" alt=""><figcaption></figcaption></figure>

8. After these steps, save your prefab variant by pressing **CTRL + S**.
9. Open the " *Convai / Scenes / Convai Demo - AR* " scene.
10. Click on the " **Convai AR Player** " object under " **ConvaiAR Base Scene** "

<figure><img src="/files/HsYuLYEUW2oDlzLgoPS3" alt=""><figcaption></figcaption></figure>

11. In the Inspector, under the " **Convai Character Spawner** " component, add your prefab variant to the **Character Prefab** field.

<figure><img src="/files/bsT4xAvGuUjd4sH1PUFO" alt=""><figcaption></figcaption></figure>

Now, everything is ready to test your character in the AR environment!🙂✅

{% hint style="success" %}
Creating this prefab variant is to prevent automatic scaling ( 1,1,1 ) of your prefab when instantiated in the AR environment.

To avoid issues with scale adjustments, we added our character as a child to an empty parent object. For convenience, we created an empty prefab variant.
{% endhint %}


---

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

```
GET https://docs.convai.com/api-docs/plugins-and-integrations/unity-plugin/building-for-supported-platforms/convai-xr/building-for-ar.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
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.