Description
A client-side mod that allows displaying various "info lines" on the screen ("mini-F3"). The alignment (screen corner), background and text color and font size are configurable. Note: This is a client-side-only mod! You can't put it on a server.
The mod also has various "overlay renderers", such as:
- Structure Bounding Boxes (These only work in single player, without a server-side mod! Currently the only server-side mods that send the data in a format that MiniHUD knows about are Servux and QuickCarpet. If you have FabricCarpet, then you also need Servux.
- Spawn Chunks
- Light Level overlay with markers and/or numbers (configurable)
- Region File Boundaries
- Random Tick range
- Shapes: A mob Despawn Sphere, plus 24 and 32 block Spawn Spheres, a generic configurable radius Sphere, a Circle/Cylinder. More shapes are also planned.
- Block Grid
- Mob spawn algorithm chunks range (< 1.14 only, in 1.14+ it's the same as the random ticked chunks)
- Height map (used by the mob spawn algorithm)
(note that many of these currently are only available in the more recent LiteLoader, Rift and Fabric versions.)
The mod also adds hotkeys for toggling on/off the vanilla debug renderers for blocks collision boxes, heightmap, entity path finding etc.
The displayed information lines can also be toggled on/off with hotkeys, and the HUD itself can be toggled ON and OFF.
Some example screenshots are on the Images page.
Generic info
- The default in-game config menu hotkey is H + C
- The default on/off toggle key is H
- You can provide the world seed for MiniHUD (only used for the Slime Chunks info line and overlay) in multiplayer either by running the vanilla /seed command if you have the permission, or you can give it manually with a regular chat message in the form minihud-seed 12345. In single player the mod grabs the seed directly.
NOTE: MiniHUD also requires the MaLiLib library mod.
Be sure to download the correct version of both mods from the Files page!
https://www.curseforge.com/minecraft/mc-mods/malilib
Overlay colors are all opaque, what to do?!
In the current 0.19.0-dev versions for MC 1.16+, there are a bunch of features that are temporarily ported over from the main development version on 1.12.2. Due to it being a temporary port, I didn't bother trying to fix everything that is broken due to there being missing things in malilib, and there is currently also a bug in malilib's Color Edit menu in 1.13.2+ which causes the alpha channel (transparency) to reset to fully opaque when you use the Color Editor menu.
So currently, until the new malilib and other mod updates with the latest code from 1.12.2 can happen, you just have to manually fix the color value after using the color editor. Basically you just need to change the first two letters (after the #) in the hex color code from FF (fully opaque) to something between 30 to 60 or so, and then toggle off/on the overlay or shape in question to update it.
Different mod loaders vs. mod versions
Be sure to download the correct version for the mod loader you are using!
The newer builds will all include the mod loader name in the mod filename.
(Also note that the 1.13.2 versions ONLY work on MC 1.13.2, and NOT on the earlier 1.13 versions!)
For MC 1.14.x there are currently versions for the Fabric mod loader, those versions have '-fabric' in their filename.
Future Forge versions will also include -forge in the mod file name.
Key combinations
The mod's main rendering toggle key is by default H.
The in-game config menu hotkey is by default H + C.
Recent MiniHUD versions that use malilib
For the more recent versions of MiniHUD that use malilib, all the hotkeys are in MiniHUD's own in-game config menu, which by default opens with H + C.
Old Forge versions of MiniHUD
For the old Forge versions of the mod, the keybinds can be changed in the vanilla Controls menu.
For the old Forge versions:
- Toggle Mode key (by itself): Toggle the HUD state ON/OFF.
- Toggle Mode key + "info key": Toggle ON/OFF the different pieces of information (the keys can be set in the mod configs).
Available information
NOTE: The information below this is outdated and doesn't include everything that is in the recent LiteLoader, Rift and Fabric versions of the mod.
Look through the in-game config menu to see everything that is available in addition to the things mentioned below.
The following information is currently available:
- Real time (ie. a clock...)
- World time in ticks
- World time formatted to days, hours, minutes
- Player's current block position
- Player's current position in chunk
- Player's coordinates
- Player's current dimension ID
- Player's yaw rotation
- Player's pitch rotation
- Player's current moving speed
- Player's facing
- The Chunk the player is currently in
- The region file the player is currently in
- Looked-at-entity's name and health
- Looked-at-entity's registry name (1.11+) or ID (1.10.2)
- The block the player is looking at
- Block's registry name and the BlockState properties of the looked-at-block (like on the F3 screen)
- Current light level
- Current biome
- Current biome's registry name.
- Current FPS
- Entity count
- C value (rendered chunk sections) from F3
- P value (number of particles) from F3
- Current local difficulty number (from F3)
- Is the current chunk a slime chunk. Note: in multiplayer you need to manually run the /seed command!
Starting from version 0.13.0, there is now a region file boundary overlay renderer. The default hotkey to toggle it ON/OFF is Toggle (H) + J.
Note: Starting from version 0.9.0, you can change all these quick toggle keys via the config file or the in-game config menu.
Note: Starting from version 0.11.0, you can change the order of these info lines via the config file or the in-game config menu.
To temporarily (= not saved in the configs) toggle the info types while in-game, do this:
- In version 0.9.0 or later, press and hold the main Toggle key, and then press the configured hotkey for the info type you want to toggle
- Before version 0.9.0, first press and hold the indicated info type key and then press the Toggle key
Old Configuration options
Below are the bit mask values for the different information types. This is now redundant, just use the on/off options in the in-game config menu instead!
These were removed entirely in version 0.11.0.
- 1 = coordinates
- 2 = yaw
- 4 = pitch
- 8 = speed
- 16 = biome
- 32 = light level
- 64 = facing
- 128 = block position
- 256 = chunk position
- 512 = block looking at
- 1024 = fps
- 2048 = entity count
- 4096 = dimension id
- 8192 = world time (ticks)
- 16384 = world time (formatted)
- 32768 = IRL time (ie. a clock)
- 65536 = looking at entity
- 131072 = slime chunk
- 262144 = blockstate properties
Configuration
There are a few things that can be adjusted either via the in-game configuration menu or in the configuration file.
- The information to be displayed on the Info Lines HUD
- Font scale factor
- The font and backgrond colors
- Whether to use a font shadow in the text rendering
- Whether to use a background color for the text
- Whether to sort the displayed information lines by their length
- Whether to reverse the above mentioned sorting order
- Whether to use a custom format string for the coordinate line, and the format string to use
- Multiple options to configure the Light Level overlay
- The colors of all the overlay renderers
Note: The custom format string for the coordinates has to have three float number format specifiers.
An example of that would be "X: %.1f Y: %.1f Z: %.1f" (without the quotes) to give an output like: X: 1234.2 Y: 64.0 Z: 4321.7.
Vanilla debug renderers
Starting from mod version 0.12.0, there are hotkeys to toggle ON/OFF the debug renderers that exist in vanilla, but are normally not usable/accessible. The hotkeys for these can be set in the Hotkeys config category. Note: The neighbor updates debug renderer only works in single player.
Note: The pathfinding debug renderer also only works in single player, unless another mod sends the appropriate custom payload vanilla packet from the server, to add the path data to the debug renderer. Currently I'm not aware of any such mods however.
Some example screenshots of the debug renderers: Collision boxes: 
Height map: 
Neighbor updates: 
Pathfinding: 
Solid block faces: 
Water: 
Snapshot versions and latest development builds
There are (at least at times) versions of my mods available for the latest Minecraft snapshots here: https://masa.dy.fi/mcmods/client_mods/
That page also sometimes includes newer development builds than what is available here on CurseForge.
If you encounter bugs, then try to update all the mods (from the ones that you use) from that page to see if the issue has been fixed already.
(There are at times changes in malilib or the mods that require both of them to be updated at the same time!)
If you have questions or need help with something, the best/fastest way to get answers is on my Discord server.
Hi, firstly minihud is OP and a must have mod for anyone...
Just wondered is there a hotkey option to add seed yet?? Or is it still just chat way still. And is /minihud-seed possible on 1.19.2 version.
Apologies if asked already
In reply to phoenixjoe69:
There is no hotkey for that. There will likely be an "action" for it in the new code, which would then also allow you to assign a custom hotkey for that action, but there won't be a default hotkey for that, as it's not really needed or used that often.
And yes both the slash version and the non-slash version should work in 1.19.2. Although I can't remember for 100% sure if I tested it... If you are worried about sending it to the server, you can test it in single player (although the mod will also grab the seed directly in single player, but it will still also handle the chat "commands" as well and should produce the "seed set" message if it recognizes it).
In reply to masady:
Yeah I tested in survival first and slash command worked fine on 1.19.2 👍
Thabks for the help
Great little mod.
Would it be possible to add the option to show the current shaderpack in use for Iris?
(So when you take screenshots you know which shaderpack you used)
The BetterF3 mod has this feature in the "Right Misc" module but that has a few disadvantages:
- it's annoying having to press F3
- it's not clean, other information is showing alongside with it
In reply to smallpotat2:
That would then introduce some form of (soft) dependency to Iris. In general I try to avoid things that adds dependencies to other mods, as it adds extra maintenance overhead and complicates the development environment setup. But I could probably also just use some reflection or Mixin hacks to avoid the dependency... so maybe(?) I'll add it to the todo list so that I don't forget about it immediately, so maybe it will get added at some point.
Is there a way to get the minecraft time into a 12 hour format instead of the 24?
In reply to poseidon104:
No I don't think there was for the MC time. You can only format the IRL time to 12-hour format (or any format you like really).
Can u add the colours settings for all hud mods like fps display and stuff make a extra colour settings for everythibg because it looks bad when u use only red for like cords or so many people will like it pls add it!!!!!!!!!!!!!!!!!!!!
In reply to Sonic0Mc:
This is planned when I rewrite all the info overlay stuff to be fully customizable. It won't be added to the current old code version, as it would need a stupid amount of separate color settings and would just be a total mess. So it will come at some point when the rewrite version from 1.12.2 gets worked on and gets ported forward.
the forge version of this mod only says "forge" instead of the game version. does that mean it works with every version?
In reply to that1kirby:
No. And do you mean the old 0.13.1 version or which version? That is for MC 1.12.2. There are no Forge versions of MiniHUD for 1.16 or later at this point. But there will be Forge ports again at some point when things with the mod rewrites are ready.
Is there any FAQ or documentation on how to use the shapes and renders?
In reply to BinBash7:
No not really. They are pretty simple for the most part, you just turn them on, and then for the shapes you use their per-shape config menus to set the position, size etc.
One confusion some new users face is that some of the renderers need multiple different toggles to be enabled before anything renders. Mostly this is for the structure bounding boxes renderer, which needs the MiniHUD main rendering (H) to be on (like does every other renderer), and then it needs the overlayStructureMainToggle to be on (from the Renderers category), and then the individual structure types you want to see, from the Structures category. And on top of this the structure renderer needs the structure data from the server, which means that it only works either in single player, or on servers that have the Servux mod installed to send the structure data when MiniHUD requests for it.
For the shapes you need the main rendering (H) on, and then the shapeRenderer on (from Renderers), and then you go to the Shapes tab and create, configure and enable your shapes as needed.
All other renderers (as far as I can remember) only need their enable toggle option in Renderers turned on for them to start rendering stuff. For slime chunks you need to input the seed for the mod if you are on a server, and the slime chunk overlay top y position is kinda finicky, it's supposed to be set to the player's y position when you turn it on, but in older versions that didn't happen if you turned it on via the menu directly, it only got set if you used the hotkey too toggle it on. I fixed that in the latest 1.19.2 version. You can also adjust that position/height by holding the toggle hotkey and scrolling with the mouse (it doesn't represent spawning height, it's just so that you can adjust the overlay to be visible but not annoying like going all the way to the world height).
Hey There,
Wondering if you have any plans of making a version for Forge 1.19.2? i have other forge mods i use, so cant switch over unfortunately.
If not all good though :)
Thanks
In reply to Ace_Of_Skulls11:
The Forge port plans paragraph here applies to all my client mods: https://www.curseforge.com/minecraft/mc-mods/litematica-forge
So basically: planned, but no ETA.
Is there a forge version? Or am I being blind?
In reply to Arclightning7854:
Not yet. See my other reply just above.
Hi, this question is asked before but I couldn't see a proper answer. So, I'm using optifine and I can't see some info because they merge. Overall, if I want to relocate the info on the screen how can I do it? I want them to be lower and I want FPS to be the lowest. Can you help? Thanks for your attention.
Image can be found here: https://prnt.sc/8kACzrBa2xyo
In reply to abynrts_:
You can use the Generic -> textPosY option to add some vertical offset to the info lines HUD. And you can use the numeric "line order" configs in the Info Lines category to re-order the info lines. Those are basically just a numeric sort order for the lines, so smaller values come first/on top.
Hey, using this all the time. Mostly for light levels and info lines.
Would it be possible to make "positioning" for the info lines? E.g I want the FPS to be at the bottom, the time at the top and the biome above the coordinates.
I can fix it in code but it would be nice to have it in the graphic settings instead.
Image for attention, it shows how it is without editing the files.