Skip to content
◆ TTS-STUDIO docs Discord

Plugins / HudForge

Pictures in the HUD

A logo in the TAB header, an icon before a sidebar line, a badge in a boss bar: HudForge draws pictures anywhere a line goes, from plain .png files, with no resource pack to build by hand.

How it works

Drop a .png into plugins/HudForge/images/ and write <img:name> in any line, where name is the file name without .png, in lower case (letters, digits, - and _). At start, and on /hud reload, the plugin builds a resource pack in which every picture is a glyph of its own font (hudforge:images), and the tag becomes that glyph. /hud images lists what was found.

A picture draws at height text pixels tall. 8 is one line of text; a header logo can take 16 or 32. ascent is how far above the text baseline it sits (height - 1 keeps it on the line). Set them per picture:

images:
  logo: {height: 24, ascent: 20}
  coin: {height: 8, ascent: 7}

Getting the pack to players

resource-pack:
  mode: self-host        # off | self-host | export
  host: "play.example.com"
  port: 8140
  prompt: ""
  required: false
  export-to: ""

self-host: the plugin serves the pack on port and adds it to every player on join. host must be the public address players connect with (an IP or a domain); open the port in your firewall. On 1.20.3+ the pack is added on top of whatever pack the server already sends, so it does not replace it. The zip is also written to plugins/HudForge/resourcepack/ in case you want to host it elsewhere.

export: the pack files are written into export-to, for the pack plugin you already run to merge them. For ItemsAdder: plugins/ItemsAdder/contents/hudforge/resourcepack, then /ia zip. For Nexo or Oraxen, their pack folder. Use this when another plugin already sends a pack and some of your clients are older than 1.20.3.

Old clients

Players on 1.8–1.20.2 clients (through ViaVersion) cannot draw glyphs. Gate the tag on the client's protocol, as with <lang_or>:

title: "%if:%hud_protocol%<765?<gold><bold>MY SERVER:<img:logo>%"

Keep reading