Install guide

Requirements

• Timberborn 1.1. It needs 1.1.0.0 or newer and is built against 1.1.2.4. A future game update could break it.
• Windows. It has only been checked on Windows. Other systems may work, but their Mods folder is elsewhere.
• No other mods. No Harmony, no Mod Settings.
• Do not run it alongside Bobingabout's Housing Optimize or Commute Balancer. It turns itself off if either is enabled (why).

Step by step

1. Back up your save

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

2. Download the mod

   Download 1.2.0

   Get OptimizedLocalHousing-v1.2.0.zip from the release page. It's under Assets, not "Source code". The mod isn't on the Steam Workshop.

3. Close Timberborn

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

4. Extract into your Mods folder

   Extract the ZIP into Documents\Timberborn\Mods. You should get one OptimizedLocalHousing folder, as in the layout below.

5. Enable it and restart

   Start Timberborn and open Mods from the main menu. Tick Optimized Local Housing, then restart the game when it asks.

6. Load your save and let the game run

   On a save the mod hasn't seen, the first pass starts as soon as the game runs (not while paused). After that, a pass runs at the start of every in-game day. Check that it ran.

Folder layout

This is what a correct install looks like.

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

Documents\Timberborn\Mods\
└── OptimizedLocalHousing\
    └── OptimizedLocalHousing\
        ├── LICENSE
        ├── README.md
        └── version-1.1\
            └── ...

With a doubled folder the game doesn't find the mod. Move the inner OptimizedLocalHousing folder up one level and delete the empty one.

Check that it works

The mod has no menu and no settings. It writes one line to the game log at startup and one line after every pass.

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 [OptimizedLocalHousing]. You should see this at startup:

   [OptimizedLocalHousing] 1.2.0 loaded.

3. After each pass you should see a summary line. On a colony of a few hundred beavers, a pass takes about 90 seconds to two minutes at normal speed. Here is a real one; your numbers will differ:
   [OptimizedLocalHousing] Pass 26: 356 adults, 104 homes, 167 workplaces; 5354 route queries over 182 ticks; 2 move cycles applied (0 rejected, 0 stale), 0 disconnected commutes repaired, route cost saved 177.

What the numbers mean. No line, or an error line? See Troubleshooting.

Multiplayer

Every player must install the same version of the mod and run the same game version. The pass is built to make the same moves on every machine, even after a save, a reload or a join.

It ran in one live hosted co-op session (about 11,000 ticks and 15 passes) with no desync in the host's log. That session ran the code the stable release started from; this release hasn't been played live by two players yet. If you try it, please tell us how it went.

Updating

1. Close the game and delete the old Mods\OptimizedLocalHousing folder.
2. Extract the new ZIP into Mods as above.
3. Start the game.
4. In multiplayer, every player updates together.

Uninstalling

Untick it in the Mods menu and restart, or delete the OptimizedLocalHousing folder. Beavers keep the homes they have, and the mod's leftover data in your save is ignored.

Verify the download (optional)

In PowerShell, from the folder you downloaded to:

Get-FileHash .\OptimizedLocalHousing-v1.2.0.zip -Algorithm SHA256

The hash should be:

1bae3d47dad8801712d4b73656e312036ec84f5527f72203a5907b8b33a21a3b

The same hash is in the SHA256SUMS file attached to the release.