Getting Started

Overview

mineHud is a custom boss-bar HUD plugin for Paper 1.21+ servers. It renders multi-panel HUDs on the boss bar using generated resource packs, supports PlaceholderAPI and MiniMessage, and includes a LuckPerms-style online editor hosted by mineCodes.

Features

Multi-panel HUD — multiple panels per HUD with anchors, row/column layouts, and offsets
Boss-bar rendering — custom font providers and shaders for pixel-precise placement
PlaceholderAPI — use any PlaceholderAPI placeholder in HUD text and conditions
MiniMessage — full MiniMessage formatting, including <font:small> compact text
Conditions & permissions — show or hide HUDs, panels, lines, and elements dynamically
Resource pack backends — auto, standalone, nexo, folder, and external
Soft reload — apply content/layout changes without regenerating the pack when possible
Online editor — web UI hosted by mineCodes with live apply over WebSocket
Developer API — public HudApi registered via Bukkit Services

Requirements

Java 21+
Paper 1.21+

Optional

PlaceholderAPI 2.11.6+ (placeholders and conditions)
Nexo (inject HUD assets into the Nexo resource pack)
Oraxen / ItemsAdder (use folder mode with external packs)

Installation

Download the latest mineHud-*-build.jar (or mineHud-<version>.jar) file
Place it in your server’s plugins/ folder
Start or restart the server
Edit the generated configuration files in plugins/mineHud/
Run /minehud reload to apply changes and regenerate the resource pack if needed

Configuration Files

After first startup, the following files are generated in plugins/mineHud/:

File	Description
`config.yaml`	Main plugin configuration (global settings, resource pack, editor bridge, HUDs)
`language.yaml`	All plugin messages with MiniMessage formatting

Quick Setup

Single server (standalone pack)

No extra setup is required. With resource-pack.mode: auto (default), mineHud uses standalone when Nexo is not present: it builds the pack and hosts it over HTTP.

enabled: true
resource-pack:
  mode: auto
  port: 8163

Players receive the pack automatically on join when the pack is ready.

With Nexo

Install Nexo and keep mode: auto (or set mode: nexo). mineHud injects HUD fonts/shaders into the Nexo pack.

resource-pack:
  mode: auto

Online editor

With default editor-bridge settings, open a session in-game:

/minehud editor

Open the chat link, edit the HUD in the browser, and click Zapisz na serwerze to apply.

Next Steps

Page	Description
Commands	Player and admin commands with permissions
Configuration	Full `config.yaml` and `language.yaml` reference
Panels & Layout	Anchors, panels, lines, elements, conditions
Resource Pack	Pack backends, hosting, and reload behavior
Online Editor	Web editor and editor-bridge setup
Developer API	Public `HudApi` for integrations