Getting started
Your first server, one step at a time.
Build commands for your game and runtime →
Start with the Docker-manager route, then create, configure, launch, and check a server. Commands below are instructions; your terminal output confirms the result.
Choose an installation route
| Route | Best fit | What you need |
|---|---|---|
| Docker manager · recommended first run | Run AlphaGSM in a manager container and launch supported game containers through the host daemon. | Git, Docker with Compose, a non-root user with Docker access, and host Python 3 for wrapper metadata commands. |
| Host manager + Docker games | Keep AlphaGSM on your machine while launching supported games in containers. | Python and runtime packages, Docker access, and a module with Docker runtime hooks. |
| Host process runtime | Use direct process control when your module or environment calls for it. | Python and runtime packages, plus game-specific host dependencies such as a compatible Java runtime. |
| Standalone executable | Use a published OS/CPU executable with Python bundled when a release is available. | A matching release asset and the game's own runtime requirements. |
Quick start: Docker manager
-
Prepare a non-root workstation
Start with the documented Ubuntu 24.04 baseline. Make sure Docker is running, Compose is available, and your account can use the Docker daemon. The wrapper rejects root. It mounts the host Docker socket and launches sibling game containers, so use it on a host you administer.
docker version docker compose version python3 --version -
Get the source and start the manager
git clone https://github.com/SectorAlpha/AlphaGSM.git cd AlphaGSM ./alphagsm-docker startThe wrapper attempts to pull the manager image and can fall back to a local build. Initial setup may take time while images and game files download.
-
Create a Minecraft Vanilla server
./alphagsm-docker mymc create minecraft.vanilla ./alphagsm-docker mymc setupmymcis your server identifier;minecraft.vanillais its module. Follow the interactive setup prompts, review the game license, and choose a writable path under the wrapper state directory. The default wrapper state is$PWD/.alphagsm-docker; the manager and host daemon must see the server directory at the same absolute path. -
Check the runtime, launch, and verify
./alphagsm-docker mymc doctor ./alphagsm-docker mymc start ./alphagsm-docker mymc status ./alphagsm-docker mymc query ./alphagsm-docker mymc infoCheck the actual output. A running process and a ready, reachable game server are separate checks. Review logs if readiness fails.
-
Inspect or stop it
./alphagsm-docker mymc logs ./alphagsm-docker mymc connect ./alphagsm-docker mymc stop
Read the full Docker-manager guide for custom state paths, image behaviour, ownership checks, and Compose details.
Install from source on the host
git clone https://github.com/SectorAlpha/AlphaGSM.git
cd AlphaGSM
python3 -m venv .venv
. .venv/bin/activate
python -m pip install -r requirements-runtime.txt
cp alphagsm.conf-template alphagsm.conf
./alphagsm --helpKeep the virtual environment active when using this source checkout. Install the game-specific host dependencies described in its guide. Java requirements depend on the Minecraft version; Steam-based games and other native servers may need additional packages. The developer requirements file adds development/testing tools.
To keep the manager on the host and select Docker game runtimes, configure:
[runtime]
backend = dockerThen follow the host-with-Docker guide. Use ./alphagsm mymc doctor to see the effective runtime. Direct process control is the fallback when a module lacks a suitable Docker path or you explicitly choose it.
Standalone executables and releases
The download page lists the five standalone builds and the checksum and signature checks. Reviewed on 30 October 2026, the public GitHub Releases page had no tags and no downloadable assets. Use the source or Docker route above until a release file is published.
When an executable and its .sha256 file are published for your OS and CPU, follow the download page and the standalone guide. Bundled Python does not remove the game's Java, SteamCMD, Docker, account, or owned-file prerequisites.
Before players connect
- Check your module's support status and game guide.
- Review the actual port/protocol settings and your host firewall; do not assume every game uses the same ports.
- Use
status,query, and logs to confirm readiness. - For modules with backup support, establish a backup routine and test recovery on disposable data.
- Continue with the operations guide for settings, maintenance, and troubleshooting.