Unity Engine
- Download: Download the VoicePatrol Unity package from the Get Started page.
- Import the Unity Package: Right-click in your Unity assets folder, select Import Package > Custom Package... open the VoicePatrol Unity package file.
- Add to Unity Scene: Drag the VoicePatrol unity prefab into your start scene.
- Enter API Key: Copy your project API key from the Settings page and paste to the VoicePatrol unity prefab.
- Voice Engine Integration: Open the VoicePatrolUnityExample script and uncomment out applicable voice engine code.
Now VoicePatrol is active in your Unity project! See full details here.
Unreal Engine
- Download: Download the VoicePatrol Unreal plugin from the Get Started page.
- Extract: Extract the downloaded file to your plugins folder (if you don't have a plugins folder you can create one in your project root folder).
- Use Actor: Drag and drop the OpticoSDK blueprint actor located at /All/Plugins/Classes_VoicePatrolSDK/VoicePatrolSDK/Public into your starting scene.
- Configure Actor:
- Enter your API token from the dashboard
- Ensure muted is set to false (the SDK starts in the muted state by default)
- Set optional fields: specify your own Unique ID, additional logging, UI overlay widget
Note, an actor is not strictly required, the same can be achieved via Unreal C++ programming. Now VoicePatrol is active in your Unreal project! See full details here.
