> For the complete documentation index, see [llms.txt](https://lethium.gitbook.io/lethium-docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://lethium.gitbook.io/lethium-docs/server-setup/betterhud.md). # BetterHud: the on-screen display The on-screen HUD (health, pets, Echoes, abilities, top panels) and the mob health popup. Files: `plugins/BetterHud/config.yml`, `huds/`, `layouts/`, `images/`, `popups/`, `assets/` (the PNG pictures). Reload with `/hud reload` (BetterHud's reload command) and rebuild the pack, see below. BetterHud draws the **Java HUD**: a custom health bar, hunger, armor, air, and ClickEm panels. **Bedrock players do not get it** (`disable-to-bedrock-player: true`). They see the TAB scoreboard instead. See [TAB](/lethium-docs/server-setup/tab.md). ### What is on screen The HUD (`huds/default-hud.yml`, `default_hud`) stacks these layouts: | Layout | Shows | | ---------------------------------------- | ------------------------------------------------------------------------------------------------------------------------ | | `hud_under`, `hud_top_left`, `top_right` | Panel backgrounds and the top panels: Profile Level and progress, Rebirth and progress, current zone and progress, Power | | `outline_head` | The player's head | | `health`, `armor`, `air`, `hunger` | The redrawn vanilla bars (the default hotbar is removed, `remove-default-hotbar: true`) | | `echoes` | Equipped Echoes and the element icon | | `pets` | Equipped pets: short name, level, Power, Coins and Essence | | `abilities` | The five ability slots with ready, cooling down, or not enough Fury icons | Each panel reads [ClickEm placeholders](/lethium-docs/placeholders.md): `combat_*`, `pet_*`, `echo_*`, `ability_*`, `profile_*`, `rebirth_*`, `zone_*`, `stat_damage_rounded` and the `hud_*` toggles. ### Letting players hide panels `/settings` has toggles for `hud-pets`, `hud-echoes`, `hud-location`, `hud-main` and `ability-hud`. ClickEm only **reports** them as `%clickem_hud_pets%` and so on. The HUD config uses them as a **condition** to draw or skip a panel. If you add a panel, add a matching condition. ### The mob health popup `popups/entity-popup.yml` (`entity_health_popup`) draws a **health popup over the mob** when a player attacks it. It lasts 20 ticks and rises 40 pixels over 3 ticks. It reads `%clickem_combat_target__*%`, where `n` is the popup index. `combat.hud-slot-memory-ms` in `mob-rewards.yml` must match how long the popup stays visible. See [Combat placeholders](/lethium-docs/placeholders/combat.md). ### Editing | I want to | Edit | | ------------------------ | ----------------------------------------------------------------------------------------------- | | Move a panel | The `x`, `y` of the layout in `huds/default-hud.yml` (percent of screen, `x: 100` = right edge) | | Change a panel's content | `layouts/default-layout.yml` (1100 lines) | | Add a picture | Put the PNG in `assets/` and declare it in `images/default-image.yml` | | Change the popup | `popups/entity-popup.yml`, `layouts/entity-layout.yml`, `images/entity-*.yml` | Ability picture names follow `a1_ability_ready.png`, `a1_ability_noready.png`, `a1_ability_nofury.png` (and `a2`, `u` for the ultimate, `p1`, `p2`). Element pictures are `fire_element.png`, `water_element.png`, `lightning_element.png`, `nature_element.png` (Earth), `wind_element.png` and `neutral_element.png`. ### Resource pack BetterHud builds its pack into `ItemsAdder/contents/BetterHud/resourcepack` (`build-folder-location`) so ItemsAdder can host it. After changing assets: 1. Reload BetterHud. 2. Run `/iazip` (see [ItemsAdder](/lethium-docs/server-setup/itemsadder.md)). 3. Players accept the pack again. ### Settings worth knowing | Setting | Value | | ---------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `number-format` | `#,###.#` | | `merge-boss-bar` | true. The HUD draws itself through a boss bar, so event boss bars can push it down. ClickEm's events settings `bossbar.join-delay-ticks` and `reanchor-ticks` exist to handle this. | | `default-hud` | `default_hud` | ### Troubleshooting * **Empty or wrong numbers:** the ClickEm placeholder returned empty. Test with `/papi parse me `. * **HUD missing:** the pack did not load, or the player is on Bedrock. * **HUD overlaps the event bar:** raise `events.yml` `announce.bossbar.reanchor-ticks`. * **Text cannot be translated:** BetterHud text is not covered by the LethiumLanguage translation pack. --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation by asking a question. Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters: ``` GET https://lethium.gitbook.io/lethium-docs/server-setup/betterhud.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.