Basic Setup
Import Virbe Core plugin
Virbe Unity plugin supports Unity 2020 and newer.
Import Virbe Core Plugin [download here] into your project. Make sure your project Unity version is at least 2020. If your Unity engine is older, try to reimport it into a new version (at least Unity 2020).
1. Import your model
Currently, our Unity SDK has the necessary animation controllers, including LipSync for general Humanoid-type models created with:
Ready Player Me (check out the import tutorial)
Character Creator 3 (coming soon)
Daz3D (coming soon)
Your model might have a very specific geometry, which might not look perfect using default controllers. In these situations, you might need to prepare the complete animation pack yourself. Use the provided animations as the reference.
2. Add and configure VirbeBeing prefab to the scene
After a successful import place VirbeBeing<model_type> prefab inside your scene hierarchy. It is already preconfigured with necessary dependencies to allow for quick setup, but feel free to tweak and customize it however you want. In the component, you will need to provide a being configuration file.
You can download it from your Virtual Being dashboard under Deployment Being - Unity.
Once you do, import it into your Unity project and reference it in the component.
3. Add references to audio source & animator
Your model has to be rigged and you should connect it to an appropriate Animation Controller (for quick setup, use one of the predefined ones).
You need also to add an Audio Source, preferably, to the jaw bone of your rig, so it will follow your character and generate a natural conversational User Experience.
Once you have it properly configured, reference both things in the Virbe Action Player component.
4. Add UI Layout prefab and connect Being Action events
First, make sure you have added Event System to the scene.
Drag and drop one of the predefined Layout prefabs: Horizontal Layout (if you expect to use your screen in horizontal mode) or Vertical Layout (if you predict to use it in vertical eg. mobile, kiosks).
Reference your VirbeBeing<model_type> in a selected layout in theVirbe Plugin UI Connector component:
and lastly, subscribe your Layout to Virbe Being Action events:
First check-up - Demo time
Provided you have a valid subscription plan in Virbe Hub, with these 4 steps you will make your virtual being respond to users, and they should be able to interact with text input and/or quick reply buttons.
This is the end of the integration tutorial if you are using Presentation Mode subscription.
5. Use your voice to converse with a virtual being (not available in Presentation Mode)
This feature is not available in Presentation Mode. You need to have an Interactive plan, which has built-in support for Speech Recognition (STT).
Drag and drop Virbe VoiceRecorder prefab to the scene. Also, make sure your device has at least 1 microphone available.
Reference your VirbeBeing component in VoiceRecorder
Lastly, add a reference to VoiceRecorder in the previously selected layout.
Demo time
Once you have all the things in place, save the scene and hit the Play button. You should be able to use your voice to speak to your voice.
What's next?
With Unity, you can deploy your application to the following devices:
Mobile (including Mobile AR with ARKit, ARCore)
Desktop (including Digital Signage)
VR (Oculus Quest, Rift, HTC Vive etc.)
AR (Hololens, Magic Leap)
Once you build your customer interface with Virbe SDK, do not hesitate to let us know at hello@virbe.ai to get featured on our website.
Troubleshooting
If you complete all of the steps from this tutorial and your Virtual Being is not responding make sure to check the following resources:
Last updated
