Voxta docs

Get Started

Download Voxta Minecraft Companion, point it at a Voxta Server and a Minecraft Java server, pick a character — your AI companion joins the world.

Requirements

  • Voxta Server running (with a character configured) — see Install Voxta.
  • A Minecraft Java Edition server (1.8 through 1.21+). Vanilla, Paper, Spigot, or your own.
  • Windows 10/11 for the desktop app (Mineflayer itself works elsewhere, but the packaged app is Windows-first).

The companion is a client of your Voxta Server — exactly like Voxy or the VAM plugin. You'll set up Voxta first, then this app connects to it.

Install

Grab the latest release

Download the installer (or portable ZIP) from the GitHub releases page.

Run the installer

Double-click the .exe. Default install location is fine.

Windows SmartScreen may flag the binary on first download because it's an independent build (not signed by a paid certificate). Click More info → Run anyway.

Launch Voxta Minecraft Companion

From the Start Menu or desktop shortcut.

For development or contributing.

Clone the repo

git clone https://github.com/voxta-ai/voxta-minecraft-companion.git
cd voxta-minecraft-companion

Install dependencies + run

npm install
npm run dev

Package locally (optional)

npm run dist

Builds a Windows NSIS installer + portable ZIP into release/.

Quick start

Start Voxta

Make sure your Voxta Server is running. Default URL: http://localhost:5384/.

Start a Minecraft server

Vanilla, Paper, Spigot, or any other Minecraft Java server. Note the host, port, and a free username slot for the bot.

Open the companion → 🔗 Connection panel

Two phases: Voxta first, then Minecraft.

Connect to Voxta

Enter your Voxta hub URL — usually http://localhost:5384/hub — and connect.

Configure Minecraft

Server host (e.g. localhost or your LAN IP), port (default 25565), and a username for the bot (e.g. Zara). Offline servers don't need anything else; online-mode servers need a Mojang/Microsoft account.

Pick a character

Choose which Voxta character drives the companion. Same character pool as the rest of Voxta — pick one you've already got configured.

Launch

The bot joins your world and starts conversing. Talk to it by voice (mic via Voxta's STT) or by text in the companion's chat pane.

What to configure

Settings panel

SectionWhat it controls
EventsWhich game events trigger an AI reply (damage, death, mobs nearby, …)
NotesWhich observations the AI receives silently as context (items, weather, time, …)
Voice ChancePer-category probability that an action result triggers a voiced response vs. a silent note
Bot BehaviorAuto-look at player, auto-defense, vision mode, action-inference timing

Action toggles

Enable or disable individual Minecraft actions (mc_craft, mc_build_shelter, mc_attack, etc.). Disabled actions don't get suggested by the AI.

Inspector drawer

F-key opens the inspector — real-time bot stats (health, hunger, current mode, current activity), audio playback state, recent IPC traffic. Useful for debugging.

Tips

  • One bot per Minecraft server account. If you want two AI companions at once, run two instances of the app with different usernames pointed at the same Voxta server (each with its own character).
  • Vision mode costs tokens. Eyes-mode screen capture sends an image with every relevant turn. Toggle off if you don't need it.
  • Build-mode safety. During construction the bot ignores most other actions — call mc_stop to abort.

Where to go next

The full feature catalog and roadmap live on the GitHub repo. Issues, PRs, and custom-blueprint contributions are welcome.

For Voxta-side configuration (LLM, voices, scripting), see Voxta Server — the companion is a client; everything else is Voxta's job.

On this page