WebGUI

[1.0.0] — 2026-05-07

Added

Core

• Full-screen GUI mode: replaces the Minecraft screen with any web page (React, Vue, plain HTML)
• Transparent HUD overlay mode: renders a web page over the game world without blocking gameplay
• Chromium rendering via MCEF — full CSS3, ES2023, WebSockets, WebGL

Server → client

• /webgui gui <targets> <url> — opens a full-screen GUI for one or more players (requires webgui.command.gui, op level 2)
• /webgui hud <targets> <url> — opens a HUD overlay (requires webgui.command.hud, op level 2)
• Auto-HUD on join: configurable via config/webgui/server.json (autoHudOnJoin, autoHudUrl)
• Main menu URL: server sends a URL that players open on demand via F6
• Signed token auth: HMAC-SHA256 tokens appended to URLs automatically when enableTokens: true

Client keybinds

• F6 — open/close main menu page
• ` (backtick) — toggle interactive HUD mode (unlocks cursor, routes clicks and scroll to CEF)

JavaScript bridge

• window.webgui.client — live player data pushed at 20 TPS: playerUuid, username, webviewMode, dimension, pos, server
• webgui:client CustomEvent — subscribe with addEventListener('webgui:client', e => ...)
• window.webgui.postToGame(payload) — send JSON from the page to the game
• window.webgui.closeGui() — close the active GUI or HUD from the page
• Built-in channels: close, log (with level field)

React library

• @webgui/react npm package — useWebGUIClient() hook, no Provider required

Configuration (config/webgui/server.json)

• enableTokens, tokenTtlSeconds, queryParamName, tokenSecretBase64
• autoHudOnJoin, autoHudUrl, mainMenuUrl, updateCheckUrl

Public API (land.webgui.api.WebviewApi)

• openGui(player, url), openHud(player, url), sendMainMenuUrl(player, url) for use by other mods (call from server thread)