MapExtension_Plugin

French README: README.fr.md

MapExtension_Plugin exposes StarRupture map data through a local HTTP endpoint and ships with mapview, a local web UI used to visualize it.

The plugin works in both single-player and server sessions.

It only needs to be installed on the client. No server-side installation is required: the data used by the mod is already available on the client.

What the plugin does

• captures Package Sender and Package Receiver runtime data,
• projects cargo, teleporters, and players into map coordinates,
• publishes the current snapshot through GET /health and GET /cargo.

What mapview does

mapview/ is the standalone UI shipped with the plugin.

• it reads the data exposed by the plugin,
• it displays the map, entities, and their connections,
• it produces a standalone single-file HTML build.

Interface choice

The initial goal was a more direct integration into the in-game UI.

In practice, StarRupture's UI turned out to be too limited to produce something reliable and maintainable in good conditions. The project therefore moved to a local web interface.

This is not necessarily the ideal integration model, but it is currently the most effective way to iterate quickly, display the data correctly, and keep the tool usable.

Project status

This is a first functional draft.

The project will continue to evolve soon, and feedback, fixes, and contributions are welcome.

For build and development details, see DEVELOPERS.md.

License

The MapExtension_Plugin code is distributed under the MIT license. See LICENSE.

Third-party components and references are documented in THIRD_PARTY_NOTICES.md.

Some third-party assets or references may be subject to rights separate from the MIT-licensed code.

Plugin configuration

The plugin creates Plugins/config/MapExtension_Plugin.ini with:

[General]
Enabled=1

[Diagnostics]
VerboseLifecycleLogs=0
LogRuntimePlanOnce=0
LogCargoSnapshots=0
LogActorScanFallback=0

[Http]
Port=9000

[Runtime]
RefreshIntervalMs=500

• Enabled: enables or disables the plugin (1 or 0)
• VerboseLifecycleLogs: enables lifecycle logs (1 or 0)
• LogRuntimePlanOnce: logs the runtime strategy once (1 or 0)
• LogCargoSnapshots: logs cargo snapshots (1 or 0)
• LogActorScanFallback: logs actor scan fallback (1 or 0)
• Port: sets the local HTTP port used by the plugin
• RefreshIntervalMs: sets the runtime refresh interval in milliseconds

Credits

• Thanks to AlienXAXS for StarRupture-ModLoader, the mod loader that made MapExtension_Plugin possible: https://github.com/AlienXAXS/StarRupture-ModLoader
• Thanks to bithoarder for StarRuptureMap, used for the StarRupture game map: https://github.com/bithoarder/StarRuptureMap/
• This project is also inspired by StarRuptureSaveMap: https://github.com/thanamatos/StarRuptureSaveMap
• Thanks as well to the StarRupture developers for the game itself.

Disclaimer

This is a modding tool. Use it at your own risk.

The authors cannot be held responsible for damage, regressions, or incompatibilities caused by its use. Every effort is made to reduce impact on save files and future compatibility, but that cannot be guaranteed.