Skip to content

Commit eac8181

Browse files
authored
Improve readme, aligned with other SDK agent starters (#365)
1 parent 62182c9 commit eac8181

1 file changed

Lines changed: 8 additions & 4 deletions

File tree

Samples~/Agents/README.md

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -12,13 +12,17 @@ Connect to a voice AI agent.
1212

1313
### Project setup
1414

15-
The sample can either be imported via the package manager to get access to the assets or opened as a full Unity project. The project is set up to build and run on all supported platforms.
15+
The sample can either be imported via the package manager to get access to the assets or opened as a full Unity project.
1616

17-
### Agent dispatch
17+
The app is configured to connect to the LiveKit homepage agent by default, which you can also try at [livekit.com](https://www.livekit.com). To point the app at your own agent, see [Connect to your agent](#connect-to-your-agent).
1818

19-
To talk to an agent, the app needs a token to connect to a LiveKit room and dispatch an agent. The project is already configured to automatically connect to the LiveKit homepage agent you can try at www.livekit.com.
19+
### Connect to your agent
2020

21-
To connect to your own LiveKit server, edit the token source component config with your projects token source.
21+
To switch from the default agent to your own, you first need a LiveKit agent to speak with. For a no-code setup, use the [Agent Builder](https://docs.livekit.io/agents/start/builder/). For more customization, try our starter agent for [Python](https://github.com/livekit-examples/agent-starter-python), [Node.js](https://github.com/livekit-examples/agent-starter-node), or [create your own from scratch](https://docs.livekit.io/agents/start/voice-ai/).
22+
23+
Second, you need a token server. For development, the easiest option is the sandbox token server: enable it from your project's Options on the Settings page in LiveKit Cloud and copy the sandboxId.
24+
25+
Then create a new TokenSoureComponentConfig asset for your sandbox and reference it in the scene on the `TokenSourceComponent` script instead of the `HomepageAgent.asset`:
2226

2327
### Common sample package
2428

0 commit comments

Comments
 (0)