Voxta docs

Install the Voxta plugin

Drop the .var into VAM, allow what's needed in security, connect to your Voxta server, done.

The Voxta plugin is plug-and-play. Five minutes from zero to talking character.

Prerequisites

  • A Voxta Server that's running and that you can already chat with via Voxta Talk.
  • Virt-A-Mate installed (any recent build).
  • The plugin .var file (AcidBubbles.Voxta.VERSION.var) — currently distributed through Voxta's Patreon and the Discord build channel.

Install

Drop the .var into AddonPackages

Copy AcidBubbles.Voxta.VERSION.var into the AddonPackages folder at the root of your Virt-A-Mate install.

Allow speech playback from your Voxta server

Voxta streams audio from your server (default 127.0.0.1:5384). VAM blocks audio loads from arbitrary hosts by default, so you need to whitelist Voxta.

Before launching VAM, open whitelist_domains.json at the root of your VAM folder and add the Voxta host:

{
  "sites": [
    "127.0.0.1:5384"
    // leave any existing entries below this line as-is
  ]
}

If you've changed Voxta Server's port, or you're running it on another machine, use that host instead. Format is host:port, no protocol.

Set VAM security permissions

Launch VAM, open the main menu, go to User Preferences → Security. Turn these on:

  • Enable Plugins (required — this is how Voxta runs at all)
    • Allow Plugins Network Access (required — the plugin talks SignalR to your server)
  • Enable Web Images and Audio (required — speech playback)
  • Enable Package Downloader (optional — needed if you'll use demo scene dependencies)
  • Enable Hub (optional — auto-downloads scene dependencies from VaM Hub)

Add the plugin to a Person atom

For a brand-new scene you build yourself:

  1. Open or load a scene with a Person atom.
  2. Open the menu (U), turn on Edit Mode (E), select the Person (N).
  3. Go to PluginsAdd Plugin.
  4. Browse to AcidBubbles.Voxta.VERSION and select Voxta.cslist.

For a downloaded Voxta-ready scene, the plugin is already wired — just open the scene.

Open the plugin Custom UI and verify it's connected

In the Plugins tab on the Person atom, find the Voxta plugin and click Open Custom UI.

The plugin opens to its tabbed interface. The Connection tab shows:

  • Host — the Voxta server address (defaults to your local server)
  • API Key — only needed if your server has authentication enabled
  • Connection Status — should read Connected

Status text turns red on a connection problem. Common causes: server not running, wrong host, wrong port, missing API key, or the whitelist_domains.json step was skipped.

Pick a character

In the plugin's Chat tab, select a character. The plugin's State storable flips from disconnected to idle when ready. You can now type or speak to the character.

What's next

On this page