Quick test configs

Copy any config below into config/webgui/server.json, restart the server, and join to test.

Minimal — just the main menu key

No automatic behavior. Players press F6 to open your page.

{
  "enableTokens": false,
  "autoHudOnJoin": false,
  "autoHudUrl": "",
  "mainMenuUrl": "https://your-menu.example.com",
  "updateCheckUrl": ""
}

---

Auto HUD on join

Opens a HUD overlay automatically when a player joins.

{
  "enableTokens": false,
  "autoHudOnJoin": true,
  "autoHudUrl": "https://your-hud.example.com",
  "mainMenuUrl": "",
  "updateCheckUrl": ""
}

Replace autoHudUrl with your page URL.

---

Main menu on F6

Pressing F6 in-game opens your custom menu page.

{
  "enableTokens": false,
  "autoHudOnJoin": false,
  "autoHudUrl": "",
  "mainMenuUrl": "https://your-menu.example.com",
  "updateCheckUrl": ""
}

---

Signed tokens

Your backend can verify that requests come from a real WebGUI client. The mod generates tokenSecretBase64 automatically on first run.

{
  "enableTokens": true,
  "tokenTtlSeconds": 300,
  "queryParamName": "webgui_token",
  "tokenSecretBase64": "",
  "autoHudOnJoin": true,
  "autoHudUrl": "https://your-hud.example.com",
  "mainMenuUrl": "https://your-menu.example.com",
  "updateCheckUrl": ""
}

When a player joins, the mod appends ?webgui_token=<token> to the URL. Your backend verifies the HMAC signature using the shared tokenSecretBase64.

---

Full setup

Everything enabled. Replace the placeholder values.

{
  "enableTokens": true,
  "tokenTtlSeconds": 900,
  "queryParamName": "webgui_token",
  "tokenSecretBase64": "",
  "autoHudOnJoin": true,
  "autoHudUrl": "https://your-hud.example.com",
  "mainMenuUrl": "https://your-menu.example.com",
  "updateCheckUrl": "https://api.github.com/repos/your-org/webgui/releases/latest"
}