Быстрый запуск

Что такое WebGUI?

WebGUI — это мод для Minecraft (Fabric и NeoForge), который встраивает настоящий браузер Chromium (через Rinku, ранее MCEF) прямо в игровой клиент. Операторы серверов могут отображать любую веб-страницу — React, Vue, чистый HTML — как прозрачный HUD-оверлей для игроков, а также задать страницу главного меню, открываемую по нажатию клавиши.

Требования

Компонент	Версия
Minecraft	1.20.1, 1.21.1, 1.21.11, 26.1.2, 26.2
Загрузчик	Fabric ≥ 0.16.0 (1.20.1 – 1.21.11) · NeoForge (1.21.1 – 26.2)
Fabric API	нужен на Fabric
Rinku	обязателен на NeoForge · на Fabric встроен в jar
Java	21, на Minecraft 26 — 25

Поддерживаются и клиент, и выделенный сервер на каждом загрузчике.

Сборки под Minecraft 26 существуют только для NeoForge — Fabric ждёт публикации Yarn-маппингов для 26.x.

Установка

1. Скачайте последний webgui-*.jar из Releases.
2. Поместите его в папку .minecraft/mods/:
   • Fabric — вместе с Fabric API. Браузерная библиотека лежит внутри jar WebGUI, добавлять больше нечего.
   • NeoForge — вместе с Rinku. Там он не встроен.
3. Запустите игру — сам Chromium скачается при первом запуске (~150 МБ).

На NeoForge нужен Rinku

На NeoForge Rinku — жёсткое требование, а не удобство: миксины WebGUI целятся в его классы, поэтому без него игра падает на загрузке модов, а не просто ничего не рисует.

Лаунчеры, читающие метаданные Modrinth (Prism, приложение Modrinth, CurseForge), начиная с WebGUI 1.7.0 ставят его сами. Если копируете jar-файлы вручную — добавьте его тоже.

Обновление с WebGUI 1.6.x и раньше

Браузерная библиотека переименована из MCEF в Rinku, id мода сменился с mcef на rinku. На NeoForge удалите старый jar MCEF и поставьте Rinku. На Fabric делать ничего не нужно — он внутри jar.

Как работает мод

В WebGUI нет игровых команд. Всё настраивается через config/webgui/server.json на сервере. При входе игрока сервер может:

• Автоматически открыть HUD-оверлей (autoHudOnJoin)
• Отправить URL главного меню, который игрок откроет нажатием F6 (mainMenuUrl)

Все доступные параметры описаны в конфиге server.json.

Авто-открытие HUD при входе

Самая распространённая настройка — показывать веб-оверлей сразу после подключения:

// config/webgui/server.json
{
  "autoHudOnJoin": true,
  "autoHudUrl": "https://ваш-hud.example.com"
}

Перезапустите сервер и войдите — оверлей откроется автоматически.

Главное меню по F6

Отправьте игрокам URL, который они смогут открыть в любой момент нажатием F6:

{
  "mainMenuUrl": "https://ваш-menu.example.com"
}

Следующие шаги

• Конфиг server.json — все параметры конфигурации
• Горячие клавиши — управление HUD на стороне клиента
• Примеры — готовые конфиги для вставки
• Соберите SPA с типобезопасным мостом под ваш фреймворк: React, Vue или Svelte