{"id":33724885,"url":"https://github.com/sisby-folk/surveyor","last_synced_at":"2026-04-02T18:54:51.440Z","repository":{"id":221301547,"uuid":"753953753","full_name":"sisby-folk/surveyor","owner":"sisby-folk","description":"Unified API, networking, and save data for minecraft map mods.","archived":false,"fork":false,"pushed_at":"2025-11-27T05:19:53.000Z","size":1060,"stargazers_count":23,"open_issues_count":21,"forks_count":9,"subscribers_count":2,"default_branch":"1.20","last_synced_at":"2025-11-29T20:13:01.059Z","etag":null,"topics":["java","minecraft","modtoberfest"],"latest_commit_sha":null,"homepage":"https://modrinth.com/mod/surveyor","language":"Java","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"lgpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/sisby-folk.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","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,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2024-02-07T05:20:09.000Z","updated_at":"2025-11-27T04:51:26.000Z","dependencies_parsed_at":"2024-02-14T05:23:34.894Z","dependency_job_id":"7e944fa2-ec27-444b-93dc-39d3986988b8","html_url":"https://github.com/sisby-folk/surveyor","commit_stats":null,"previous_names":["sisby-folk/surveyor"],"tags_count":116,"template":false,"template_full_name":null,"purl":"pkg:github/sisby-folk/surveyor","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sisby-folk%2Fsurveyor","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sisby-folk%2Fsurveyor/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sisby-folk%2Fsurveyor/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sisby-folk%2Fsurveyor/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/sisby-folk","download_url":"https://codeload.github.com/sisby-folk/surveyor/tar.gz/refs/heads/1.20","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sisby-folk%2Fsurveyor/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":27499609,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-12-04T02:00:07.142Z","response_time":60,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"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":["java","minecraft","modtoberfest"],"created_at":"2025-12-04T11:04:19.496Z","updated_at":"2026-04-02T18:54:51.428Z","avatar_url":"https://github.com/sisby-folk.png","language":"Java","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003c!--suppress HtmlDeprecatedTag, XmlDeprecatedElement --\u003e\n\u003ccenter\u003e\n\u003cimg alt=\"surveyor banner\" src=\"https://cdn.modrinth.com/data/4KjqhPc9/images/036db8bcb021c9e81e18561698d45d3c7bb71127.png\"\u003e\u003cbr/\u003e\nAn open-source backend (and API) for world map and waypoint mods!\u003cbr/\u003e\n\u003cb\u003eRequires \u003ca href=\"https://modrinth.com/mod/connector\"\u003eConnector\u003c/a\u003e and \u003ca href=\"https://modrinth.com/mod/forgified-fabric-api\"\u003eFFAPI\u003c/a\u003e on (neo)forge.\u003cbr/\u003e\u003c/b\u003e\n\u003c/center\u003e\n\n---\n\n**Surveyor** is the **map backend** for mods like [Antique Atlas 4](https://modrinth.com/mod/antique-atlas-4), [Hoofprint](https://modrinth.com/mod/hoofprint), and [Via Romana](https://modrinth.com/mod/via-romana).\u003cbr/\u003e\nAlong with handling the generation and saving of map data like terrain and waypoints, Surveyor:\n- Shows other players on your map, even far away or in other dimensions!\n- Tracks your exploration, and will restore your map data from the server if it's lost or you change computers!\n- Enables **live map sharing** with other players of your choosing - terrain, waypoints, the lot!\n- Allows swapping map frontends any time without losing your map data!\n- Imports waypoints from Xaero's Minimap, and has integration for mods like [Waystones](https://modrinth.com/mod/surveystones) and [OPAC](https://modrinth.com/mod/surveyalot).\n- Is fully modular - so mods like [Dead Reckoning](https://modrinth.com/mod/dead-reckoning) can utilize waypoints without enabling terrain scanning.\n- Has builtin integration to sync with vanilla maps via sneak+using at a cartography table!\n\n![vanilla map integration preview](https://cdn.modrinth.com/data/4KjqhPc9/images/e888d799c43d38ff5665c39fc844286ee05d5ed0.png)\n\n### Commands\n\nIf you're a server admin or don't have a map frontend installed, surveyor comes with a few helpful commands:\n- `/surveyor` displays summary of how many chunks and structures you've explored, and waypoints recorded.\n- `/surveyor share [player]` and `/surveyor unshare` allows joining and leaving map sharing groups.\n- `/waypoints` allows viewing and editing your recorded waypoints.\n- `/landmarks` allows viewing and (op 2 or above) editing global waypoints.\n\nSurveyor data is stored in plain NBT under `data/surveyor` (per-dim in singleplayer/servers, in `.minecraft` for clients).\n\n### Configuration\n\nSurveyor's configuration can be edited in `config/surveyor.toml`, or in-game using [McQoy](https://modrinth.com/mod/mcqoy). This includes:\n- Toggling the terrain, structure, and landmark subsystems (otherwise set by installed frontends on clients)\n- What data should be networked to clients / the server, and between group members.\n- Whether all players on the server should be considered part of one global map sharing group.\n- How often to send player position updates to clients, and how fast to sync missing terrain to clients.\n- Whether to allow / how to handle syncing filled maps with surveyor data, including full-color rendering.\n\n### Mod Developers\n\nFeel free to reach out if you'd like to develop something with surveyor! Or don't, we don't mind! We appreciate:\n- PRs making shots at [surveyor enhancements and bugs](https://github.com/sisby-folk/surveyor/issues?q=is%3Aissue%20state%3Aopen%20(label%3Abug%20OR%20label%3Aenhancement)).\n- PRs containing ports to an older established versions (1.4.7, 1.17.10, 1.12.2, 1.16.5, 1.18.2) - [or latest, per policy](https://github.com/sisby-folk/surveyor/issues/91)\n- PRs containing API features that you'd benefit from - ideally post an issue first, and we can workshop it!\n- Compat addons, world maps, minimaps, and waypoint frontends utilizing surveyor!\u003cbr/\u003e\nServerside, web map, minecraftless... we just want to cultivate fun new things in the map mod space.\n\nCheck out the [frontend dev guide](https://github.com/sisby-folk/surveyor/blob/1.20/FRONTENDS.md) for a breakdown of the complicated parts of the internals. \u003cbr/\u003e\n\nIf you've made something, hit us up and we'll link it here! We'll also answer questions for any in-progress project.\u003cbr/\u003e\nDevs can reach out via the forum on [modfest](https://discord.gg/gn543Ee) (#projects-\u003eSurveyor), on [mastodon](https://tech.lgbt/@sleepingdragoninn), or hell, via [email](mailto:sleepingdragoninn@gmail.com).\n\n## Afterword\n\nSurveyor was built on the thoughts, advice, opinions, and past works of many modders in the community.\n\nThanks to everyone who helped make this project happen, even just by fluttering on the sidelines - it means a lot.\n\nWe made surveyor because it sounded cool - we hope it helps other artists/modders to make cool things!\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsisby-folk%2Fsurveyor","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsisby-folk%2Fsurveyor","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsisby-folk%2Fsurveyor/lists"}