Quick Start

This guide is the fastest way to get a working VoiceCraft stack.

Choose your topology first

VoiceCraft can be deployed in several ways:

  • Bedrock Dedicated Server: VoiceCraft.Server + VoiceCraft.Addon.Core.McHttp
  • Local Bedrock world / singleplayer: VoiceCraft.Server or local runtime + Core.McWss
  • Java server with Geyser/Floodgate: GeyserVoice + VoiceCraft.Server
  • Direct Paper server: GeyserVoice can also download and run the VoiceCraft runtime under the hood

If you are unsure, start with one of these:

1. Download the server

  1. Open the download page.
  2. Download the server archive for your platform:
    • VoiceCraft.Server.Windows.x64.zip
    • VoiceCraft.Server.Windows.x86.zip
    • VoiceCraft.Server.Windows.arm64.zip
    • VoiceCraft.Server.Linux.x64.zip
    • VoiceCraft.Server.Linux.arm.zip
    • VoiceCraft.Server.Linux.arm64.zip

If you are building from source, see VoiceCraft repository and build.

2. Run the server once

Windows

./VoiceCraft.Server.exe

Linux

chmod +x ./VoiceCraft.Server
./VoiceCraft.Server

After first launch, VoiceCraft generates config/ServerProperties.json.

3. Secure the generated config

Before connecting Minecraft or players, change every generated shared token:

  • McHttpConfig.LoginToken
  • McWssConfig.LoginToken
  • McTcpConfig.LoginToken

You usually want different values per environment.

4. Pick the Minecraft transport

VoiceCraft currently has 3 Minecraft-facing transports:

  • McHttp: Best for Bedrock Dedicated Server and most stable Bedrock automation.
  • McWss: Best for local worlds, testing, and command-tunnel scenarios.
  • McTcp: Best for Java-side bridges such as GeyserVoice.

See Transport Modes for the full comparison.

5. Download the client

From the download page, download the package for your players:

  • Windows: VoiceCraft.Client.Windows.<arch>.zip
  • Linux: VoiceCraft.Client.Linux.<arch>.zip
  • macOS: VoiceCraft.Client.MacOS.<arch>.dmg or .pkg
  • Android: VoiceCraft.Client.Android.arm64.zip (APK inside)
  • iOS: VoiceCraft.Client.iOS.arm64.ipa

6. Add the server in the client

  1. Open the client.
  2. Add a server entry in the UI.
  3. Use the VoiceCraft UDP endpoint from VoiceCraftConfig.Port.

Typical local setup:

  • host: 127.0.0.1
  • port: 9050

7. Connect the Minecraft side

If you are deploying on Bedrock, keep these two pages nearby:

8. Verify the stack

If everything is configured correctly:

  • VoiceCraft server starts without config or port errors
  • client connects without transport errors
  • Minecraft integration authenticates with the expected token
  • entity creation and bind flow work
  • players hear proximity voice when they are in range