This guide is for running a normal vanilla Minecraft server with AlphaGSM.
minecraft.vanilla 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 Java-backed lifecycle
stays aligned across both backends while local runs remain process-backed by
default unless you opt into the Docker backend.
What You Need
- Java 21 or another compatible Java runtime
screen
- the Python packages in
requirements.txt
Quick Start
Create the server:
alphagsm mymc create minecraft.vanilla
Run setup:
alphagsm mymc setup
Start it:
alphagsm mymc start
Check it:
alphagsm mymc status
Stop it:
alphagsm mymc stop
What Setup May Ask For
- the Minecraft version
- a download URL
- the port
- where to install the server
- where Java is installed
Setup downloads the jar and writes the managed server.properties plus
eula.txt when the EULA is accepted, without launching a temporary Java
server. The first JVM is started by alphagsm <name> start, so setup cannot
leave the game port occupied.
Resetting the World
Stop the server, then run alphagsm mymc reset-world (or wipe). AlphaGSM
lists the world data to delete and asks for confirmation. Add -Y to skip the
prompt. Run start afterwards to generate a fresh world.
See world creation and reset for exactly which files
are removed and the supported layouts.
Useful Commands
alphagsm mymc message "hello world"
alphagsm mymc backup
Best Working Example
The best full example in the repository is:
tests/smoke_tests/run_minecraft_vanilla.sh
It uses this command flow:
alphagsm itmc create minecraft.vanilla
alphagsm itmc set javapath /path/to/java-wrapper.sh
alphagsm itmc setup -n -l PORT /tmp/minecraft-server -u SERVER_URL
alphagsm itmc start
alphagsm itmc status
alphagsm itmc message "hello world"
alphagsm itmc stop
alphagsm itmc status
Notes
minecraft is the short name people usually type.
minecraft.vanilla is the full module name.
- If you want the most realistic example, follow the smoke test.
Server variables
After create minecraft.vanilla, inspect or change these with set:
alphagsm myserver set --list
alphagsm myserver set KEY --describe
alphagsm myserver set KEY VALUE
| Key |
Aliases |
Type |
What it does |
difficulty |
— |
string |
The world difficulty. Example: easy. |
gamemode |
— |
string |
The default game mode. Example: survival. |
map |
gamemap, level, world, startmap, worldname |
string |
The selected world or level name. Example: world. |
maxplayers |
users |
integer |
The maximum number of players allowed on the server. Example: 20. |
port |
gameport |
integer |
The port the server listens on. Example: 25565. |
servername |
hostname, name |
string |
The server name shown in the client list. Example: AlphaGSM Server. |
Developer Notes
Run File
- Executable:
minecraft_server.jar
- Location:
<install_dir>/minecraft_server.jar
- Engine: Java (Mojang)
Server Configuration
- Config file:
server.properties
- Key settings (in
server.properties):
server-port — Game port (default 25565)
motd — Message of the day
max-players — Maximum players
level-seed — World generation seed
online-mode — Mojang authentication
- Template: See server-templates/minecraft-vanilla/ if available
Maps and Mods
- Map directory:
world/
- Mod directory:
Not supported (vanilla)
- Workshop support: No
- Map notes: The world directory contains all world data. Delete it to regenerate.
- Mod notes: Vanilla servers do not support mods. Use Paper or Forge for mod support.