Unity
Getting started
From an empty scene to a conversation in Play mode. You need Unity 6000.0 or later and a PERSONAIZER account with at least one persona.
1. Install the package
- Open PERSONAIZER on the Unity Asset Store and press Add to My Assets.
- In Unity, open Window → Package Manager, choose My Assets, select PERSONAIZER and press Install.
Screenshot: Package Manager with PERSONAIZER installed screenshots/install-package-manager.png
You should now see PERSONAIZER 0.1.0 under In Project in the Package Manager, and a PERSONAIZER entry in Edit → Project Settings.
2. Connect your account
- In the dashboard, open Profile → API access and copy your account API key (
ak_…). - In Unity, open Edit → Project Settings → PERSONAIZER. Leave Mode on API Key.
- Paste the key and press Connect.
Screenshot: Project Settings → PERSONAIZER after Connect screenshots/connect-project-settings.png
You should now see a green Connected chip next to the key, and your plan under Usage.
The key is saved in Assets/Settings/PERSONAIZER.asset, which is created for you. In API Key mode the key ships inside your build; Authentication explains that choice and the alternative.
3. Add a Persona Character
- Select the GameObject that should talk: a character model, or an empty GameObject for now.
- In the Inspector, press Add Component → PERSONAIZER → Persona Character.
- In the dashboard, open your persona's API tab and copy its Persona ID.
- Paste it into the component's Persona ID field.
Screenshot: Persona Character component with a Persona ID screenshots/persona-character-inspector.png
You should now see the Persona ID in the field, with no warning under it, and Setup Health in Project Settings → PERSONAIZER showing every check green.
4. Press Play
Press Play. With Connect On Start ticked (the default), the Persona Character connects as the scene starts.
Screenshot: Persona Character inspector showing Connected in Play mode screenshots/play-connected.png
You should now see State under Runtime in the component's Inspector change from Connecting to Connected, with no PERSONAIZER errors in the Console. If a [PERSONAIZER] message appears instead, look it up in Troubleshooting.
Next steps
- Authentication: keep your API key out of the build with Server Token mode.
- Characters & events: show the streamed transcript as subtitles, and react to connection changes.
- Tool calls: let the persona open doors, check inventory, or anything else your game can do.