Project settings
edit_homeSet a home project's name, properties, compass, city building code, and occupant details so ergonomic and compliance scores reflect the right rules.
Instructions
Rename the project, set or remove project properties (properties {key: value|null}, or a storey's with level), set the compass (north), set the city whose building code applies (city=sao-paulo), and say who lives there (people {occupants, children, elderly, wheelchair, stature cm, scope}). City and people belong to the project: ergonomics, layout and every dry run then weigh the same rules for the same people, so a change can be tested against the score it moves.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| city | No | City whose building code applies, e.g. `sao-paulo`; `""` clears it. Kept with the project, so `ergonomics`, `layout` and every dry run weigh the same municipal rules | |
| name | No | The project's name | |
| level | No | Storey whose properties `properties` changes, e.g. `lv2` | |
| north | No | Clockwise degrees from plan up to north | |
| people | No | Who lives there — occupants, children, elderly, wheelchair, stature cm, scope — kept with the project: ergonomics and every dry run then score for them. What is left out stays as it was | |
| region | No | State or province whose code applies: `sp`, `fl`; `""` clears it. In the United States it is the state that adopts a building code, so it matters as much as the country there | |
| country | No | Country whose standards apply, ISO 3166-1 alpha-2: `br`, `us`, `de`; `""` clears it. It decides which sources oblige and which only inform — a Brazilian standard is a reference in Florida, and the IRC is a reference here. A city we hold implies its country, so this is for saying where a project is when no code was picked | |
| compass_d | No | Compass diameter cm | |
| compass_at | No | Where the compass sits on the plan, `[x,y]` cm | |
| properties | No | Project properties to set, `{key: "value"}`, or remove, `{key: null}` — what an import leaves behind (window sizes, panel dividers, ids of the program it came from). With `level`, that storey's instead | |
| compass_visible | No | Show or hide the compass |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| v | No | ||
| ok | Yes | ||
| ids | No | ||
| rev | No | ||
| text | Yes |