# Design This file fixes the parts that are easy to get wrong. The language and tools are up to you, as long as the numbers here hold. ## Scene format A json document with `objects`: each has `id`, `type` (`box`, `line`, `arrow`, `text`), geometry, and text. The fixture file is the authority. Attachments are `{ "from": id, "to": id, "end": "arrow" }`. ## Screenshot tolerance 8 levels, 98% of pixels, camera at the fixture's view box, seed 4. ## Inputs | Key | Label | Default | Notes | | --- | --- | --- | --- | | `title` | Title | A messy board | Shown in a corner of an empty board. | | `roughness` | Line roughness | 0.8 | From 0 (straight) to 1.5. Tests pin the seed so roughness is deterministic. | | `grid` | Dot grid | on | A faint background grid. | | `arrows` | Arrow heads | on | Lines can end in an arrow. | | `export` | Export format | both | How a board is saved. Tests always write json, and svg when both or svg is chosen. | ## Acceptance at the defaults The numbers, names and fixture paths already in this file are the authority. Where a later table or a shipped fixture file disagrees with prose, the table or the fixture wins. | Fixture | Role | | --- | --- | | `fixtures/board-ops.json` | A shipped fixture. The build may move it, but then `design.md` must name the new path. | | `fixtures/board-scene.json` | A shipped fixture. The build may move it, but then `design.md` must name the new path. | | `spekkr.inputs.json` | A shipped fixture. The build may move it, but then `design.md` must name the new path. | Golden frames are compared at 1400 by 1000 CSS pixels unless a requirement names another size. Tolerance, unless a tighter figure is given above: 8 levels, 98% of pixels, with motion, cursors and clocks frozen as this file says. A build's goldens are of that build; they do not have to match a shipped reference preview pixel-for-pixel if the tool or the type is different, but they do have to match this file's layout, counts and copy. ## Screenshots These pictures are headless-Chrome captures of the working reference in `reference/preview.html`, at the default inputs. They are not drawings of a product that has not been built. The first picture is the one Spekkr shows on the spec's card. A build may ship its own goldens; those goldens are of that build and do not have to match these frames pixel-for-pixel. | File | What it shows | | --- | --- | | `shots/board.png` | A messy board at roughness 0.8, two cards arrowed, export still to do. | ## How to verify 1. Run the checks at the default inputs, without a network. 2. Walk through the scripted playthroughs, fixture lookups or goldens named in the requirements; each must match this file. 3. Repeat once at the person's inputs when they differ from the defaults. 4. Create, move, arrow, and export are tested with a script that reaches a documented scene. That scene round-trips through the json format, and an svg export parses. A golden canvas shot is taken with a pinned roughness seed. No network and no third-party file format requirement.