https://github.com/serilum/gui-compass

🧭 [Client] Shows direction and coordinates in the GUI/HUD with a compass in the inventory.
https://github.com/serilum/gui-compass

curseforge fabric forge gui-compass minecraft mod modding modrinth natamus neoforge quilt rick-south serilum

Last synced: 3 months ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/serilum/gui-compass
• Owner: Serilum
• License: other
• Created: 2023-12-12T09:01:13.000Z (over 1 year ago)
• Default Branch: 1.21.4
• Last Pushed: 2024-12-06T12:30:14.000Z (6 months ago)
• Last Synced: 2025-02-23T02:33:31.663Z (3 months ago)
• Topics: curseforge, fabric, forge, gui-compass, minecraft, mod, modding, modrinth, natamus, neoforge, quilt, rick-south, serilum
• Language: Java
• Homepage: https://serilum.com/mod/gui-compass
• Size: 188 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: readme.md
  • Funding: .github/funding.yml
  • License: license.md

Awesome Lists containing this project

README

        
GUI Compass

Download

You can download GUI Compass on CurseForge and Modrinth:
  CurseForge:   https://curseforge.com/minecraft/mc-mods/gui-compass
  Modrinth:      https://modrinth.com/mod/gui-compass

Issue Tracker

To keep a better overview of all mods, the issue tracker is located in a separate repository.
  For issues, ideas, suggestions or anything else, please follow this link:

    -> Issue Tracker

Pull Requests

Because of the way mod loader files are bundled into one jar, some extra information is needed to do a PR.
  A wiki page entry about it is available here:

    -> Pull Request Information

Mod Description



   

Requires the library mod Collective.

   This mod is part of The Vanilla Experience modpack and Serilum's Client Bundle mod.
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.

drawTextShadow (default = true): If the text displayed should have a shadow drawn below it.
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 CurseForge or 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!