This guide covers the ts3server module in AlphaGSM.
ts3server is currently PASSED on the documented Ubuntu 24.04 Linux baseline. The current GitHub integration lane still exercises both process and Docker runtime selection, and the validated Linux lifecycle stays aligned across both backends while local runs remain process-backed by default unless you opt into the Docker backend.
Requirements
screen
- Python packages from
requirements.txt
Quick Start
Create the server:
alphagsm myts3serve create ts3server
Run setup:
alphagsm myts3serve setup
Start it:
alphagsm myts3serve start
Check it:
alphagsm myts3serve status
Stop it:
alphagsm myts3serve stop
Setup Details
Setup configures:
- the game port (default 10011)
- the install directory
Useful Commands
alphagsm myts3serve update
alphagsm myts3serve backup
Notes
- Module name:
ts3server
- Default port: 10011
Server variables
After create ts3server, inspect or change these with set:
alphagsm myserver set --list
alphagsm myserver set KEY --describe
alphagsm myserver set KEY VALUE
This module does not declare schema-backed keys. set --list after
create is still the live source of truth.
Developer Notes
Run File
- Executable:
ts3server
- Location:
<install_dir>/ts3server
- Engine: Custom
Smoke and integration validation require an authenticated ServerQuery response:
alphagsm info --json must report protocol ts3.
AlphaGSM reads first-start ServerQuery credentials from the selected runtime's
logs, including Docker, without displaying them. Recovered credentials are saved
in serverquery_admin_password.txt under the install directory with access
restricted to its owner, so replacing the container retains query access. Keep
this file with the server database when moving an installation.
Queries pace their commands to respect TeamSpeak's default flood limit. A health
check takes about two seconds, allowing consecutive query and info calls
from Docker without requiring an exemption from flood protection. Concurrent
query clients or stricter custom limits still need coordinated polling.
Server Configuration
Maps and Mods
- Map directory: Check game documentation
- Mod directory: Check game documentation
- Workshop support: No