descriptionbbcode

[size=6][b]MapExtension_Plugin[/b][/size]

[size=4][b]About This Mod[/b][/size]

MapExtension_Plugin adds a [b]live local map viewer[/b] for StarRupture.

While the game is running, the plugin reads local game data and makes it available to [b]MapExtensionViewer.html[/b], a browser page included with the mod. This lets you view your cargo network, teleporters, players, and the rupture-cycle timeline in a clearer way without replacing the in-game UI.

The goal is simple: [b]make your world easier to read[/b] once your base and transport setup become harder to follow.

[img]https://staticdelivery.nexusmods.com/mods/8632/images/91/91-1776075854-1505186280.png[/img]
[line]

[size=4][b]Features[/b][/size]
[list]
[*]Show [b]Cargo Dispatchers[/b] and [b]Cargo Receivers[/b] on a local map[/*]
[*]Show [b]links[/b] between cargo buildings[/*]
[*]Show [b]items currently moving[/b] through the cargo network[/*]
[*]Show [b]teleporter positions[/b][/*]
[*]Show [b]player positions[/b][/*]
[*]Show a [b]rupture-cycle timeline[/b][/*]
[*]Provide local data through built-in HTTP endpoints used by the viewer[/*]
[/list]

[line]

[size=4][b]Change Log v0.5[/b][/size]
[list]
[*]The plugin now updates itself through the Mod Loader when installed from the client archive[/*]
[*]The map viewer warns you when it is out of date and gives you a direct download link[/*]
[*]More reliable rupture timeline: it reacts to phase changes right away and recovers on its own after loading a world[/*]
[*]Lower overhead while the rupture timeline is displayed[/*]
[*]Removed the obsolete settings from the config file[/*]
[/list]

[size=4][b]Change Log v0.4[/b][/size]
[list]
[*]Optimized map rendering for a cleaner and smoother view[/*]
[*]Dedicated server performance optimizations for smoother map updates[/*]
[*]Made the rupture timeline more reliable and easier to follow[/*]
[*]Improved rupture tracking stability in multiplayer sessions[/*]
[*]Updated imminent rupture display to 2 minutes and added a drone disable icon[/*]
[*]The map viewer now comes with a map image folder that must stay next to the HTML file[/*]
[/list]

[size=4][b]Change Log 0.3[/b][/size]
[list]
[*]Added a new map background[/*]
[*]Added dedicated-server sync support for map and rupture data[/*]
[*]Updated the map viewer UI with a cleaner layout and better controls[/*]
[*]Added map notes and custom annotations[/*]
[*]Improved the map background and rupture timeline display[/*]
[/list]


[line]

[size=4][b]How It Works[/b][/size]

If you are new to this kind of mod, the idea is very simple:

[list]
[*]The [b]Mod Loader[/b] lets StarRupture load plugin mods[/*]
[*]This plugin runs while your game is open[/*]
[*]It exposes local data on your own PC[/*]
[*]In dedicated-server play, the client and server builds of [b]MapExtension_Plugin[/b] exchange map and rupture data with each other[/*]
[*][b]MapExtensionViewer.html[/b] reads that local data and displays it in your browser[/*]
[/list]

This is [b]not[/b] an online service and [b]not[/b] a separate game client. It is just a local viewer for your current game session.

[line]

[size=4][b]What You Will See[/b][/size]
[list]
[*]Where your cargo buildings are[/*]
[*]Which cargo buildings are connected together[/*]
[*]Which items are travelling through those links[/*]
[*]Where teleporters are placed[/*]
[*]Where players are located[/*]
[*]The current rupture-cycle timeline[/*]
[/list]

This is especially useful when your base grows and you want a cleaner overview of your layout, logistics lines, and rupture activity.

[line]

[size=4][b]Solo And Dedicated Server Support[/b][/size]

The plugin works in both solo and multiplayer, but rupture data is not sourced the same way in every case.

[list]
[*][b]Solo / local-host:[/b] the plugin can read rupture data locally from the running game[/*]
[*][b]Dedicated server:[/b] install the server build of [b]MapExtension_Plugin[/b] on the server so the client and server plugins can exchange map and rupture data[/*]
[/list]

The map viewer runs on the client. In dedicated-server play, the client plugin communicates with the server plugin, and the server plugin sends map and rupture updates back to the client plugin.

[line]

[size=4][b]Requirements[/b][/size]
[list]
[*][b][url=https://www.nexusmods.com/starrupture/mods/89]AlienX's Mod Loader[/url][/b][/*]
[*][b]MapExtension_Plugin[/b] installed on the client[/*]
[*][b]Optional for dedicated-server play:[/b] the server build of [b]MapExtension_Plugin[/b] installed in the server [b]ModLoader\Plugins[/b] folder[/*]
[/list]

[line]

[size=4][b]Installation[/b][/size]
[list=1]
[*]Install [b]AlienX's Mod Loader[/b] first[/*]
[*]Extract the Mod Loader into
[code]StarRupture/Binaries/Win64/[/code]
[/*]
[*]Copy [b]MapExtension_Plugin.dll[/b] and [b]MapExtension_Plugin.json[/b] from the client archive into
[code]StarRupture/Binaries/Win64/ModLoader/Plugins/[/code]
[/*]
[*]Start the game once so the plugin can initialize and generate its config file[/*]
[*]Place [b]MapExtensionViewer.html[/b] and the [b]map-tiles[/b] folder together wherever you want on your PC[/*]
[*]Double-click [b]MapExtensionViewer.html[/b] to open it in your default browser[/*]
[*]Keep the game running while you use the map viewer[/*]
[/list]

[b]Install from the client archive, not from the standalone DLL file.[/b] The archive also contains [b]MapExtension_Plugin.json[/b], a small file that lets the Mod Loader update the plugin on its own later on. Without it, the plugin will never update by itself.

If you play on a dedicated server, install the server build of [b]MapExtension_Plugin[/b] in the server [b]ModLoader\Plugins[/b] folder as well so the client and server plugins can communicate with each other.

[line]

[size=4][b]Updates[/b][/size]

Once [b]MapExtension_Plugin.json[/b] sits next to the DLL in your [b]ModLoader\Plugins[/b] folder, the Mod Loader checks for a newer plugin version when the game starts and replaces [b]MapExtension_Plugin.dll[/b] for you.

[b]Important:[/b] the automatic update only replaces the plugin DLL. It does [b]not[/b] touch [b]MapExtensionViewer.html[/b] or the [b]map-tiles[/b] folder, because those live wherever you chose to put them on your PC.

Good news: [b]the map viewer tells you when it is out of date.[/b] If the plugin has moved on to a version the viewer no longer understands, a window opens in the browser page with a direct download link for the new viewer, plus links to the GitHub release and to this mod page.

When that happens:

[list=1]
[*]Download the viewer archive from the link in the window[/*]
[*]Replace your [b]MapExtensionViewer.html[/b] and your [b]map-tiles[/b] folder with the ones from the archive[/*]
[*]Reload [b]MapExtensionViewer.html[/b] in your browser[/*]
[/list]

Always keep the [b]map-tiles[/b] folder next to [b]MapExtensionViewer.html[/b], otherwise the map background will not load.

[list]
[*]On a dedicated server, the server build is [b]not[/b] updated automatically: replace the server [b]MapExtension_Plugin.dll[/b] by hand and keep it on the same version as the client[/*]
[*]Automatic updates can be turned off in the Mod Loader by setting [code]Enabled=0[/code] under the [code][AutoUpdate][/code] section of [b]modloader.ini[/b][/*]
[/list]

[line]

[size=4][b]About MapExtensionViewer.html[/b][/size]

[b]MapExtensionViewer.html[/b] is the browser page used by the mod.

[list]
[*]It can be stored [b]anywhere on your PC[/b] as long as the [b]map-tiles[/b] folder stays next to it[/*]
[*]You can move it to your [b]Desktop[/b] for easier access[/*]
[*]A simple [b]double-click[/b] opens it in your default browser[/*]
[*]It does [b]not[/b] need to stay inside the game folder[/*]
[*]The [b]map-tiles[/b] folder must stay beside [b]MapExtensionViewer.html[/b] so the map background can load correctly[/*]
[*]The game must still be running so the page can read live data from the plugin[/*]
[/list]

[line]

[size=4][b]Configuration[/b][/size]

On first launch, the plugin creates:

[code]ModLoader/Plugins/config/MapExtension_Plugin.ini[/code]

Main defaults:

[code][General]
Enabled=1

[Http]
Port=9000

[Runtime]
RefreshIntervalMs=2000[/code]


[list]
[*][b]Enabled[/b]: turns the plugin on or off[/*]
[*][b]Port[/b]: local port used by the viewer to read plugin data[/*]
[*][b]RefreshIntervalMs[/b]: how often the runtime data is refreshed[/*]
[/list]

Most players will not need to change anything. The default settings are enough to use the mod.

[line]

[size=4][b]Advanced Notes[/b][/size]

For advanced users, the plugin exposes local endpoints used by the viewer:

[list]
[*][code]GET /health[/code]
[/*]
[*][code]GET /cargo[/code]
[/*]
[*][code]GET /rupture-cycle[/code]
[/*]
[/list]

You do not need to use these manually to enjoy the mod.

[line]

[size=4][b]Quick FAQ[/b][/size]

[b]Does this replace the in-game map?[/b]

No. It is a separate local browser page designed to give you a clearer overview.

[b]Do I need to keep the game running?[/b]

Yes. The viewer reads live data from the running game.

[b]Do I need to open the HTML file from the game folder every time?[/b]

No. You can place [b]MapExtensionViewer.html[/b] anywhere on your PC, including your Desktop, as long as the [b]map-tiles[/b] folder stays next to it.

[b]Is this a client-side mod?[/b]

Yes. [b]MapExtension_Plugin[/b] is installed on the client.

[b]Do I need anything on a dedicated server?[/b]

Yes. For dedicated-server play, install the server build of [b]MapExtension_Plugin[/b] in the server [b]ModLoader\Plugins[/b] folder so the client and server plugins can exchange data.

[b]Do I need to configure anything before using it?[/b]

Usually no. The default configuration is enough for most players.

[b]Does the mod update itself?[/b]

Yes, as long as you installed from the client archive so that [b]MapExtension_Plugin.json[/b] sits next to the DLL in your [b]ModLoader\Plugins[/b] folder. Only the plugin DLL is updated automatically.

[b]How do I know when the map viewer needs updating?[/b]

The map viewer tells you. When the plugin becomes too recent for your copy of [b]MapExtensionViewer.html[/b], a window opens in the browser page with a direct download link for the new viewer. Replace [b]MapExtensionViewer.html[/b] and the [b]map-tiles[/b] folder together, then reload the page.

[line]

[size=4][b]Project Status[/b][/size]

This mod is already functional, but it is still evolving. Feedback, fixes, and contributions are welcome.

[line]

[size=4][b]Credits[/b][/size]
[list]
[*][b]AlienX's Mod Loader[/b] for making plugin-based modding possible[/*]
[*][b]bithoarder[/b] for [b]StarRuptureMap[/b], used for the map background[/*]
[*][b]Mralexandresys[/b] for [b]MapExtension_Plugin[/b][/*]
[/list]

[line]

[size=4][b]Example Folder Tree[/b][/size]

After installation, your files should look similar to this:

[code]StarRupture/
|-- Binaries/
|   `-- Win64/
|       |-- <Mod Loader files> (dwmapi.dll)
|       `-- ModLoader/
|           `-- Plugins/
|               |-- MapExtension_Plugin.dll
|               |-- MapExtension_Plugin.json (enables automatic updates)
|               `-- config/
|                   `-- MapExtension_Plugin.ini (auto create)

Anywhere on your PC
|-- MapExtensionViewer.html
`-- map-tiles/
    `-- base_newmap_q70_2048/

Example if you place it on your Desktop
Desktop/
|-- MapExtensionViewer.html
`-- map-tiles/
    `-- base_newmap_q70_2048/[/code]

[list]
[*]The Mod Loader files must be inside
[code]StarRupture/Binaries/Win64/[/code]
[/*]
[*][b]MapExtension_Plugin.dll[/b] and [b]MapExtension_Plugin.json[/b] must be inside
[code]StarRupture/Binaries/Win64/ModLoader/Plugins/[/code]
[/*]
[*][b]MapExtension_Plugin.json[/b] must stay next to the DLL so the Mod Loader can update the plugin automatically[/*]
[*][b]MapExtensionViewer.html[/b] and the [b]map-tiles[/b] folder can be stored anywhere, including your Desktop[/*]
[*]Keep the [b]map-tiles[/b] folder and its contents next to [b]MapExtensionViewer.html[/b][/*]
[/list]