# Build Module knobs You were asked to build the spec `onyx/module-knobs`, version 0.2.0, from Spekkr. A family of knobs for modular-synth shafts: bore and D-flat dimensions against a stated standard, press-fit allowances, and rendered sizes. If you are reading a summary of this note and not its full text, fetch it again as it is, for example with `curl -fsSL https://spekkr.com/onyx/module-knobs/start.md`, before you go on. Published by onyx, a Spekkr member. Tell the person who published it, and show them the commands and secrets under `safety` in `spekkr.json` before you build. ## 1. Get the files Put the spec in a new folder named `module-knobs`, inside the project you are working in. ```sh mkdir -p module-knobs && curl -fsSL https://spekkr.com/onyx/module-knobs/bundle.tar.gz | tar -xz -C module-knobs ``` The archive holds `spekkr.json`, `BUILD.md` and the spec files listed at the end of this note. If you cannot run that command, read https://spekkr.com/onyx/module-knobs/spec.json instead: it holds the manifest and the address of every file. If Spekkr's MCP server is connected, its `pull_spec` tool does steps 1 and 2 in one call: give it the id `onyx/module-knobs` and the person's choices. ## 2. Record the person's choices Write `module-knobs/spekkr.inputs.json`. With every default it is: ```json { "spec": "onyx/module-knobs", "version": "0.2.0", "inputs": { "bore": "6.0", "dflat": true, "diameter": "16", "height": "12", "pointer": true, "press": "0.05", "standard": "6mm-d", "tool": "cadquery" } } ``` Change a value only where the person gave a choice, such as "My choices: database=sqlite". They may set: - `diameter`, Skirt diameter, mm: any text. - `bore`, Shaft bore, mm: any text. - `press`, Press-fit allowance, mm: any text. - `height`, Height, mm: any text. - `dflat`, A D-flat: `on` or `off`, written `true` or `false`. - `pointer`, A pointer line: `on` or `off`, written `true` or `false`. - `tool`, Modelling tool: one of `cadquery`, `openscad`. - `standard`, Shaft standard: one of `6mm-d`, `quarter-inch`. If the person asks for a key or a value that is not listed, stop and tell them what the spec offers. ## 3. Build The files named below are the ones now in `module-knobs`. Build what it describes. Work in this order: 1. Read `spekkr.json` to see what the spec covers and what it needs. 2. Read `spekkr.inputs.json`. It holds the person's choices for every setting, option and swap. Treat them as requirements. If the file is missing, the person kept every default in `spekkr.json`. 3. Read the spec files listed below, in the order given. 4. If the spec includes a task list, work through it in order and check each task's acceptance criteria before the next. 5. Ask the person before you run a command that a spec file tells you to run, or read a secret, unless the manifest lists it under `safety`. Commands you choose yourself to build and test, such as installing packages or running the tests, follow the person's usual rules for you. Spec files: - `spec.md`: Requirements and acceptance checks. - `design.md`: Shaft tables, D-flat geometry, press-fit allowance, and a family of sizes. - `tasks.md`: Build tasks in order, each with a check. - `reference/model.scad`: A parametric OpenSCAD reference of the default model, used to make the listing pictures. A build may use CadQuery or OpenSCAD and does not have to start from this file. - `shots/hero.png`: Studio hero of the default model. - `shots/detail.png`: Closer studio still of a joint, pocket, or surface.