Home

UIcore Wiki

Language: English | Русская версия

UIcore is a world-space interface framework for Minecraft servers. It places menus around the player's camera and lets players interact with text, items, buttons, and input fields using a visual cursor.

Start here

• Install UIcore and its required dependency.
• Create a menu using YAML.
• Extend UIcore with Java.
• Configure built-in and optional integrations.
• Check tested server builds and known client issues.
• Try the bundled menus and watch the demos.

The repository's English documentation files are linked throughout these pages for complete configuration details and API reference.

Features

• World-space text, item displays, buttons, hover feedback, cursor styles, click animations, and tooltips.
• Chat input fields, toggles, permissions, click requirements, cooldowns, and per-player element states.
• Reusable templates, item slots, player avatars, and personal Sponge schematic previews.
• Per-menu controls for menu visibility, player visibility, and damage caused by other players.
• Built-in optional Vault and LuckPerms integrations, plus optional PlaceholderAPI, FancyNpcs, SkinsRestorer, and CraftEngine support.
• Public Java API for actions, data providers, conditions, and custom components.

Requirements

• Minecraft 1.21.1 or newer on Paper or a compatible server.
• PacketEvents 2.14.0 is required.
• Use the Java runtime required by your Minecraft/server build. UIcore uses Java 17 bytecode.
• On Folia, keep every menu scene within the camera's region.

Project

• Source repository
• Release 1.0.0
• License: AGPL-3.0
• Original project: CustomScreenMenu by wuhaoxian123, included with the author's permission.