Quick Start
What is WebGUI?
WebGUI is a Minecraft Fabric mod that embeds a real Chromium browser (via MCEF) directly in the game client. It lets server operators display any web page — React, Vue, plain HTML — as a transparent HUD overlay for their players, and set a custom main menu page accessible with a keybind.
Requirements
| Requirement | Version |
|---|---|
| Minecraft | 1.20.1, 1.21.1, 1.21.11 |
| Fabric Loader | ≥ 0.16.0 |
| Fabric API | any |
| Java | 21 |
Installation
- Download the latest
webgui-*.jarfrom Releases. - Place it in your
.minecraft/mods/folder alongside Fabric API. - Start the game — Chromium will be downloaded automatically on first launch (~150 MB).
Skip the download for players
If you want players to have Chromium pre-bundled (no download on first launch), include MCEF in your modpack alongside WebGUI. Without it the mod downloads Chromium automatically — MCEF is optional.
How the mod works
WebGUI is configured through config/webgui/server.json on the server and also exposes server-side commands (see Commands). When a player joins, the server can:
- Automatically open a HUD overlay (
autoHudOnJoin) - Send a main menu URL the player can open with
F6(mainMenuUrl)
See server.json config for all available options.
Auto HUD on join
The most common setup — show a web overlay the moment a player connects:
// config/webgui/server.json
{
"autoHudOnJoin": true,
"autoHudUrl": "https://your-hud.example.com"
}Restart the server and join to test it.
Main menu on F6
Send players a URL they can open any time with F6:
{
"mainMenuUrl": "https://your-menu.example.com"
}Next steps
- server.json config — all configuration fields
- Keybindings — player-side HUD controls
- Examples — ready-to-paste configs
- React Library — build your SPA with type-safe hooks