UIcore — 在 Minecraft 世界中构建交互式菜单
一款面向 Minecraft 服务器的世界空间 UI 框架。
YAML 配置 · 公开 Java API · 无需资源包 · 支持 Paper 与 Folia
? 重新构想 Minecraft 服务器界面
当菜单可以成为游戏世界的一部分时,为何还要将服务器的界面局限于传统的箱子背包?
UIcore 是一款专为 Minecraft 服务器设计的世界空间用户界面框架。与传统打开背包屏幕不同,UIcore 将交互式菜单元素放置在玩家摄像机周围,创造出一种融入 Minecraft 环境的界面体验。
文本标签、按钮、物品预览、玩家头像、开关和输入框都可以成为统一交互场景的一部分。
玩家通过 视觉光标 与这些元素进行交互,从而导航菜单、悬停按钮、触发操作、切换屏幕,并通过 Minecraft 的聊天系统输入文本。
UIcore 为服务器管理员和插件开发者提供了更大的界面设计灵活性,使得创建超越传统基于背包菜单的体验成为可能。
✨ 核心亮点
- 世界空间界面: 直接在 Minecraft 世界中显示菜单元素。
- 交互式控件: 按钮、工具提示、悬停反馈、点击动画等。
- 基于 YAML 的配置: 无需开发单独的 Java 插件即可创建菜单。
- 公开 Java API: 通过自定义逻辑和组件扩展框架。
- 动态元素: 根据单个玩家的状态更改文本、材质和可见性。
- 结构图预览: 在不修改真实方块的情况下显示特定于玩家的建筑。
- 可选集成: 在需要时将 UIcore 与其他服务器插件连接。
- 无需强制资源包: 捆绑的示例使用原版 Minecraft 物品。
无论您是在构建简单的导航菜单还是更复杂的界面系统,UIcore 都提供了在 Minecraft 内部直接创建交互体验所需的工具。
? 功能特性
?️ 1. 交互式屏幕与导航
使用围绕玩家摄像机定位的交互式元素创建完整的菜单屏幕。
UIcore 支持:
- 文本标签: 作为界面的一部分显示信息。
- 交互式按钮: 让玩家通过菜单元素触发操作。
- 视觉光标导航: 使用游戏内光标在交互式元素之间移动。
- 悬停反馈: 当玩家指向某个元素时做出反应。
- 光标样式: 通过支持的样式自定义光标的行为和外观。
- 工具提示: 提供有关菜单元素的额外信息。
- 点击动画: 在与玩家交互时给予视觉反馈。
- 点击冷却时间: 控制操作触发的频率。
- 屏幕过渡: 在不同菜单和屏幕之间导航。
这些功能允许开发者构建感觉更像专用游戏界面而非传统背包菜单的交互布局。
? 2. 动态内容、输入与玩家状态
UIcore 不仅限于静态菜单布局。
其状态和条件系统允许界面元素对玩家动作和服务器端逻辑做出反应。
可用功能包括:
- 基于聊天的文本输入: 通过 Minecraft 聊天接收用户输入。
- 开关控件: 构建具有多个可选状态的元素。
- 权限检查: 根据玩家权限限制操作。
- 点击要求: 定义执行操作前必须满足的条件。
- 按玩家划分的元素状态: 为不同玩家维护独立的界面状态。
- 动态文本: 根据元素状态更改显示的标签。
- 动态材质: 更新元素显示的物品或材质。
- 条件可见性: 根据其状态显示或隐藏元素。
例如,设置屏幕可以为单个玩家显示不同的开关状态,而不可用的选项则可以根据配置的条件被隐藏或以不同方式呈现。
这使得 UIcore 适用于需要反映特定玩家信息和服务器行为的界面。
? 3. 物品展示、玩家头像与画廊
Minecraft 物品可用作自定义界面内的视觉组件。
UIcore 提供了以下功能:
- 显示 Minecraft 物品。
- 显示玩家头像。
- 创建物品画廊。
- 使用可复用的元素模板。
- 构建具有可选内容的槽位。
这些能力可用于设计物品选择器、视觉目录、个人资料屏幕、收藏集以及其他视觉内容发挥重要作用的界面。
开发者不必完全依赖背包槽位,而是可以将物品组织为自定义世界空间布局的一部分。
?️ 4. 特定于玩家的结构图预览
直接在菜单中预览建筑,而不改变实际的 Minecraft 世界。
UIcore 支持使用 Sponge .schem 格式(版本 v2 和 v3)进行最多 四个特定于玩家的结构图预览。
关键特性:
- 在菜单中显示最多四个结构图预览。
- 仅向相关玩家发送预览数据。
- 保持实际世界方块不变。
- 将预览用作建筑选择器、目录或其他自定义界面的一部分。
这允许玩家在视觉上检查建筑,而无需将其物理放置在世界中。
当前限制: 结构图预览显示方块状态,但不复制容器或其他方块实体内容、实体或生物群系。
?️ 5. 玩家可见性、隐私与伤害设置
不同的界面可能需要与周围游戏世界不同程度的隔离。
UIcore 提供了每菜单设置,控制玩家和界面如何与其他玩家互动。
您可以配置:
- 其他玩家是否能看到菜单的显示元素。
- 打开菜单的玩家是否对其他玩家隐藏。
- 菜单用户是否对其他玩家隐藏。
- 在菜单打开期间,是否允许或阻止来自其他玩家的伤害。
这些设置在设计服务器大厅、游戏模式选择以及其他需要控制玩家与周围世界交互的场景时非常有用。
?️ 两种构建方式:YAML 和 Java API
UIcore 专为服务器管理员和 Java 插件开发者设计。
你可以使用 YAML 配置菜单,或通过其公共 API 扩展框架。
? YAML 菜单配置
通过 YAML 配置文件创建和管理界面。
这种方法允许服务器所有者在不必为每个界面编写单独的 Java 插件的情况下定义菜单。
YAML 适用于以下场景:
- 服务器导航菜单。
- 玩家资料屏幕。
- 设置界面。
- 游戏模式选择器。
- 物品展示库。
- 其他可配置的菜单系统。
菜单文件存储在:
plugins/UIcore/menu/
添加或修改菜单后,请使用以下命令重新加载配置:
/uicore reload
有关配置结构、支持的元素、操作和示例,请参阅 菜单制作指南。
☕ 公共 Java API
对于更高级的开发,UIcore 提供了公共 Java API。
开发者可以通过注册以下内容来扩展框架:
- 自定义动作: 定义玩家在交互元素时的额外行为。
- 数据提供者: 从外部系统或你自己的插件中提供信息。
- 条件: 添加自定义要求和交互逻辑。
- 自定义组件: 扩展可用的界面元素。
这使得 UIcore 不仅作为一个可配置的菜单插件有用,还作为其他 Minecraft 服务器系统的界面基础。
API 允许开发者将 UIcore 接口连接到他们自己的插件功能,而不是构建一个完全独立的 UI 系统。
? 你能用 UIcore 构建什么?
UIcore 可以作为许多不同 Minecraft 服务器功能的界面层。
? 服务器大厅与导航
构建一个中央导航界面,让玩家能够访问服务器的不同部分。
使用按钮、标签、物品显示和屏幕过渡来组织导航。
? 玩家资料
创建包含玩家头像、信息、物品和交互操作的资料界面。
动态状态和数据提供者可用于将界面连接到特定于玩家的信息。
⚙️ 设置菜单
使用切换开关、条件和单独的玩家状态构建可配置的设置屏幕。
元素可以根据所选状态更新其外观或可见性。
? 商店与物品目录
使用物品显示和画廊创建可用物品的视觉目录。
将菜单操作连接到您自己的购买或交易逻辑。
? 游戏模式选择
为不同的游戏模式或服务器目的地设计选择屏幕。
结合视觉元素、导航按钮和特定于玩家的条件。
? 建筑与结构画廊
让玩家在选择之前预览图纸结构。
显示支持的 Sponge 图纸预览,而无需修改真实世界的方块。
? 自定义插件界面
使用 Java API 为你的插件创建界面,包括自定义动作、数据源、条件和组件。
注意: 这些是使用 UIcore 功能可以构建的系统示例。应用程序特定的逻辑(如支付处理、持久性或游戏模式管理)必须由相关的服务器插件实现或提供。
? 集成
UIcore 支持与其它 Minecraft 服务器插件集成。
内置可选集成
其他可选集成
- PlaceholderAPI
- FancyNpcs
- SkinsRestorer
- CraftEngine
所有列出的集成均为可选。
UIcore 可以在未安装这些插件的情况下启动。但是,依赖于特定集成的功能需要相应的插件存在。
这允许服务器所有者在不安装无关依赖项的情况下使用核心框架。
? 要求与兼容性
在安装 UIcore 之前,请确保你的服务器满足以下要求。
| 组件 |
要求 |
| Minecraft |
1.21.1 或更高版本 |
| 服务器软件 |
Paper 或兼容的服务器实现 |
| Folia |
支持,但有区域限制 |
| PacketEvents |
2.14.0(必需) |
| Java 运行时 |
所选 Minecraft 和服务器构建所需的版本 |
| UIcore 插件/API 字节码 |
Java 17 |
| Vault / LuckPerms |
可选 |
| PlaceholderAPI / FancyNpcs / SkinsRestorer / CraftEngine |
可选 |
Folia 兼容性
UIcore 声明支持 Folia。
在 Folia 上运行时,属于菜单场景的所有元素必须保持在相机的区域内。
在设计定位世界空间界面时应考虑此限制。
Java 兼容性
UIcore 的插件和公共 API 使用 Java 17 字节码编译。
但这并不意味着每一个受支持的 Minecraft 服务器版本都能在 Java 17 上运行。
始终使用你选择的 Minecraft 版本和服务器实现所需的 Java 运行时。
有关经过测试的服务器构建和其他兼容性信息,请参阅 兼容性矩阵。
? 快速入门
开始使用 UIcore 只需要几个步骤。
第 1 步 — 安装插件
下载 UIcore 及其必需的依赖项 PacketEvents 2.14.0。
将两个插件文件放入服务器的 plugins/ 目录中。
步骤 2 — 启动服务器
启动或重启 Minecraft 服务器。
UIcore 将生成其配置文件以及三个内置示例菜单。
步骤 3 — 打开演示菜单
运行以下命令:
/uicore run demo_main
这将打开主演示菜单。
要关闭当前打开的菜单,请使用:
/uicore stop
步骤 4 — 创建你自己的菜单
在以下路径添加或修改 YAML 菜单文件:
plugins/UIcore/menu/
使用现有的示例和菜单制作文档作为参考。
步骤 5 — 重新加载配置
进行修改后,执行:
/uicore reload
这将加载你更新的菜单配置。
步骤 6 — 浏览文档
如需更详细的设置和配置指南,请使用以下资源:
? 视频演示
查看 UIcore 的实际界面效果。
内置菜单指南
探索随 UIcore 提供的演示菜单。
▶️ 观看内置菜单指南
自定义服务器菜单
查看使用该框架创建的自定义服务器界面示例。
▶️ 观看自定义服务器菜单演示
⚠️ 当前限制与重要说明
UIcore 为 Minecraft 世界空间界面提供了灵活的基础,但某些功能存在技术限制。
结构预览限制
结构预览目前仅显示方块状态。
它们无法还原:
- 容器内容。
- 其他方块实体内容。
- 实体。
- 生物群系信息。
在设计建筑预览系统时应考虑这些限制。
控制台命令限制
从菜单中执行控制台命令默认已禁用。
若要启用特定的控制台命令,必须配置显式白名单。
这可以防止菜单配置自动获得无限制的控制台命令执行权限。
NoChatReports 兼容性
在某些客户端配置下,NoChatReports 可能会干扰 UIcore 菜单使用的签名聊天行为和文本输入。
请参阅兼容性文档以了解该问题及其记录在案的工作区解决方案。
Folia 区域限制
使用 Folia 时,请将菜单场景的所有元素保持在摄像机的区域内。
服务端实现兼容性
兼容性可能因所选 Minecraft 版本、服务端实现(Server Implementation)及已安装的插件而异。
在生产服务器上部署 UIcore 之前,请查阅发布的 兼容性矩阵。
? 开源与许可
UIcore 是一个开源项目,根据 GNU Affero 通用公共许可证 v3.0 (AGPL-3.0) 分发。
源代码可根据许可证条款进行查看、修改和进一步开发。
源代码: github.com/kekaop/UIcore
许可证: AGPL-3.0
开发者: Orven
致谢与原项目
UIcore 基于 wuhaoxian123 开发的 CustomScreenMenu。
该项目已获得原作者许可发布。
? UIcore — 融入你世界的界面
UIcore 提供了一种不同的 Minecraft 服务器界面设计方法。
它不将玩家限制在传统的库存屏幕中,而是使开发人员能够使用熟悉的 Minecraft 元素创建交互式、以摄像机为中心的菜单。
通过 YAML 配置、公开的 Java API、动态状态、结构预览和可选集成,UIcore 可作为各种自定义服务器界面的基础。
构建感觉像是 Minecraft 一部分的菜单,而不仅仅是另一个库存窗口。
在 GitHub 上探索 UIcore
UIcore — Build Interactive Menus Inside the Minecraft World
A world-space UI framework for Minecraft servers.
YAML Configuration · Public Java API · No Required Resource Pack · Paper & Folia Support
? Rethink Minecraft Server Interfaces
Why limit your server's interface to traditional chest inventories when menus can become part of the game world itself?
UIcore is a world-space user interface framework designed for Minecraft servers. Instead of opening a conventional inventory screen, UIcore places interactive menu elements around the player's camera, creating an interface that feels integrated into the Minecraft environment.
Text labels, buttons, item previews, player avatars, toggles, and input fields can become part of a unified interactive scene.
Players interact with these elements using a visual cursor, allowing them to navigate menus, hover over buttons, trigger actions, switch between screens, and enter text through Minecraft's chat system.
UIcore gives server owners and plugin developers greater flexibility when designing interfaces, making it possible to create experiences that go beyond conventional inventory-based menus.
✨ Key Highlights
- World-space interfaces: Display menu elements directly in the Minecraft world.
- Interactive controls: Buttons, tooltips, hover feedback, click animations, and more.
- YAML-based configuration: Create menus without developing a separate Java plugin.
- Public Java API: Extend the framework with custom logic and components.
- Dynamic elements: Change text, materials, and visibility based on individual player states.
- Schematic previews: Display player-specific structures without modifying real blocks.
- Optional integrations: Connect UIcore with other server plugins when needed.
- No mandatory resource pack: The bundled examples use vanilla Minecraft items.
Whether you are building a simple navigation menu or a more complex interface system, UIcore provides the tools needed to create interactive experiences directly inside Minecraft.
? Features
?️ 1. Interactive Screens and Navigation
Create complete menu screens using interactive elements positioned around the player's camera.
UIcore supports:
- Text labels: Display information as part of your interface.
- Interactive buttons: Let players trigger actions through menu elements.
- Visual cursor navigation: Move between interactive elements using an in-game cursor.
- Hover feedback: React when the player points at an element.
- Cursor styles: Customize cursor behavior and appearance through supported styles.
- Tooltips: Provide additional information about menu elements.
- Click animations: Give players visual feedback when interacting.
- Click cooldowns: Control how frequently actions can be triggered.
- Screen transitions: Navigate between different menus and screens.
These features allow developers to build interactive layouts that feel more like a dedicated game interface than a traditional inventory menu.
? 2. Dynamic Content, Input, and Player States
UIcore is not limited to static menu layouts.
Its state and condition systems allow interface elements to react to player actions and server-side logic.
Available functionality includes:
- Chat-based text input: Receive user input through Minecraft chat.
- Toggle controls: Build elements with multiple selectable states.
- Permission checks: Restrict actions based on player permissions.
- Click requirements: Define conditions that must be satisfied before an action executes.
- Per-player element states: Maintain individual interface states for different players.
- Dynamic text: Change displayed labels based on element state.
- Dynamic materials: Update the item or material shown by an element.
- Conditional visibility: Show or hide elements depending on their state.
For example, a settings screen can display different toggle states for individual players, while unavailable options can be hidden or presented differently according to configured conditions.
This makes UIcore suitable for interfaces that need to reflect player-specific information and server behavior.
? 3. Item Displays, Player Avatars, and Galleries
Minecraft items can be used as visual components inside your custom interface.
UIcore provides functionality for:
- Displaying Minecraft items.
- Showing player avatars.
- Creating item galleries.
- Using reusable element templates.
- Building slots with selectable contents.
These capabilities can be used to design item selectors, visual catalogs, profile screens, collections, and other interfaces where visual content plays an important role.
Instead of relying entirely on inventory slots, developers can organize items as part of a custom world-space layout.
?️ 4. Player-Specific Schematic Previews
Preview structures directly inside a menu without changing the actual Minecraft world.
UIcore supports up to four player-specific schematic previews using the Sponge .schem format, versions v2 and v3.
Key characteristics:
- Display up to four schematic previews within a menu.
- Send preview data only to the relevant player.
- Keep the actual world blocks unchanged.
- Use previews as part of building selectors, catalogs, or other custom interfaces.
This allows players to inspect a structure visually without requiring it to be physically placed in the world.
Current limitation: Schematic previews display block states but do not reproduce container or other block-entity contents, entities, or biomes.
?️ 5. Player Visibility, Privacy, and Damage Settings
Different interfaces may require different levels of isolation from the surrounding game world.
UIcore provides per-menu settings that control how the player and interface interact with other players.
You can configure:
- Whether nearby players can see a menu's display elements.
- Whether the player who opened the menu is hidden from other players.
- Whether other players are hidden from the menu user.
- Whether damage from other players is allowed or blocked while the menu is open.
These settings are useful when designing interfaces for server hubs, game-mode selection, and other situations where the player's interaction with the surrounding world needs to be controlled.
?️ Two Ways to Build: YAML and Java API
UIcore is designed for both server administrators and Java plugin developers.
You can configure menus using YAML or extend the framework through its public API.
? YAML Menu Configuration
Create and manage interfaces through YAML configuration files.
This approach allows server owners to define menus without having to write a separate Java plugin for every interface.
YAML is suitable for:
- Server navigation menus.
- Player profile screens.
- Settings interfaces.
- Game-mode selectors.
- Item galleries.
- Other configurable menu systems.
Menu files are stored in:
plugins/UIcore/menu/
After adding or modifying a menu, reload the configuration with:
/uicore reload
For configuration structure, supported elements, actions, and examples, refer to the Menu Authoring Guide.
☕ Public Java API
For more advanced development, UIcore exposes a public Java API.
Developers can extend the framework by registering:
- Custom actions: Define additional behavior when players interact with elements.
- Data providers: Supply information from external systems or your own plugins.
- Conditions: Add custom requirements and interaction logic.
- Custom components: Extend the available interface elements.
This makes UIcore useful not only as a configurable menu plugin but also as an interface foundation for other Minecraft server systems.
The API allows developers to connect UIcore interfaces to their own plugin functionality rather than building an entirely separate UI system.
? What Can You Build with UIcore?
UIcore can serve as the interface layer for many different Minecraft server features.
? Server Hub and Navigation
Build a central navigation interface that gives players access to different sections of your server.
Use buttons, labels, item displays, and screen transitions to organize navigation.
? Player Profiles
Create profile interfaces featuring player avatars, information, items, and interactive actions.
Dynamic states and data providers can be used to connect the interface to player-specific information.
⚙️ Settings Menus
Build configurable settings screens using toggles, conditions, and individual player states.
Elements can update their appearance or visibility depending on the selected state.
? Shops and Item Catalogs
Use item displays and galleries to create visual catalogs of available items.
Connect menu actions to your own purchasing or transaction logic.
? Game-Mode Selection
Design selection screens for different game modes or server destinations.
Combine visual elements, navigation buttons, and player-specific conditions.
? Building and Structure Galleries
Let players preview schematic structures before choosing them.
Display supported Sponge schematic previews without modifying real world blocks.
? Custom Plugin Interfaces
Use the Java API to create interfaces for your own plugins, including custom actions, data sources, conditions, and components.
Note: These are examples of systems that can be built using UIcore's features. Application-specific logic, such as payment processing, persistence, or game-mode management, must be implemented or provided by the relevant server plugins.
? Integrations
UIcore supports integration with other Minecraft server plugins.
Built-in Optional Integrations
Additional Optional Integrations
- PlaceholderAPI
- FancyNpcs
- SkinsRestorer
- CraftEngine
All listed integrations are optional.
UIcore can start without these plugins installed. However, features that depend on a particular integration require the corresponding plugin to be present.
This allows server owners to use the core framework without installing unrelated dependencies.
? Requirements and Compatibility
Before installing UIcore, make sure your server meets the following requirements.
| Component |
Requirement |
| Minecraft |
1.21.1 or newer |
| Server software |
Paper or a compatible server implementation |
| Folia |
Supported with regional constraints |
| PacketEvents |
2.14.0 (required) |
| Java runtime |
Version required by the selected Minecraft and server build |
| UIcore plugin/API bytecode |
Java 17 |
| Vault / LuckPerms |
Optional |
| PlaceholderAPI / FancyNpcs / SkinsRestorer / CraftEngine |
Optional |
Folia Compatibility
UIcore declares support for Folia.
When running on Folia, all elements belonging to a menu scene must remain within the camera's region.
This restriction should be considered when designing and positioning world-space interfaces.
Java Compatibility
UIcore's plugin and public API are compiled using Java 17 bytecode.
However, this does not mean that every supported Minecraft server version can run on Java 17.
Always use the Java runtime required by your selected Minecraft version and server implementation.
For tested server builds and additional compatibility information, see the Compatibility Matrix.
? Quick Start
Getting started with UIcore only requires a few steps.
Step 1 — Install the Plugins
Download UIcore and its required dependency, PacketEvents 2.14.0.
Place both plugin files in your server's plugins/ directory.
Step 2 — Start Your Server
Start or restart the Minecraft server.
UIcore will generate its configuration files and three bundled example menus.
Step 3 — Open the Demo Menu
Run the following command:
/uicore run demo_main
This opens the main demonstration menu.
To close the currently opened menu, use:
/uicore stop
Step 4 — Create Your Own Menu
Add or modify YAML menu files in:
plugins/UIcore/menu/
Use the existing examples and the menu authoring documentation as a reference.
Step 5 — Reload the Configuration
After making changes, execute:
/uicore reload
This loads your updated menu configuration.
Step 6 — Explore the Documentation
For a more detailed setup and configuration walkthrough, use the following resources:
? Video Demonstrations
See UIcore interfaces in action.
Bundled Menu Walkthrough
Explore the demonstration menus included with UIcore.
▶️ Watch the bundled menu walkthrough
Custom Server Menu
See an example of a custom server interface created with the framework.
▶️ Watch the custom server menu demonstration
⚠️ Current Limitations and Important Notes
UIcore provides a flexible foundation for Minecraft world-space interfaces, but some features have technical limitations.
Schematic Preview Limitations
Schematic previews currently display block states.
They do not reproduce:
- Container contents.
- Other block-entity contents.
- Entities.
- Biome information.
These limitations should be considered when designing building preview systems.
Console Command Restrictions
Executing console commands from menus is disabled by default.
To enable specific console commands, an explicit allowlist must be configured.
This prevents menu configurations from automatically receiving unrestricted console command execution.
NoChatReports Compatibility
On certain client configurations, NoChatReports may interfere with signed chat behavior and text input used by UIcore menus.
Refer to the compatibility documentation for the observed issue and its documented workaround.
Folia Regional Restrictions
When using Folia, keep all elements of a menu scene within the camera's region.
Server Build Compatibility
Compatibility may vary depending on the selected Minecraft version, server implementation, and installed plugins.
Consult the published Compatibility Matrix before deploying UIcore to a production server.
? Open Source and Licensing
UIcore is an open-source project distributed under the GNU Affero General Public License v3.0 (AGPL-3.0).
The source code is available for inspection, modification, and further development under the terms of the license.
Source Code: github.com/kekaop/UIcore
License: AGPL-3.0
Developer: Orven
Credits and Original Project
UIcore is based on CustomScreenMenu by wuhaoxian123.
The project is published with permission from the original developer.
? UIcore — Interfaces That Become Part of Your World
UIcore provides a different approach to Minecraft server interface design.
Instead of restricting players to conventional inventory screens, it enables developers to create interactive, camera-centered menus using familiar Minecraft elements.
With YAML configuration, a public Java API, dynamic states, schematic previews, and optional integrations, UIcore can serve as the foundation for a wide range of custom server interfaces.
Build menus that feel like part of Minecraft, not just another inventory window.
Explore UIcore on GitHub
评论 0
登录后参与评分
还没有评论,来抢沙发吧