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.jsonEvery 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
| Field | Purpose |
|---|---|
| metadata | Capture time, mod version, source, game build, player name, and note. |
| origin | The world pose and local frame that every entry transform is relative to. |
| bounds | Capture bounds and human-readable size in meters. |
| counts | Entry totals and capture diagnostics. |
| entries | Placed build items with item path, transform, state, graph id, class hint, source ref, and extras. |
| unknowns | Observed 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