Run a separate voice server
Voice runs inside the game server by default. Use mode = "external" to run
it as a separate process, on the same machine or another host. Channels,
membership and permissions remain controlled by your game server scripts.
1. Prepare the voice package
Section titled “1. Prepare the voice package”Download the voice package through your developer access. Use the same release as the game server:
| Platform | Archive |
|---|---|
| Windows x64 | revo-voice-<version>-release-win64.zip |
| Linux x64 | revo-voice-<version>-release-linux.zip |
Extract it into a folder of your choice, keeping the bundled lib directory
beside the executable. The server runtime requirements
also apply to the voice process.
Run the following commands from the extracted folder.
2. Generate a shared key
Section titled “2. Generate a shared key”On Windows:
.\revo-voice.exe --generate-secretOn Linux:
./revo-voice --generate-secretThe command prints a 64-character hexadecimal key. Use it as secret in both
configurations below, replacing GENERATED_SECRET. Generate it once and keep
it across restarts. This key authenticates the game server’s control connection.
Keep it in the private server configurations.
3. Configure both processes
Section titled “3. Configure both processes”In the voice server folder, set config.toml to:
port = 27016media_port = 27017secret = "GENERATED_SECRET"These are top-level settings in the voice server’s own file.
In the game server’s config.toml, replace its [voice] section with:
[voice]enabled = truemode = "external"host = "127.0.0.1"port = 27016media_port = 27017public_host = ""secret = "GENERATED_SECRET"This example runs both processes on one machine. host and port select the
control endpoint used by the game server. Players connect to media_port.
An empty public_host uses the game connection’s host for voice.
For voice on another machine, change the game server’s settings:
- Set
hostto an address the game server can reach, such as the voice machine’s private IP. - Set
public_hostto the hostname or IP players can reach, such asvoice.example.com. Enter only the host, without a URL scheme or port.
Keep port, media_port and secret matched between the two files. The control
and media ports must differ. Allow UDP 27017 from players and restrict UDP
27016 to the game server. The networking guide
covers firewall and NAT configuration.
4. Start and verify
Section titled “4. Start and verify”If the game server is still running with embedded voice, stop it first to release the voice media port. Start the voice process with the new configuration.
On Windows:
.\revo-voice.exe config.tomlOn Linux:
./revo-voice config.tomlThe configuration path is optional and defaults to config.toml in the working
directory. You can pass a different file path as the first argument.
Start the game server with its updated [voice] settings. The voice console
should show:
Voice media listening on UDP port 27017Voice server control listening on UDP port 27016Game server authenticated. Waiting for routing stateRouting state readyThe game server logs Voice server authenticated. Publishing channel state.
Clients receive their voice connection details automatically.
Connect two players and use Your first voice channel
to check membership, voice.connected and speech in both directions.
Restarts and multiple instances
Section titled “Restarts and multiple instances”Press Ctrl+C in the voice terminal to stop it. Voice becomes unavailable while the process is stopped. The game server retries its control connection and sends the current channel state after reconnection. Clients reconnect to the voice endpoint automatically.
After changing the voice address, ports or shared key, restart both processes with matching configuration.
Each voice process accepts one game server at a time. For several game servers, run a voice process for each. Use separate working directories, configuration files and keys, plus distinct ports when sharing a machine.
Common problems
Section titled “Common problems”| Symptom | Check |
|---|---|
Could not read voice configuration |
Check the selected file, TOML syntax and generated 64-character key. The control and media ports must differ. |
Could not start voice media listener |
Check whether embedded voice or another process already uses media_port. |
The game server repeatedly logs Voice control connection lost |
Check the control host and UDP port, matching keys and whether another game server is already connected to this voice process. |
Control authentication succeeds, but voice.connected stays false |
Check the public voice host, UDP media port and matching media_port values on both servers. |
| Players connect to voice but cannot hear each other | Check channel membership, permissions and microphone settings using the voice channel guide. |