Building for AR
Building for AR - Unity Plugin Guide for AR development with Convai.
Last updated
Building for AR - Unity Plugin Guide for AR development with Convai.
Last updated
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 on YouTube.
Recommended for new projects.
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.
If the target build platform is not Android, it will be switched to Android.
Make sure to download the Android platform support from Unity Hub for your project's version.
Click on " Convai / Convai Custom Package Installer / Install AR Package "
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.
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.
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.
Alternatively, you can use the " Window / TextMeshPro / Import TMP Essential Resources " to install it.
After importing TMP Essentials, you can remove the empty GameObject in your scene that triggers the Prompt window to appear.
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.
Ensure you've set up your API Key. ( Convai / Convai Setup )
Now everything is ready for testing. 🙂✅
Ensure you have the following packages installed in your project:
ARCore
URP (Universal Render Pipeline) - Recommended for optimization, though not mandatory
Double-click on " Convai / Convai Custom Unity Packages / ConvaiVRUpgrader.unitypackage "
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 "
In the Import Unity Package window, review the assets to be imported and click " Next "
Select all settings to be changed in the Project Settings and complete the installation by clicking " Import "
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.
Alternatively, you can use the " Window / TextMeshPro / Import TMP Essential Resources " to install it.
After importing TMP Essentials, you can remove the empty GameObject in your scene that triggers the Prompt window to appear.
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.
Ensure you've set up your API Key ( Convai / Convai Setup ).
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.
Now everything is ready for testing. 🙂✅
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:
Right-click on the " Convai / ConvaiAR / Prefabs / Convai NPC AR Base Empty Character " prefab.
Click on " Create / Prefab Variant "
You'll see a prefab variant created for " Convai NPC AR Base Empty Character "
Double-click on this prefab variant.
In the Hierarchy section, add your imported character as a child to this prefab variant.
Use the " Importing RPM Characters " guide to add your character to your project.
After adding your character, click on your character.
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.
After these steps, save your prefab variant by pressing CTRL + S.
Open the " Convai / Scenes / Convai Demo - AR " scene.
Click on the " Convai AR Player " object under " ConvaiAR Base Scene "
In the Inspector, under the " Convai Character Spawner " component, add your prefab variant to the Character Prefab field.
Now, everything is ready to test your character in the AR environment!🙂✅
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.