store_design
Saves a named boat design spec on the server, replacing any existing design with that name, so later edits need only changes; returns the stored file path.
Instructions
Keep a design spec on the server without writing a vehicle, so later calls can send only changes. Typical loop: store_design("Iowa", spec=...) once, then preview_hull(design="Iowa", patch=[...]) to try a change and store_design("Iowa", design="Iowa", patch=[...]) to keep it. Replaces any stored design of that name; save_hull(name, design=name) writes the vehicle when ready. design=X copies all of draft X: its spec, the parts added with edit_parts, and its wires and pipes (a patch that removes a part they use makes later calls ask you to reconnect it). Undo history is not copied. Stored designs are plain JSON files that every call re-reads, so editing one on disk takes effect at once. Returns the stored file's path.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| name | Yes | Name to store the spec under (letters, digits, spaces, _ - ( ), at most 64); replaces any stored design of that name. | |
| spec | No | Hull spec, partial or full (fields: hull_design_guide topic=spec); merged over preset or design. Lengths in metres. | |
| patch | No | JSON-Patch ops applied last, e.g. [{"op": "replace", "path": "/superstructure/bridge/height", "value": 2.5}]; list items can be named instead of indexed. | |
| design | No | Stored design to start from instead of a preset; names from list_designs. | |
| preset | No | Built-in hull preset to start from, e.g. 'runabout'; names from list_hull_presets. | |
| spec_path | No | Path to a .json file holding a spec or a stored design, read before spec and patch. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |