Persistent Work Areas

Install guide

Extract one folder, enable the mod, and you're done. It takes about a minute.

Requirements

  • Timberborn 1.1.2.4 or a compatible 1.1 build.
  • Nothing else. No other mods, Harmony or BeaverBuddies are required.
  • A Mods folder inside your Timberborn user folder, normally Documents\Timberborn\Mods. If it doesn't exist yet, start the game once or create it yourself.

The mod has been built and checked on Windows. If your Timberborn user folder is somewhere else, extract into the Mods folder there instead.

Install

  1. Close Timberborn

    Mods are loaded when the game starts, so quit it first.

  2. Download the zip

    Get the newest release from GitHub. Choose the file named like PersistentWorkAreas-vX.Y.Z.zip, not the one ending in -source.zip, which is only the source code.

    Download the latest zip

  3. Extract it into your Mods folder

    Right-click the zip, choose Extract All, and pick Documents\Timberborn\Mods. The result must look exactly like this, with manifest.json and the DLL side by side inside 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, the folder is nested one level too deep. Move the inner folder up.

  4. Start Timberborn and enable the mod

    Open the game's mod manager, enable Persistent Work Areas, and restart the game if it asks you to.

Check that it works

  1. Load a colony and select a farm, forester or lumberjack flag.
  2. At the top of its info panel you should see a WORKING AREA section with a Keep working area visible row and an OFF badge.
  3. Click the row so it reads ON, then deselect the building. Its outline should stay on screen, and a Clear pinned areas (1) button appears at the top right.
WORKING AREA

Click to pin this outline while planting or building.

Illustration of the panel, not a screenshot.

You can also confirm the mod loaded by searching the game log for [PersistentWorkAreas]. See where to find the log.

If something doesn't look right, head to Troubleshooting.

Optional key binding

The mod adds one shortcut, Clear all pinned working areas. It starts unbound so it can't take over a key you already use.

  1. Open the game's Settings and go to Key bindings.
  2. Find the Persistent Work Areas group.
  3. Assign a key to Clear all pinned working areas. Pick one that isn't used by a tool you have active while planting.

Using it with BeaverBuddies

The mod is designed for compatibility with the BeaverBuddies Stability Fork. Leave your existing BeaverBuddies installation as it is.

Pins are local

Each player pins and clears on their own computer, and nothing is sent over the network. Installing the mod on both computers is recommended for your first co-op session; running it on only one hasn't been playtested.

Updating

  1. Close Timberborn.
  2. Download the newest zip from the latest release.
  3. Extract it into the same Mods folder and choose Replace when asked about existing files.
  4. Start the game and confirm Persistent Work Areas is still enabled in the mod manager.

Pins are never saved, so there's nothing to migrate.

Uninstalling

Disable the mod in the mod manager, or close the game and delete Documents\Timberborn\Mods\PersistentWorkAreas. Your saves are unaffected because the mod never writes to them.