Contents

Get started

Quickstart

Every setup needs an OpenAI-compatible LLM endpoint and a JEV gate endpoint. If the gate is down or slow, the bridge fails closed and stays silent.

Choose a setup path

  • Docker: self-hosting is in early access, see self-hosting.
  • From a clone: run the setup wizard, then start the bridge with its config.

Docker install

During early access we set up self-hosted installs by hand; see Install.

Clone and run setup

From a clone, run the setup wizard in the bridge directory. It asks for a platform, sign-in details, a voice, a trigger, and a reply language, then writes a config, persona file, and environment file.

cd packages/bridge
go run . -setup -config ./client/config.json
go run . -config ./client/config.json

Add the avatar to OBS

In OBS, add a Browser Source with http://localhost:8432/. For another machine, use an SSH tunnel or an HTTPS reverse proxy.

Use a persona file

Download a persona from the builder, place the JSON file in the bridge's personas/ directory, and select it with -persona <id> or pass its file path. The personas_dir setting is relative to the config file.