WebGUI

Embed any web page as a full-screen GUI or transparent HUD overlay inside Minecraft.

WebGUI is a Fabric & NeoForge mod that embeds a real Chromium browser (via MCEF) directly in the game client. Server operators can display any React, Vue, or plain HTML app to their players — as a HUD overlay that auto-opens on join, or as a custom main menu accessible with a keybind.

---

Features

• Full-screen GUI — open any URL as a screen that closes with Esc
• HUD overlay — transparent overlay on top of the game; toggle interactive mode with `
• Auto HUD on join — automatically shows a HUD overlay when a player connects
• Custom main menu — players press F6 to open your web page
• Live client data — the mod pushes window.webgui.client (position, look direction, health, food, XP level, gamemode, dimension, server info) to the page at 20 TPS
• Signed tokens — every URL the mod opens carries an HMAC-signed token so your backend can verify the player's identity
• Mod API — other mods (Fabric or NeoForge) can open WebGUI overlays programmatically via WebviewApi

---

Compatibility

Minecraft	Loader	Status
26.2	NeoForge	🧪 Beta
26.1	NeoForge	🧪 Beta
1.21.5 – 1.21.11	Fabric	✅ Active
1.21.5 – 1.21.11	NeoForge	✅ Active
1.21 – 1.21.1	Fabric	✅ Supported
1.21 – 1.21.1	NeoForge	✅ Supported
1.20.1	Fabric	✅ Supported

Minecraft 26 builds are NeoForge-only and in beta — Fabric is on hold until Yarn mappings for 26.x are published.

Chromium (~150 MB) is downloaded automatically on first launch. Include MCEF in your modpack to pre-bundle it.

---

Installation

1. Download the latest JAR from Modrinth (pick the right MC version).
2. Place it in .minecraft/mods/ (on Fabric, also add Fabric API; NeoForge needs no extra dependencies).
3. Start the game.

---

Quick setup (server)

Create or edit config/webgui/server.json:

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

Restart the server and join to test.

---

Server commands

/webgui gui <targets> <url>   — open a full-screen GUI for players
/webgui hud <targets> <url>   — open a HUD overlay for players

Requires operator level 2. Supports fabric-permissions-api (LuckPerms, etc.).

---

React library

Build your SPA with type-safe hooks:

npm install @webgui/react

import { useWebGUIClient, isInMod, isReady } from '@webgui/react';

export function PlayerInfo() {
  const client = useWebGUIClient();
  if (!isInMod())       return <p>Open this inside Minecraft.</p>;
  if (!isReady(client)) return <p>Connecting…</p>;
  return <p>Hello, {client!.username}</p>;
}

→ npm: @webgui/react · Docs

---

Building from source

git clone https://github.com/mc-webgui/webgui.git
cd webgui
./gradlew build

Outputs JARs for all supported Minecraft versions to versions/*/build/libs/.

---

Documentation

Full documentation at webgui.space.

---

Contributing

See CONTRIBUTING.md. Bug fixes and translations are always welcome.

---

License

MIT © KoSHeroff