Repository navigation
Installation
Language: English | Русская версия
- 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 selected Minecraft/server build. UIcore's plugin and API use Java 17 bytecode.
- PlaceholderAPI, FancyNpcs, SkinsRestorer, CraftEngine, Vault, and LuckPerms are optional.
- Stop the server.
- Download
UIcore-1.0.0.jarfrom the GitHub release. - Place UIcore and PacketEvents in the server's
plugins/directory. - Start the server. UIcore creates its configuration and example menus in
plugins/UIcore/menu/. - Stand in an open area and run
/uicore run demo_main. Close with/uicore stop.
Create a .yml file in plugins/UIcore/menu/. Start with camera-position.type: player, then run /uicore reload after editing. The three demo_* menus show working examples and are installed automatically on a fresh server.
Read the complete English installation guide and menu authoring guide. The latter covers coordinates, element types, input, states, templates, slots, permissions, and schematic previews.
Console commands triggered by a menu are disabled by default. If required, enable them and set an explicit command allowlist in config.yml.
Keep all elements in one menu scene within the camera region. If a scene crosses a region boundary, move the camera or reduce the distance to the elements.
Stop the server before replacing the JAR. Back up YAML files and schematics. Replace only UIcore; don't overwrite your configs with archive examples. After startup, test menus, clicks, navigation, /uicore stop, and the server log.