MC-WIKI.net
MiniHUD Wiki › Guides › MiniHUD Setup Guide: Config GUI, Rendering Toggle, and Basic HUD

MiniHUD Setup Guide: Config GUI, Rendering Toggle, and Basic HUD

guide

MiniHUD is a configurable "mini-F3" mod that adds info lines and various overlay renderers to your screen. This guide covers opening its config GUI, using the master rendering switch, and setting up the basic HUD.

Opening the Config GUI

MiniHUD is operated entirely through its interface and hotkeys — there is nothing to craft. The mod provides an openConfigGui action: a hotkey that opens the in-game Config GUI. Assign it in the controls menu, then press it whenever you want to change settings.

Inside the GUI you will find the mod's features and settings, including everything related to the info lines, the overlay renderers, and the shape renderer.

The Main Rendering Toggle

The mainRenderingToggle is the master switch for all MiniHUD rendering. It controls the info lines and every overlay renderer at once. If your HUD or overlays suddenly disappear, check this toggle first — it overrides everything else.

Setting Up the Info Line HUD

The info line HUD is the text block that shows selected data lines. Several settings shape how it looks and when it appears:

  • hudAlignment — where the info line HUD sits on the screen.
  • textPosX and textPosY — the text's horizontal and vertical distance from the screen edge (both default to 4).
  • fontScale — the size factor for the HUD text (default 0.5).
  • textColor and textBackgroundColor — the color of the info line text and of its background.
  • useTextBackground — draws a solid color behind the text.
  • sortLinesByLength and sortLinesReversed — sort the lines by text length, and reverse that order.
  • requireSneak — only show the info line HUD while you are sneaking.
  • requiredKey — only show the HUD while a chosen key is held.
  • hudStatusEffectsShift — shifts text lines rendered at the top right while status effects are active, so the effects do not cover the text.
  • offsetSubtitleHud — when the HUD is in the bottom right and subtitles are on, moves the subtitles above the info line text.

You choose which lines appear through the individual info toggles, such as infoCoordinates, infoFPS, infoBiome, infoLightLevel, infoTimeWorld, and many others. Each toggle adds or removes its own line. Some lines depend on server-side data from single player or Servux, and some require operator privileges on a server.

Overlay Renderers

Overlays are separate from the info lines and each has its own toggle, including:

  • overlayLightLevel — the Light Level overlay renderer.
  • overlaySlimeChunks — the Slime Chunk overlay renderer.
  • overlayBiomeBorder — the Biome Border overlay renderer.
  • overlayBlockGrid — the Block Grid overlay renderer.
  • overlayBeaconRange and overlayConduitRange — the Beacon Range and Conduit Range overlays.
  • overlayRegionFile — the region file border overlay.
  • overlaySpawnChunkReal and overlaySpawnChunkPlayer — the real and player-following spawn chunk overlays.
  • overlayStructureMainToggle — the main switch for all structure bounding boxes.
  • overlayVillagerInfo — the villager info render.
  • shapeRenderer — the main toggle for the shape renderer.

Many overlays have matching color settings, so you can recolor each one to taste.

Hotkeys and the Controls Menu

MiniHUD exposes several named actions you can bind in the controls menu:

  • openConfigGui — opens the Config GUI.
  • setDistanceReferencePoint — stores your current position as the reference point used by the distance info line.
  • inventoryPreview — the key that activates the inventory preview feature.
  • moveShapeToPlayer — moves the selected shape to your current location.
  • shapeEditor — opens the Shape Editor GUI for the selected shape.

The mod also groups its bindable actions into Info Toggle hotkeys, Renderer Toggle hotkeys, and Structure Toggle hotkeys.

Quick Start

  1. Bind openConfigGui in the controls menu and open the GUI.
  2. Confirm mainRenderingToggle is on.
  3. Pick the info lines you want with their toggles.
  4. Adjust hudAlignment, textPosX, textPosY, and fontScale until the HUD sits where you like.
  5. Enable any overlay renderers you need, then tune their colors.