Skip to content

Repository files navigation

BeaverScan

Upload your Timberborn save, see what is going on in your colony, share it.

Open-source web tool that parses .timber save files entirely in the browser and surfaces production balance, drought survival predictions, power network health, and post-mortem analysis. No save ever leaves your browser unless you explicitly share it.

Why this exists

Timberborn does not expose enough information for an intermediate or advanced player to debug a stalled colony. Existing tools either run in-game only (Goods Statistics mod), require a local Python setup (amine101 dashboard), or are abandoned (charperbonaroo editor on Node 12). BeaverScan fills the gap with a zero-install web app focused on three jobs:

  • Optimize: identify production bottlenecks, idle buildings, power deficits.
  • Post-mortem: load a save where the colony failed and find out why.
  • Share: get a public URL that renders the dashboard for anyone, no game required.

Privacy

Save files are parsed client-side with fflate + native JSON. Nothing is uploaded to a server unless you click share, and that action is explicit and reversible. The parser is auditable — that is exactly why this repository exists.

What lives here

This is the public core of BeaverScan. It contains:

  • src/lib/timberborn/parser — ZIP extraction and JSON parsing of .timber files.
  • src/lib/timberborn/types — TypeScript schemas for save entities and singletons.
  • src/lib/timberborn/catalog — building, recipe and resource catalogs, kept in sync with game versions.
  • src/lib/timberborn/analysis — derived metrics: production balance, drought predictor, network analysis.
  • src/components/dashboard — visualization components used in the free tier.
  • src/app/[locale] — landing page and upload flow.

The commercial backend (accounts, billing, premium analytics, public sharing infrastructure) lives in a private companion repository and is not open source.

Quick start

Requires Bun 1.1+ (Node 22+ works as a fallback).

git clone https://github.com/beaverscan/beaverscan-core.git
cd beaverscan-core
bun install
make dev

Open http://localhost:3000.

To analyze your own save, the file lives at:

  • Windows: %USERPROFILE%\Documents\Timberborn\Saves\<settlement>\<file>.timber
  • macOS: ~/Library/Application Support/Timberborn/Saves/<settlement>/<file>.timber
  • Linux (Steam Proton): ~/.local/share/Timberborn/Saves/<settlement>/<file>.timber

Contributing

Pull requests are welcome. The most useful contributions are:

  • Template catalog updates when the game releases a patch. The catalog lives in src/lib/timberborn/catalog as plain JSON.
  • Test fixtures — anonymized save files exercising edge cases (large maps, mods, droughts).
  • Translations for the dashboard UI in messages/<locale>.json.

Read CONTRIBUTING.md before opening a PR.

License

MIT. See LICENSE. The BeaverScan name, logo, and the commercial backend service are not covered by this license.

Trademark notice

This project is not affiliated with or endorsed by Mechanistry. Timberborn is a trademark of Mechanistry Sp. z o.o.

About

Upload your Timberborn save, see what's going on in your colony, share it.

Topics

Resources

Code of conduct

Contributing

Security policy

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Used by

Contributors

Languages