GUI Compass Mod Wiki › FAQ
GUI Compass Mod FAQ
10 questions players actually ask, answered.
How do I turn on the compass HUD?
Carry a compass in your inventory and the direction and coordinate readout appears automatically in the top-left corner. If nothing shows up, check that mustHaveCompassInInventory is enabled and that you actually have a compass somewhere in your inventory, not just in a chest.
Does the compass HUD work in the Nether or End?
The coordinate and facing readout works in any dimension since it just reads your position and look direction. Note that a vanilla compass spins randomly outside the Overworld, but the mod's text display is unaffected by that.
Why does my compass HUD disappear when I drop my compass?
That's the mustHaveCompassInInventory setting doing its job. Turn it off in the config if you want the readout to stay visible even without a compass in your inventory.
How do I move the compass text to a different corner?
Use the compassPositionIsLeft, compassPositionIsCenter, and compassPositionIsRight settings to pick the horizontal placement, then adjust compassHeightOffset to slide it up or down. This is the usual fix when the readout overlaps other HUD elements.
Can I change what the compass HUD displays?
Yes, the guiCompassFormat setting controls which pieces appear, such as facing direction and the X, Y, and Z coordinates. Edit the format string to include only the values you care about.
How do I change the color of the compass text?
Set the RGB_R, RGB_G, and RGB_B values in the config to your preferred color. If the text is hard to read against bright terrain, also try toggling drawTextShadow on.
The compass text is invisible or blends into the background, how do I fix it?
Enable drawTextShadow and pick a text color that contrasts with the terrain behind it. Moving the readout with compassHeightOffset or the position settings can also get it away from busy parts of the screen.
Does the compass HUD work in multiplayer servers?
Yes, the mod runs client-side, so it displays your own position and direction on any server you join. You don't need the server to have the mod installed for the HUD to appear.
Will this mod hurt my FPS or cause lag?
No, it only draws a small amount of text each frame, so the performance impact is negligible. If you're already struggling for frames, disabling drawTextShadow removes one extra text pass.
Is the compass HUD compatible with other HUD mods like minimaps or info overlays?
It generally coexists fine with other HUD mods, but overlapping elements are common. Use compassPositionIsLeft/Center/Right and compassHeightOffset to nudge the readout clear of minimaps, hotbars, or status bars.