webgui

KO | EN

gitlite — search

#devops #html #terminal #android #nlp #claude #ruby #tailwindcss #react-native #github

(★ 9)

Chromium-powered web UI framework for Minecraft — render any web page as a GUI screen or HUD overlay

파일 탐색기

ZIP 다운로드

- - bug_report.yml
  - config.yml
  - feature_request.yml
- - server-smoke-test.sh
  - verify-modrinth.py
- - build.yml
  - release.yml
- pull_request_template.md
- - gradle-wrapper.jar
  - gradle-wrapper.properties
- - gradle.properties
- - gradle.properties
- - gradle.properties
- - gradle.properties
- - gradle.properties
- - gradle.properties
- - gradle.properties
- - gradle.properties
.gitattributes
.gitignore
build.gradle
CHANGELOG.md
CONTRIBUTING.md
gradle.properties
gradlew
gradlew.bat
LICENSE
README.md
settings.gradle
stonecutter.gradle

# CDN으로 사용하기

jsDelivr

jsDelivr는 공개 GitHub 리포지토리를 별도 설정 없이 CDN으로 즉시 서빙합니다. 버전과 파일을 고르면 웹페이지에 바로 붙일 수 있는 링크와 예시 코드가 만들어집니다.

버전

파일

링크

예시

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

**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 [Rinku](https://modrinth.com/mod/rinku), the MCEF fork) 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.

[![Build](https://github.com/mc-webgui/webgui/actions/workflows/build.yml/badge.svg)](https://github.com/mc-webgui/webgui/actions/workflows/build.yml)
[![Modrinth](https://img.shields.io/modrinth/dt/webgui?logo=modrinth&label=Modrinth&color=1bd96a)](https://modrinth.com/project/webgui)
[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://raw.githubusercontent.com/mc-webgui/webgui/main/LICENSE)

---

## 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 | ✅ Active |
| 26.1 | NeoForge | ✅ Active |
| 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** — Fabric is on hold until Yarn mappings for 26.x are published.

Chromium (~150 MB) is downloaded automatically on first launch. Include [Rinku](https://modrinth.com/mod/rinku) (formerly MCEF [Keksuccino's Fork]) in your modpack to pre-bundle it.

---

## Installation

1. Download the latest JAR from [Modrinth](https://modrinth.com/project/webgui) (pick the right MC version).
2. Place it in `.minecraft/mods/`.
   - **Fabric:** also add Fabric API. The browser library ships inside the WebGUI jar.
   - **NeoForge:** also add [Rinku](https://modrinth.com/mod/rinku) — it is not bundled, and WebGUI cannot render a page without it.
3. Start the game.

---

## Quick setup (server)

Create or edit `config/webgui/server.json`:

```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:

```bash
npm install @webgui/react
```

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

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

→ [npm: @webgui/react](https://www.npmjs.com/package/@webgui/react) · [Docs](https://webgui.space)

---

## Building from source

```bash
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](https://webgui.space)**.

---

## Contributing

See [CONTRIBUTING.md](CONTRIBUTING.md). Bug fixes and translations are always welcome.

---

## License

webgui

파일 탐색기

# CDN으로 사용하기

Was this content helpful?

Recent Feedback

Download README