Documentation
Search
K

Building for VR

VR Installation

If you want to make your Convai Plugin compatible with VR, you can do so using the automatic or manual process. Please see the instructions below or check out our latest tutorial video on YouTube.
Unleash the Power of Convai AI NPCs in Your Unity VR Game

Method 1 : Automatic Setup

Recommended for new projects.
The following processes will be performed:
  • Universal Render Pipeline (URP)
  • OpenXR Plugin
  • XR Interaction Toolkit
  • Convai Custom VR 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.
  1. 1.
    Click on " Convai / Convai Custom Package Installer / Install VR Package "
  1. 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.
  1. 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.
  1. 4.
    Open the " Convai / Scenes / Convai Demo - VR " demo scene. If the TMP Importer window appears, click " Import TMP Essentials " to install TextMeshPro for UI text objects.
Alternatively, you can use the " Window / TextMeshPro / Import TMP Essential Resources " to install it.
  1. 5.
    Build your project by going to " File /Build Settings / Build " Ensure that the " Convai Demo - VR " scene is included in the Scenes in Build section.
Now everything is ready for testing. 🙂✅
Ensure you've set up your API Key. ( Convai / Convai Setup )

Method 2 : Manual Setup

Ensure you have the following packages installed in your project:
  • OpenXR or Oculus XR
  • XR Interaction Toolkit
  • URP (Universal Render Pipeline)
  1. 1.
    Double-click on " Convai / Convai Custom Unity Packages / ConvaiVRUpgrader.unitypackage "
  1. 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 "
  1. 3.
    In the Import Unity Package window, review the assets to be imported and click " Next "
  1. 4.
    In this window, select the project settings you want to import and complete the installation by clicking " Import ".
  1. 5.
    Open the " Convai / Scenes/ Convai Demo - VR " demo scene. If the TMP Importer window appears, click " Import TMP Essentials " to install TextMeshPro for UI text objects.
  1. 6.
    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.
  1. 7.
    Build your project by going to " File / Build Settings / Build " Ensure that the " Convai Demo - VR " scene is included in the Scenes in Build section.
Now everything is ready for testing. 🙂✅
Ensure you've set up your API Key (Convai/Convai Setup).