{"id":23108497,"url":"https://github.com/adamraichu/compass3d","last_synced_at":"2026-04-26T23:31:49.251Z","repository":{"id":163258620,"uuid":"638635892","full_name":"AdamRaichu/Compass3D","owner":"AdamRaichu","description":"A small fabric mod that displays an icon showing the y-axis direction of a compass in a slot.","archived":false,"fork":false,"pushed_at":"2024-04-23T20:35:02.000Z","size":1293,"stargazers_count":1,"open_issues_count":1,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2026-01-21T08:49:40.861Z","etag":null,"topics":["fabricmc","minecraft-mod","minecraft-resourcepack"],"latest_commit_sha":null,"homepage":"","language":"Java","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":"BVengo/simple-shulker-preview","license":"lgpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/AdamRaichu.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null}},"created_at":"2023-05-09T19:17:39.000Z","updated_at":"2024-04-23T20:33:15.000Z","dependencies_parsed_at":"2024-04-20T15:37:58.293Z","dependency_job_id":"17599106-51d2-4249-a4c5-7ce673c4e0ff","html_url":"https://github.com/AdamRaichu/Compass3D","commit_stats":null,"previous_names":[],"tags_count":15,"template":false,"template_full_name":null,"purl":"pkg:github/AdamRaichu/Compass3D","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AdamRaichu%2FCompass3D","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AdamRaichu%2FCompass3D/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AdamRaichu%2FCompass3D/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AdamRaichu%2FCompass3D/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/AdamRaichu","download_url":"https://codeload.github.com/AdamRaichu/Compass3D/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AdamRaichu%2FCompass3D/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":32317163,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-26T23:26:28.701Z","status":"ssl_error","status_checked_at":"2026-04-26T23:26:25.802Z","response_time":129,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["fabricmc","minecraft-mod","minecraft-resourcepack"],"created_at":"2024-12-17T01:27:39.126Z","updated_at":"2026-04-26T23:31:49.234Z","avatar_url":"https://github.com/AdamRaichu.png","language":"Java","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Compass3D\n\n[![Modrinth Downloads](https://img.shields.io/modrinth/dt/compass3d?logo=modrinth)](https://modrinth.com/mod/compass3d)\n[![CurseForge Downloads](https://img.shields.io/curseforge/dt/971238?logo=curseforge)](https://www.curseforge.com/minecraft/mc-mods/compass3d)\n\nThis mod renders an arrow over compasses in the inventory/hotbar. This arrow points up or down, showing you which direction (on the Y axis) you need to travel to reach the coordinate.\n\nAs of `v2.0.0`, this also applies to compasses placed in Item Frames. These arrows have their own configs for placement. This features works by default with all compasses except the Recovery Compass. You can install another mod [Framed Recovery Compass Fix](https://github.com/AdamRaichu/framed-recovery-compass-fix) to make it work.\n\nI had the idea for this mod when working on the tracking compass for my [Server Side Commands](https://modrinth.com/mod/server-side-commands) mod.\nI realized that you had no way to determine the Y value of the coordinates of a compass.\nSo, I did some research, and found the mod [Simple Shulker Preview](https://github.com/BVengo/simple-shulker-preview), which did something similar to what I wanted, and forked it. *That project was under the LGPL-3.0 license so click [here](https://github.com/AdamRaichu/Compass3D/blob/main/LGPL_CHANGES.md) for a list of the changes I made*.\n\nThis mod also supports several mods. See the [Mod Support List](https://github.com/AdamRaichu/Compass3D/issues/2) for a list of supported mods, or to suggest new mods to support.\n\n\u003c!-- markdownlint-disable MD033 MD045 --\u003e\n\n\u003cimg src=\"https://raw.githubusercontent.com/Jab125/Jab125/main/imgs/requiredClothConfig.png\" width=\"300\" height=\"100\"\u003e\n\n## Configs\n\nThis mod gives you the ability to configure the size and placement of arrows, as well as the arrow type for each supported compass. The config menu is fairly self-explanatory, so I will not elaborate on that further here.\n\n~~This mod comes with the [Cloth Config API](https://www.curseforge.com/minecraft/mc-mods/cloth-config) built in to\nimplement configs (there should be no need to download it yourself).~~ **You need to install [Cloth Config API](https://www.curseforge.com/minecraft/mc-mods/cloth-config) in order for this project to work.** I would recommend installing [ModMenu](https://www.curseforge.com/minecraft/mc-mods/modmenu) alongside it if you actually want to use them though, because I didn't want to create yet another config mapping for such a simple mod.\n\n## Resource Pack\n\nI made a couple resource packs with alternate icons if you want. You can download them [here][alternate-icons].\n\nIf you don't like the textures and want to make a resource pack to change them, here are the paths to the textures.\nPlease let me know if you do (via a GitHub issue) so I can link them there.\n\n- `assets/compass3d/textures/item/up_arrow.png`\n- `assets/compass3d/textures/item/down_arrow.png`\n- `assets/compass3d/textures/item/recovery_up_arrow.png`\n- `assets/compass3d/textures/item/recovery_down_arrow.png`\n\nThere are also other arrows for modded compasses. Check the directory on GitHub to see them all.\n\n## What is the item `compass3d:*_arrow`?\n\nSo to add the arrow overlays, I had to register a nonexistent item on the client side.\nHowever, I discovered in testing that it shows up in autocomplete when doing `/give`.\nThis generates an error when used in multiplayer, but as the item doesn't exist you shouldn't worry about it.\n\n[alternate-icons]: https://modrinth.com/resourcepack/compass3d-alternate-icons\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fadamraichu%2Fcompass3d","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fadamraichu%2Fcompass3d","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fadamraichu%2Fcompass3d/lists"}