Skip to content

Releases

Clockspeed v0.1.0

Choose a tag to compare

@Remus3 Remus3 released this 21 Oct 01:21

The first public release of Clockspeed: a local, deterministic production planner, ratio calculator and advisor for Satisfactory. This is early 0.x software and runs on Windows only.

What Clockspeed is

Clockspeed reads the data files that ship with your own game installation, along with your own save file. From them it computes exact production mathematics and tells you what to build next.

  • No dataset of its own. Items, recipes and buildings are extracted from your install at runtime, so the answers match the patch you are actually playing.
  • Local. Everything runs on your machine. There is no account, no API key and no network service, and the product makes no network call.
  • Read-only. It never writes to the game install or to a save. Saves are copied to a work directory before parsing, so a running autosave is never disturbed.
  • Deterministic and exact. No language model is used anywhere in the advice path. Ratios are solved in exact rational arithmetic, and the solve path asserts that no float reaches it. Two runs on the same save that disagree are a bug.
  • Not a mod. Nothing is installed into the game, no mod loader is needed, and the game process is never hooked, injected into or read from memory.

What works in v0.1.0

The local HTTPS server answers these routes. /api/health reports the live route table, and it is the authoritative list.

  • Target-rate ratio solve (/api/solve). Ask for an output per minute and get the whole production tree: every intermediate, exact building counts, byproduct handling and raw input totals.
  • Alternate recipe selection (/api/optimize). Chooses the recipe set that minimizes raw resource use, power draw or building count over the recipe set you declare available. Any other objective is refused rather than silently ignored.
  • Power and clock speed mathematics (/api/power). Covers overclock and underclock cost curves, including variable-power buildings whose draw is a bounded range.
  • Your world, read (/api/world, /api/registry). The install and your newest save are found automatically. The server returns header facts, world inventory counts and the normalized item and recipe registry.
  • A map of what you have built (/api/map). Placements with exact translation, rotation and scale, read from the save.
  • Advice cards (/api/advice). Each card has a one-line headline, a one-line reason and a full derivation generated from the rule trace, plus a per-world card state. The rules so far cover power and fuel: power headroom, and fuel supply against demand for fluid-fuel generators.
  • A local dashboard, plus an optional Electron companion window that loads it.

Install

Requirements:

  • Windows.
  • A local installation of the game, kept current.
  • Python 3.13 or 3.14. scripts/verify_env.py checks the range and prints the version it found.
  • Git for Windows. The openssl it ships must be on PATH.
  • Node, only for the optional companion window and for running the full test suite.

Clone the repository, or download this release's source archive. Then, from its root in PowerShell:

python -m venv .venv
Set-ExecutionPolicy -Scope Process -ExecutionPolicy RemoteSigned -Force
.venv\Scripts\activate
python -m pip install -e ".[dev]"
$env:Path += ";<Git install>\usr\bin"
python scripts/install_hooks.py
python scripts/verify_env.py
python scripts/make_cert.py
python -m clockspeed.surface

Open https://localhost:<port>/, using the port that scripts/verify_env.py prints. The certificate is self-signed, so your browser shows a warning that you must accept first. The full procedure, including cmd forms and the companion window, is in docs/OPERATIONS.md.

Limits in this release

  • Windows only, early 0.x. The HTTP API may change between 0.x releases.
  • Bring your own game. Clockspeed ships no game data. Without a local install or a save, /api/advice answers 503.
  • The dashboard does not draw advice cards yet. They are served by /api/advice.
  • Advice covers power and fuel only. Rules for node siting and claim order, onsite processing versus transport, and the milestone gap are not written yet.
  • The whole-world audit is built but not published. It covers idle and starved machines, overclock waste, belt and pipe saturation, power headroom and under-extracted nodes. /api/audit answers 501 for now.
  • Milestone routing is not written. /api/plan answers 501.
  • Recipe availability is not read from your save. The optimizer uses the recipe set you supply.
  • One game build is pinned. A save written on a different build gets a warning that names both builds, and its figures are priced at the pinned build.
  • Mods are not modeled. Unknown content is flagged and skipped, never guessed at.

License

MIT. A few vendored files carry their own licences; THIRD_PARTY.md lists each one.

Clockspeed is an independent project. It is not affiliated with, endorsed by, or connected to Coffee Stain Studios. Satisfactory and its data files are the property of their publisher, and nothing extracted from a local installation is redistributed here.