Persistent Work Areas

Install guide

Extract one folder and enable the mod. It takes about a minute.

Requirements

  • Timberborn 1.1.2.4 or a compatible 1.1 build.
  • No other mods: not Harmony, Mod Settings or BeaverBuddies.
  • A Mods folder in your Timberborn user folder, normally Documents\Timberborn\Mods. If it's missing, start the game once or create it.

Tested on Windows. If your Timberborn user folder is elsewhere, use the Mods folder there.

Install

  1. Close Timberborn

    Mods load when the game starts, so quit it first.

  2. Download the zip

    Under Assets on the newest release, choose the file named like PersistentWorkAreas-vX.Y.Z.zip. Don't use the one ending in -source.zip or the Source code archives.

    Download the latest zip

  3. Extract it into your Mods folder

    Right-click the zip, choose Extract All, and pick Documents\Timberborn\Mods. You should get this, with manifest.json and the DLL side by side in version-1.1:

    Documents\Timberborn\Mods\
  PersistentWorkAreas\
    version-1.1\
      manifest.json
      PersistentWorkAreas.dll
      KeyBindingGroups\
      KeyBindings\
      Localizations\
    README.md
    VALIDATION.md

    If you see PersistentWorkAreas\PersistentWorkAreas\version-1.1, it's nested one level too deep. Move the inner folder up.

  4. Start Timberborn and enable the mod

    In the mod manager, enable Persistent Work Areas. Restart if the game asks.

Check that it works

  1. Load a colony and select a farmhouse, forester or lumberjack flag.
  2. At the top of its panel, find the WORKING AREA section: a Keep working area visible row with an OFF badge.
  3. Click the row so it reads ON, then deselect the building. The outline stays, and Clear pinned areas (1) appears at the top right.
WORKING AREA

Click to pin this outline while planting or building.

Illustration of the panel, not a screenshot.

The game log also shows that the mod loaded. Search it for this line (where to find the log):

[PersistentWorkAreas] <version> loaded.

Something wrong? See Troubleshooting.

Optional key binding

Go to Settings → Key bindings → Persistent Work Areas, and assign a key to Clear all pinned working areas. It starts unbound. Pick a key your planting tools don't use.

Using it with BeaverBuddies

It works with the BeaverBuddies Stability Fork, but doesn't need it. Leave your BeaverBuddies install as it is.

Pins are local

Each player pins and clears on their own computer, and nothing is sent over the network. For co-op, every player installs the same version of the mod and runs the same game version; that's the tested setup.

Updating

  1. Close Timberborn.
  2. Download the newest zip from the latest release.
  3. Delete the old Mods\PersistentWorkAreas folder, then extract the new zip into Mods.
  4. Start the game and check that Persistent Work Areas is still enabled.

Replace the whole folder, not just the DLL: the DLL needs the files beside it. Your pins are kept, because they live outside the mod folder.

Uninstalling

Disable the mod in the mod manager, or close the game and delete Documents\Timberborn\Mods\PersistentWorkAreas. Your saves are unaffected. To forget the remembered pins too, delete the Documents\Timberborn\PersistentWorkAreas folder.