Files
core-minigames/docs/commands.md
T
2026-06-07 14:34:30 -07:00

2.9 KiB

Commands Reference

All commands are subcommands of /minigame.

Definition Management

/minigame list

Lists registered minigames and basic runtime state.

/minigame create <id> <name>

Creates a new minigame definition with default settings.

/minigame create Beach_Race "Beach Race"

Definitions created by command start disabled. Enable them when the asset is configured.

/minigame info <id>

Shows the loaded definition and runtime status for a minigame.

/minigame edit <id> <field> <value>

Edits a single definition field and saves the definition.

/minigame edit Beach_Race MaxPlayers 16
/minigame edit Beach_Race RoundLengthSeconds 600

/minigame enable <id>

Sets Enabled = true.

/minigame disable <id>

Sets Enabled = false. This prevents new starts but does not necessarily stop an already running runtime.

/minigame validate <id>

Runs definition validation. Current validation focuses on definition fields. The old custom-volume requirement for MinigameAreaVolume no longer applies.

/minigame delete <id>

Deletes the minigame definition.

/minigame export <id>

Exports the current definition JSON.

/minigame import <file>

Imports a definition from a JSON file path relative to the data directory.

Runtime Management

/minigame start <id>

Starts a queued runtime for the given minigame. The selected map comes from MapSelectionMode: highest vote for VOTE, random discovered map for RANDOM.

/minigame stop <id>

Stops all active runtimes for the minigame ID. An optional greedy reason argument can override the default admin-stop reason.

/minigame reset <id>

Resets all active runtimes for the minigame ID.

Map Commands

/minigame maps <id>

Lists maps discovered from trigger volumes in the sender's current world. Run this command as a player in the world containing the tagged volumes.

/minigame vote <id> <mapId>

Casts or updates the sender's vote in the minigame waiting session.

Player Commands

/minigame join <id> [player]

Adds the command sender, or the optional player target, to the minigame waiting queue.

/minigame leave [player]

Currently registered but not implemented. Use the LeaveMinigameQueue trigger effect for in-world queue leaving until the command is wired.

/minigame spectate <id>

Currently registered but not implemented. The command validates that the minigame exists and has a running runtime, then returns a not-implemented message.

Volume Commands

The old custom minigame volume system was removed. Use Hytale's trigger-volume editor for real volume placement and attach the minigame trigger effects and conditions there.

/minigame volume create <type> currently remains as a command stub for future Hytale trigger-volume integration. It should not be used as the primary way to define arenas.