Persistent ID Fix

Why do I need this?

Have you been playing the same StarRupture world for a very long time and built a huge base, only to start seeing strange things disappear after saving and reloading?

One possible cause is persistent ID exhaustion.

StarRupture assigns a unique persistent ID to entities such as buildings, machines and rail drones. The available ID numbers are limited. In a sufficiently old or heavily developed world, the game can eventually approach the maximum ID value it can store. Every new rail drone that spawns consumes one ID value. When a rail drone reaches its destination machine or storage, the drone is deleted but the ID is not reclaimed. A base using thousands of drones per minute means thousands of IDs per minute used.

When the available ID space is exhausted, newly created entities can no longer be assigned safe new IDs. Then the ID Counter starts over again at 0 going up, overwriting any existing building with the ID of the same value. This leads to ID conflicts and unexpected save/load behavior. One observed consequence is that parts of a large base disappeared after a reload, while newer buildings remained floating in the air.

PersistentIdFix prevents this situation by safely reusing persistent IDs that are no longer present in the loaded save.

Instead of continually moving the ID counter toward the limit, this mod makes previously removed IDs available again.

Who is this for?

PersistentIdFix is primarily intended for:

• []Long-running StarRupture worlds[/]

  []Large and heavily built bases[/]

  []Worlds with large numbers of rail drones created over time[/]

  []Savegames approaching the persistent ID limit[/]

  []Dedicated servers intended to run a world for a long time[/]

You do not need to be near the ID limit for the plugin to function. It is designed to prevent the ID counter from unnecessarily approaching the limit in the first place.

Tested

PersistentIdFix has been tested with:

• []StarRupture client[/]

  []StarRupture dedicated server[/]

  []WinDbg[/]

  []Small saves[/]

  []A very large save with a ID Counter value (MaxPersistentID) of

  4,294,652,781[/]

  []Save, reload, and continued play after ID reuse[/]

  []Dedicated server restart and world reload[/]

  []Continued play on a large save[/]

  []Other StarRupture players[/]

  []No measurable loading-time & run-time penalty observed on the tested large save[/]

Installation

Install the appropriate PersistentIdFix package for your StarRupture installation in the AlienX Mod Loader folder.

The client release package is for the StarRupture client.

The server release package is for a StarRupture dedicated server.

• []Right click StarRupture in Steam > Manage > Browse Local Files[/]

  []Navigate to: StarRupture\Binaries\Win64\ModLoader\Plugins[/]

  []Copy the DLL, JSON, and PDB files to the directory[/]

Usage

PersistentIdFix works automatically and does not require any user interaction. When using the StarRupture Client, press F3 to open or close the PersistentIdFix Live Statistics window. The window displays information about the current persistent ID state and reuse activity.

The F3 toggle key can be changed in the plugin configuration. The widget can be moved when the AlienX ModLoader menu is active (F2).  To remotely view the live stats of a Dedicated Server, both the normal StarRupture game client and the Dedicated Server must have the same PersistantIdFix version installed.

Important

PersistentIdFix is intended to prevent persistent ID exhaustion.

It is not a general save-repair tool and does not claim to recover every case of missing or disappearing entities. If the savegame's ID counter has already started over at 0 then there is no way to prevent further savegame corruption. If a save has already suffered such corruption or entity loss, installing PersistentIdFix should not be assumed to restore or prevent missing entities.

Always keep backups of important saves before installing mods or making changes to an existing world.

Source code

Source code is available on GitHub:

https://github.com/LetMeInside/StarRupture-Plugin-PersistentIdFix

Changelog

Version 1. 2. 0

[]Added Live Statistics on-screen widget for the Client Release.[/]

[*]Added widget to