Project Reference

Schematic Format

The v1 JSON file shape used for local captures, paste, publish, install, and material breakdowns.

Filename

text
<timestamp>-<source>.schematic.v1.json

Every captured or generated build is a normal JSON file under the local library folder. The mod and companion both read and write the same files.

Top-level shape

json
{
  "schema": "windrose.schematic",
  "version": 1,
  "metadata": {},
  "origin": {},
  "bounds": {},
  "counts": {},
  "entries": [],
  "unknowns": []
}

Important fields

FieldPurpose
metadataCapture time, mod version, source, game build, player name, and note.
originThe world pose and local frame that every entry transform is relative to.
boundsCapture bounds and human-readable size in meters.
countsEntry totals and capture diagnostics.
entriesPlaced build items with item path, transform, state, graph id, class hint, source ref, and extras.
unknownsObserved objects that capture could not serialize yet.

Validation rules

  • schema must be windrose.schematic and version must be 1.
  • origin.frame must be recognized.
  • entry kinds must be recognized or skipped as unknown.
  • entry transform locations must be finite.
  • item_path must be present for kinds that need a game asset.
  • Optional fields default safely so older captures keep working.
related docs