# 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. ## Building types and zones | Type | Allowed zones | Cost | Hearing if that option is on | | --- | --- | --- | --- | | cottage | house | 800 | no | | terrace | house | 1400 | no | | shopfront | shop | 2000 | yes | | mill | works | 5000 | yes | | green | park | 300 | no | | rezone | any | 400 | yes | Denial codes: `budget` if the cost exceeds the current budget; `zone` if the parcel's zone is not allowed; `neighbour` if a `mill` shares an edge with a `cottage`; `hearing` if a hearing decides no (scripted or seeded). ## Appeal seeds Seed 4 on an appeal of a `neighbour` denial of a mill returns yes. Seed 5 returns no. These are fixed in `fixtures/appeals.json`. ## Scripted city The script and the day-40 state are files. Tests compare the whole state, not a summary. ## Screenshot tolerance 8 levels, 98% of pixels. ## Inputs | Key | Label | Default | Notes | | --- | --- | --- | --- | | `city_name` | City name | Millstead | Shown on the map and on forms. | | `budget` | Starting budget | 12000 | A whole number of pounds, from 1000 to 99999. | | `hearings` | Require hearings | on | Some permits need a hearing delay before they are decided. | | `appeals` | Allow appeals | on | A denied permit may be appealed once. | | `map` | Map | river | The starting parcel layout. | ## 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 | | --- | --- | | `design.md` | A shipped fixture. The build may move it, but then `design.md` must name the new path. | | `fixtures/appeals.json` | A shipped fixture. The build may move it, but then `design.md` must name the new path. | | `fixtures/millstead-day-40.json` | A shipped fixture. The build may move it, but then `design.md` must name the new path. | | `fixtures/millstead-script.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/city.png` | Millstead from above, a Thursday hearing on lot C2, budget 12 000. | ## 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. Rule tests cover zoning, permit grants, delays, denials and seeded appeals. A scripted city starting from the river map reaches the documented day-40 state. Four golden map screenshots are checked. No live GIS and no network.