🗺️ Cartograph

Display your buildings on the map!

🚧 Complete rework to address the VRAM issue and improve maintainability is ~~on the way!~~ delayed indefinitely 🚧

👥✅ Multiplayer Tested

🧊 Completely Transient

It doesn't leave anything in your save file. You can safely uninstall it anytime.

✉️ Contact & Support

- Discord: [yeshjho](https://discord.com/users/353886187879923712) or [Satisfactory Modding Server](https://discord.com/invite/xkVJ73E)
- GitHub: https://github.com/yeshjho/Cartograph
- E-mail: [email protected]

💻 For Mod Devs

Refer to [this wiki page](https://github.com/yeshjho/Cartograph/wiki/How-to-customize-the-look-of-modded-buildings) if you want to customize the look of the custom buildings of your mod!

📷 Screenshots


📝 Future Plan

Optimization

- Reduce VRAM usage

Drawing

- Take building thickness(Z Height) into account when deciding which comes on top of the others. Currently only compares Z position values.
- Building icons/color customization.
- Properly draw buildings rotated along X/Y axes.
- Apply customizer data.
- Community suggestion: Display power-sharded/somerslooped buildings.
- Community suggestion: Show vehicle routes.
- Paint?
- Community suggestion: Support the entire buildable area, which is slightly wider than the map, if it's not too big.
- Community suggestion: Show radioactive areas.

UI

- Community suggestion: Make buildings on the map interactable, displaying additional information.

Building Icon Textures (low priority)

Will implement in the following order:
1. Production tab
2. Logistics tab
3. Power tab
4. Architecture tab
5. Transportation tab
6. Special tab
7. Organization tab
8. FICSMAS tab

And More

- Display hard drive/somersloop/mercer sphere?
- Community suggestion: Add a building that displays the map in-game. (Will be a separate mod)

⚙️ Configurations

Too slow redraw? Too laggy? <br> You can adjust some settings to make tradeoffs.

Go to Menu > Mods > Cartograph.

Time Budgets

- Initialize Time Budget: Allowed work time in ms per tick(frame) for initialization which happens when a world is loaded. Higher = Laggier for the first few frames but Faster initialization(first map render).
- Redraw Time Budget: Allowed work time in ms per tick(frame) for redrawing which happens when a building is newly built/dismantled. Higher = Laggier when buildings are built/dismantled but Faster redraw.

Credits

- <img src="https://github.com/yeshjho/SatisfactoryMod/blob/Cartograph/Mods/GameFeatures/Cartograph/Assets/work/Cartograph.png?raw=true" width="50"> Mod Icon: bpforest

Special Thanks to

- [SCIM](https://satisfactory-calculator.com/): Inspiration for this mod! Also referred to its code to figure out the exact map coordinates.
- [UE5Coro](https://github.com/landelare/ue5coro): Amazing coroutine plugin that has various gameplay logic helpers.
- And of course, SML developers.