Hytale Ui Modding

Project conventions

• .ui base path: Common/UI/Custom/. Relative paths inside .ui are resolved from the file location.
• Use %translation.key in .ui and add the key to the language files under src/main/resources/Server/Languages.
• Use MultipleHUD for multiple HUDs per player. Do not rely on a single CustomUIHud instance.

Official documentation

• https://hytalemodding.dev/en/docs/official-documentation/custom-ui/common-styling
• https://hytalemodding.dev/en/docs/official-documentation/custom-ui/layout
• https://hytalemodding.dev/en/docs/official-documentation/custom-ui/markup
• https://hytalemodding.dev/en/docs/official-documentation/custom-ui/type-documentation

Notes on recent doc updates

• The official type documentation is a generated index. Use it when you need the exact property name, type, or enum values for an element.

• Common.ui is the preferred source for cohesive styling. Import it and reference styles instead of duplicating them.

• TabNavigation Known Issue: The default styles for TabNavigation in Common.ui are broken. See references/tab-navigation.md for details and workarounds.

Item HUD UI Support

CustomUIHud can now be attached to any item, not just players. This enables per-item HUDs that display when a specific item is held or active. Use the normal CustomUIHud API and associate the HUD with the item's lifecycle events.

Key use cases:

• Charge bar / cooldown indicator shown while holding a specific weapon
• Ammo counter rendered when a bow or gun is in hand
• Item-specific ability status overlays