@keeb/minecraft

Swamp extension for Minecraft server control, installation, and metrics collection.

Models

minecraft/server

Control a Minecraft server running in a tmux session over SSH.

Method	Description
warnShutdown	Send in-game countdown warnings before shutdown
startMinecraftServer	Start the server in a tmux session and wait for readiness
stopMinecraftServer	Gracefully stop the server
status	Query player count and server status
say	Send an in-game chat message
op	Grant operator privileges to a player
deop	Revoke operator privileges from a player
collectMetrics	Collect player count and write Prometheus textfile metrics

minecraft/installer

Install a Minecraft server from a modpack zip on a remote host.

Method	Description
installDeps	Install Java and dependencies
upload	Upload server pack zip to the VM
extract	Extract and configure the server pack
configure	Set EULA, JVM flags, and server properties

Workflows

Workflow	Description
start-minecraft	Start a Minecraft VM + server
stop-minecraft	Stop a Minecraft server + VM
reboot-minecraft	Stop + start a Minecraft server
status-minecraft	Query Minecraft player count
minecraft-install	Install a Minecraft server pack on a VM
collect-game-metrics	Collect player metrics from all game servers

Dependencies

• @keeb/proxmox — Fleet VM start/stop, auth
• @keeb/prometheus — Metrics collection setup

Install

swamp extension pull @keeb/minecraft

Example

Warn players, then gracefully stop a running server before VM shutdown:

models:
  - name: mc
    type: "@keeb/minecraft/server"
    globalArguments:
      sshHost: "10.0.0.50"
      sshUser: "root"
      tmuxSession: "mons"
      serverDir: "~/mons"
      startScript: "./startserver.sh"
      logPath: "~/mons/logs/latest.log"
      serverName: "mons"

jobs:
  - name: graceful-stop
    steps:
      - model: mc
        method: warnShutdown
      - model: mc
        method: stopMinecraftServer
      - model: mc
        method: status

License

MIT