Guide

Install guide

About five minutes. You need Timberborn 1.1 and two other mods, Harmony and Mod Settings, which most players already have.

Requirements

• Timberborn 1.1. The mod is built against 1.1.2.4 and asks for 1.1.2.4 or newer. A future game update could break a feature: the mod then leaves that feature off and the game runs its own code.
• Harmony 2.4.1 or newer and Mod Settings, both from the Steam Workshop. Enable them in the game's Mods menu along with this mod.
• The folders shown on this page are the Windows ones.

Step by step

1. Back up your save

   Copy the save you want to use from Documents\Timberborn\Saves.

2. Get Harmony and Mod Settings

   Subscribe to both on the Steam Workshop if you have not already. This mod will not start without them.

3. Download the mod

   Get LateGamePerformance-0.4.9.zip from the release page. On the release page choose that file under Assets, not Source code.

4. Close Timberborn

   Make sure the game is fully closed before you copy files into its Mods folder.

5. Extract into your Mods folder

   Delete any older LateGamePerformance folder first. Then extract the ZIP into Documents\Timberborn\Mods. It contains one folder, LateGamePerformance, and you should end up with the layout shown below. If you extracted into a new folder you may have a doubled LateGamePerformance\LateGamePerformance. Move the inner one up.

6. Enable it and restart

   Start Timberborn, open Mods from the main menu, tick Harmony, Mod Settings and Late Game Performance, and restart the game when it asks. Menu wording can differ a little between game versions.

7. Load your save and play

   Nothing else is needed. The mod starts working as soon as a game is loaded. Check that it is running.

Folder layout

This is what a correct install looks like. The game reads the manifest and the DLL from the version-1.1 folder.

Documents\Timberborn\Mods\
└── LateGamePerformance\
    ├── LICENSE
    ├── README.md
    └── version-1.1\
        ├── LateGamePerformance.cfg
        ├── manifest.json
        └── Scripts\
            └── LateGamePerformance.dll

Check that it works

The mod writes to the game log, so that is where you confirm it is running.

1. Quit the game, then open %USERPROFILE%\AppData\LocalLow\Mechanistry\Timberborn\Player.log. If you have already restarted, the previous session is in Player-prev.log.
2. Search for [LateGamePerformance]. At startup you should see a line for the version and one for the features:

   [LateGamePerformance] 0.4.9 loading.[LateGamePerformance] Simulation features: HaulCache on, RouteMaps on, YielderSearch on. These are the same for every player on this version.

3. Another startup line reports the garbage collector. GC: incremental=False means memory clean-ups stop the whole game while they run. You can change that.
4. While you play, a stats line appears every 1,000 ticks (10 minutes at normal speed). The numbers in this example are an illustration of the format, and yours will differ:

   [LateGamePerformance] Last 1000 ticks. HaulCache: 412 hauler list requests, 251 served from cache, 161 rebuilt in 96.3 ms (0.598 ms each); buildings recomputed 40211/61843

No lines, or a line that says OFF? Head to Troubleshooting.

Turn on incremental garbage collection

This is optional, and it is the one feature that is a setting. The game cleans up memory with every thread stopped, and in a late-game colony that can freeze it for most of a second, about once a minute. Incremental collection does the same work a few milliseconds at a time.

1. Open the mod's settings page: Mods > Late Game Performance, from the main menu or in-game.
2. Tick Incremental garbage collection.
3. Restart the game. The startup line should now say GC: incremental=True.

Unity reads this choice before any mod loads, so the mod cannot switch it while the game runs. Ticking the box adds the line gc-max-time-slice=3 to Timberborn_Data\boot.config in the game's install folder, and unticking removes it. Nothing else in the file is touched, and a backup called boot.config.before-incremental-gc.bak is written beside it before the first change. The file is only ever written because you clicked the box, never at startup.

• A game update, or Steam's "verify integrity of game files", puts the original file back. If the box is ticked and the line has gone, the mod puts it back at the next start and says so in the log.
• If the install folder is read-only, the log says the file could not be changed. Add the line by hand with the game closed.
• It does not affect the simulation, so in multiplayer every player can choose separately.

Multiplayer

Every player installs the same version of the mod. That is all: nothing that affects the simulation is a setting, so the same version behaves the same for everyone. The startup line Simulation features: HaulCache on, RouteMaps on, YielderSearch on should read the same in every player's Player.log. If one player's line says OFF, see Troubleshooting. Incremental garbage collection, thread counts and timing logs may differ between players. The mod has been played in multiplayer on two computers; if you try it, please tell us how it went.

Updating

1. Close the game and delete the old Mods\LateGamePerformance folder.
2. Extract the new ZIP into Mods as above.
3. Start the game. An older LateGamePerformance.cfg that still has the keys HaulCache, HaulCacheFlushEveryTicks, RouteMaps or YielderSearch is fine: they are ignored, and the log says so.
4. In multiplayer, every player must update to the same version together.

Uninstalling

Untick it in the Mods menu and restart, or delete the LateGamePerformance folder. The mod stores nothing in saves. If you ticked Incremental garbage collection and want that undone too, untick it first, restart once, and then remove the mod: unticking removes the line from boot.config.

Verify the download (optional)

In PowerShell, from the folder you downloaded to:

Get-FileHash .\LateGamePerformance-0.4.9.zip -Algorithm SHA256

The hash should be:

27a39a6152a0873c78935c3c2235a20d69c0018148dbcfb422aae71eb1291c2a