project - icon

GUI Compass

Client mod

🧭 Shows direction and coordinates in the GUI/HUD with a compass in the inventory.

AdventureManagementUtility

118 downloads 5 followers
Created a month ago
Updated 4 days ago

External resources



Project members

profile-picture

Owner


Technical information

License
Client side
required
Server side
optional
Project ID
ZORMkttv



Requires the library mod Collective.

     This mod is part of The Vanilla Experience.
GUI Compass is a minimalistic configurable client-side mod which shows the direction and coordinates in the GUI with a compass in the inventory. By default the compass is positioned in the top left, but you can change that and the height in the config.

The format of what is visible on the screen can be changed via the 'guiCompassFormat' config value.



Default format: Direction: X, Y, Z

You may also be interested in GUI Clock.


Configurable: ( how do I configure? )
guiCompassFormat (default = "FXYZ"): What of the GUI compass should be displayed. Default: [FXYZ]. F: facing (direction), X: x coord, Y: y coord (depth), Z: z coord.
mustHaveCompassInInventory
 (default = true): When enabled, will only show the GUI compass when a compass is present in the inventory.

compassPositionIsLeft (default = true): Places the GUI compass on the left.
compassPositionIsCenter (default = false): Places the GUI compass in the middle.
compassPositionIsRight (default = false): Places the GUI compass on the right.

compassHeightOffset
 (default = 5, min 0, max 3000): The vertical offset (y coord) for the Compass. This determines how far down the coordinates and direction should be on the screen. Can be changed to prevent GUIs from overlapping.

RGB_R (default = 255, min 0, max 255): The red RGB value for the compass.
RGB_G (default = 255, min 0, max 255): The green RGB value for the compass.
RGB_B (default = 255, min 0, max 255): The blue RGB value for the compass.


Example of the compass while rotating the player:


------------------

You may freely use this mod in any modpack, as long as the download remains hosted within the Modrinth ecosystem.

Serilum.com contains an overview and more information on all mods available.

Comments are disabled as I'm unable to keep track of all the separate pages on each mod.
For issues, ideas, suggestions or anything else there is the Github repo. Thanks!