https://github.com/sisby-folk/surveyor
Unified API, networking, and save data for minecraft map mods.
https://github.com/sisby-folk/surveyor
java minecraft modtoberfest
Last synced: 3 months ago
JSON representation
Unified API, networking, and save data for minecraft map mods.
- Host: GitHub
- URL: https://github.com/sisby-folk/surveyor
- Owner: sisby-folk
- License: lgpl-3.0
- Created: 2024-02-07T05:20:09.000Z (over 2 years ago)
- Default Branch: 1.20
- Last Pushed: 2025-11-27T05:19:53.000Z (7 months ago)
- Last Synced: 2025-11-29T20:13:01.059Z (7 months ago)
- Topics: java, minecraft, modtoberfest
- Language: Java
- Homepage: https://modrinth.com/mod/surveyor
- Size: 1.01 MB
- Stars: 23
- Watchers: 2
- Forks: 9
- Open Issues: 21
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
An open-source backend (and API) for world map and waypoint mods!
Requires Connector and FFAPI on (neo)forge.
---
**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).
Along with handling the generation and saving of map data like terrain and waypoints, Surveyor:
- Shows other players on your map, even far away or in other dimensions!
- Tracks your exploration, and will restore your map data from the server if it's lost or you change computers!
- Enables **live map sharing** with other players of your choosing - terrain, waypoints, the lot!
- Allows swapping map frontends any time without losing your map data!
- 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).
- Is fully modular - so mods like [Dead Reckoning](https://modrinth.com/mod/dead-reckoning) can utilize waypoints without enabling terrain scanning.
- Has builtin integration to sync with vanilla maps via sneak+using at a cartography table!
### Commands
If you're a server admin or don't have a map frontend installed, surveyor comes with a few helpful commands:
- `/surveyor` displays summary of how many chunks and structures you've explored, and waypoints recorded.
- `/surveyor share [player]` and `/surveyor unshare` allows joining and leaving map sharing groups.
- `/waypoints` allows viewing and editing your recorded waypoints.
- `/landmarks` allows viewing and (op 2 or above) editing global waypoints.
Surveyor data is stored in plain NBT under `data/surveyor` (per-dim in singleplayer/servers, in `.minecraft` for clients).
### Configuration
Surveyor's configuration can be edited in `config/surveyor.toml`, or in-game using [McQoy](https://modrinth.com/mod/mcqoy). This includes:
- Toggling the terrain, structure, and landmark subsystems (otherwise set by installed frontends on clients)
- What data should be networked to clients / the server, and between group members.
- Whether all players on the server should be considered part of one global map sharing group.
- How often to send player position updates to clients, and how fast to sync missing terrain to clients.
- Whether to allow / how to handle syncing filled maps with surveyor data, including full-color rendering.
### Mod Developers
Feel free to reach out if you'd like to develop something with surveyor! Or don't, we don't mind! We appreciate:
- 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)).
- 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)
- PRs containing API features that you'd benefit from - ideally post an issue first, and we can workshop it!
- Compat addons, world maps, minimaps, and waypoint frontends utilizing surveyor!
Serverside, web map, minecraftless... we just want to cultivate fun new things in the map mod space.
Check 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.
If you've made something, hit us up and we'll link it here! We'll also answer questions for any in-progress project.
Devs can reach out via the forum on [modfest](https://discord.gg/gn543Ee) (#projects->Surveyor), on [mastodon](https://tech.lgbt/@sleepingdragoninn), or hell, via [email](mailto:sleepingdragoninn@gmail.com).
## Afterword
Surveyor was built on the thoughts, advice, opinions, and past works of many modders in the community.
Thanks to everyone who helped make this project happen, even just by fluttering on the sidelines - it means a lot.
We made surveyor because it sounded cool - we hope it helps other artists/modders to make cool things!