SH Better UI

SH-Better-UI

简体中文 · Installation · Developer Documentation

SH-Better-UI is a Minecraft UI library for Forge 1.20.1 and NeoForge 1.21.1. It gives mods and modpacks reusable controls, materials, and layout tools for menus, configuration screens, and HUD overlays.

Features

• Glass materials and themes — Build interfaces with Liquid Glass, real-time backdrop blur, Slate dark styling, spatial shadows, and dynamic themes that can follow the world's time, weather, and surroundings.
• Reusable controls — Add searchable fields, item and fluid pickers, dialogs, tooltips, action sheets, and scrollable layouts. Optional JEI integration provides recipe and uses views. General search and ingredient selection also work without JEI.
• Rich text — Mix styled text, images, items, and interactive elements in a single layout. The experimental in-game editor provides live previews, undo and redo, JSON import and export, and Java export.
• HUD and live activities — Display progress, notifications, and actions supplied by integrating mods. Dockable windows can collapse and remember their positions.
• Shared UI APIs — Use the Unified UI Kernel for rendering, layout, input, focus, themes, and resource management. Declarative pages, virtualized lists, native container integration, and KubeJS bindings support custom mod and modpack screens.

Installation

Install the SH-Better-UI file and Kotlin for Forge build that match your Minecraft version and mod loader.

Minecraft	Mod loader	Java	Required Kotlin for Forge
1.20.1	Forge 47.4.16 or later	17	4.12.0 or later in the 4.x series
1.21.1	NeoForge 21.1.251 or later	21	5.10.0 or later in the 5.x series

SH-Better-UI Downloads · Kotlin for Forge

Try It In-Game

Shortcut or command	What it opens
F8	Control panel. Open Developer Settings → Developer Panel to browse the material gallery.
F7	Live activity view for progress, notifications, and actions from integrating mods.
/shbetterrichtext	Rich text demo.
/shbetterricheditor	Experimental rich text editor.
/shbetterdock	Dockable window demo.

F7 and F8 are the default key bindings. Run the demo commands after entering a world.

Developer Documentation

Declare sh_better_ui as a dependency and ship the matching SH-Better-UI runtime JAR alongside your mod. The API reference and example project show how to integrate shared widgets and Unified UI Kernel services on both loaders.

Source Code · English API Reference · Forge and NeoForge Example Project · Report an Issue

What's New in 1.0.6

Highlights for users upgrading from 1.0.3, on both Forge and NeoForge.

• Liquid Glass and themes — Improved edge refraction, added adjustable blur and light transmission, and expanded the material gallery. The control panel offers a fixed theme, animation speed, and a low-performance mode.
• Rich text tools — Added inline images, items, and interactive content, plus an experimental editor with live preview and document export.
• Docking and live activities — Added collapsible docked windows with position persistence and the F7 activity view.
• Mod and modpack integration — Added the Unified UI Kernel, layout and input diagnostics in the Inspector, declarative pages, native containers, and KubeJS bindings. Integrated screens can use the same layout for drawing, clipping, and pointer hit testing.

---

简体中文

返回英文介绍 · 安装要求 · 开发文档

SH-Better-UI（焕界 UI 库） 是面向 Forge 1.20.1 和 NeoForge 1.21.1 的 Minecraft 共用界面库。模组和整合包可以使用库中的控件、材质和布局工具制作菜单、配置页面和 HUD。

主要功能

• 玻璃材质与主题：提供液态玻璃、实时背景模糊、Slate 深色主题和立体阴影。动态主题可随游戏内时间、天气和环境变化。
• 共用控件：提供搜索建议、物品与流体选择器、对话框、提示气泡、动作面板和滚动布局。安装 JEI 后可接入配方和用途界面，通用搜索与素材选择也可独立使用。
• 富文本：支持在同一段落中混排样式文本、图片、物品和可交互内容。实验性游戏内编辑器支持实时预览、撤销与重做、JSON 导入导出和 Java 导出。
• HUD 与实时活动：展示已接入模组提供的进度、通知和操作。可停靠窗口支持折叠并记住位置。
• 共用界面 API：统一 UI 内核提供渲染、布局、输入、焦点、主题和资源管理服务。开发者可使用声明式页面、虚拟列表、原生容器和 KubeJS 绑定制作自定义界面。

安装要求

选择与 Minecraft 版本和加载器匹配的 SH-Better-UI 文件，并安装对应的 Kotlin for Forge。

Minecraft 版本	加载器	Java	必需依赖 Kotlin for Forge
1.20.1	Forge 47.4.16 或更高	17	4.12.0 或更高的 4.x 版本
1.21.1	NeoForge 21.1.251 或更高	21	5.10.0 或更高的 5.x 版本

下载 SH-Better-UI · 下载 Kotlin for Forge

游戏内体验

快捷键或命令	功能
F8	打开主控面板，从「开发配置 → 开发者面板」进入材质图库。
F7	打开实时活动界面，查看已接入模组提供的进度、通知和操作。
/shbetterrichtext	打开富文本示例。
/shbetterricheditor	打开实验性富文本编辑器。
/shbetterdock	打开可停靠窗口示例。

F7 和 F8 为默认快捷键。示例命令在进入世界后使用。

开发文档

在模组中声明 sh_better_ui 依赖，并随整合环境安装对应加载器的 SH-Better-UI 运行包。API 文档和双端示例包含共用控件与统一 UI 内核的接入方式。

项目源码 · 简体中文 API 参考 · Forge 与 NeoForge 接入示例 · 提交问题

返回顶部