Installing
🌎 Choose language: EN — English · RU — Русский
A server-side HUD engine for Paper and Folia. Players install nothing: the plugin builds a resource pack, the server sends it, and the HUD appears. There are no required dependencies; PlaceholderAPI is used if present and ignored if not.
1. Put the jar in plugins/ and start the server. On first start the plugin writes an example HUD
into plugins/HUDEngine/ and compiles it, so there is something on screen before you configure
anything.
2. The plugin creates its own HUDEngine folder, and build/HUDEngine.zip appears inside it —
that is the compiled resource pack. It is not sent to players yet: how it gets to them is your choice,
and it is covered on Resource pack.
To check the plugin works without setting up delivery at all, drop that archive into
.minecraft/resourcepacks, enable it in the client, and join the server. It is an ordinary resource
pack, no different from what a player would receive.
3. Now start on the YAML configuration, which the rest of this wiki covers. After an edit, run
/hudengine reload.
A reload picks up every HUD config — huds/, layouts/, images/, texts/, heads/, compasses/,
points/ — and from config.yml the whole pack section, hide-vanilla-hud, huds.default,
compass and language.
A server restart is only needed for huds.tick-period, huds.disable-for-bedrock, skins,
resource-pack and metrics, which are read once at startup.
Note: text and X positions update immediately, while images, fonts and Y positions need a new resource pack, which means the player has to rejoin. Horizontal placement is worked out as the HUD is drawn; the vertical position is baked into the pack's own font.
Adding a character to a pattern that the HUD did not use before — writing something in Russian for
the first time, say — also means a new pack: the old one carries no glyph for it.
| Page | What is on it |
|---|---|
| How a HUD is built | building a HUD of your own, start to finish |
| Fonts | using your own TTF, and which fonts survive eight pixels |
| config.yml | every option the plugin itself takes |
| Resource pack | getting the pack to players, hiding the vanilla HUD |
| Boss bars | sharing the screen with other plugins that use boss bars |
| Commands | commands and permissions |
| Performance | what costs what, and the one setting worth touching |
| Coming from BetterHud | what carries over and what does not |
| Troubleshooting | what the errors mean |
| API | publishing values and compass points from your own plugin |