Skip to content

Status Adapter

Status adapters provide server information for the Minecraft multiplayer server list (MOTD, player count, favicon).

Static configuration from TOML.

[status]
adapter = "fixed"
[status.fixed]
name = "My Network"
description = "\"Welcome!\""
favicon = "data:image/png;base64,..."
enforces_secure_chat = true
preferred_version = 769 # Minecraft 1.21
min_version = 766 # 1.20.5+
max_version = 1000

Description format: JSON text, escaped for TOML. Use \"text\" for simple strings, or full JSON objects for formatting.

Favicon: Base64-encoded 64x64 PNG. Generate with: base64 -w 0 server-icon.png

Protocol versions: See wiki.vg for version numbers.

Queries an HTTP endpoint for dynamic status. Caches responses for cache_duration seconds.

[status]
adapter = "http"
[status.http]
address = "https://api.example.com/minecraft/status"
cache_duration = 5

Endpoint requirements: GET request, return JSON:

{
"version": {"name": "My Network", "protocol": 769},
"players": {"online": 42, "max": 100},
"description": {"text": "Welcome!"},
"favicon": "data:image/png;base64,...",
"enforcesSecureChat": true
}

Custom gRPC service for full control.

[status]
adapter = "grpc"
[status.grpc]
address = "http://status-service:3030"

See Custom gRPC Adapters for implementation details and proto definitions.