groundwork-delta-murex.vercel.app

{
  "type": "object",
  "properties": {
    "room": {
      "type": "string",
      "description": "Room name or id."
    },
    "dry_run": {
      "type": "boolean",
      "description": "Resolve the layout and report where everything would land and what it would clash with, WITHOUT changing the drawing. Use this to check an arrangement before committing it, rather than placing, inspecting and deleting."
    },
    "verbosity": {
      "type": "string",
      "description": "How much to report back.",
      "enum": [
        "quiet",
        "diff",
        "full"
      ]
    },
    "items": {
      "type": "array",
      "description": "Items in order. Each may refer to any earlier one.",
      "items": {
        "type": "object",
        "properties": {
          "symbol": {
            "type": "string",
            "description": "Symbol id from list_symbols."
          },
          "as": {
            "type": "string",
            "description": "Name this item so later items can refer to it as '$name'."
          },
          "name": {
            "type": "string",
            "description": "Label for the placed object."
          },
          "against": {
            "type": "string",
            "description": "Put it against this side of the room, facing inward.",
            "enum": [
              "N",
              "E",
              "S",
              "W",
              "any"
            ]
          },
          "beside": {
            "type": "string",
            "description": "Place it beside this item, e.g. '$bed'."
          },
          "side": {
            "type": "string",
            "description": "Which side of that item, from that item's own point of view.",
            "enum": [
              "left",
              "right",
              "front",
              "back"
            ]
          },
          "align": {
            "type": "string",
            "description": "How to line the two up along the shared edge (default back).",
            "enum": [
              "front",
              "center",
              "back"
            ]
          },
          "around": {
            "type": "string",
            "description": "Ring this item, e.g. '$table'. Each copy turns to face it."
          },
          "count": {
            "type": "number",
            "description": "How many copies, for 'around'."
          },
          "between": {
            "type": "array",
            "description": "Midway between two items.",
            "items": {
              "type": "string",
              "description": "An item reference."
            }
          },
          "group": {
            "type": "string",
            "description": "Items sharing a group are treated as one arrangement — no clearance or overlap complaints between them. 'around' groups automatically."
          },
          "facing": {
            "type": "string",
            "description": "Turn to face this item, overriding the relation's own rotation."
          },
          "at": {
            "type": "object",
            "description": "Explicit position, when no relation fits.",
            "properties": {
              "x": {
                "type": "number"
              },
              "y": {
                "type": "number"
              }
            },
            "required": [
              "x",
              "y"
            ]
          },
          "rotation": {
            "type": "number",
            "description": "Explicit rotation in degrees."
          },
          "gap": {
            "type": "number",
            "description": "Gap to the related item, in mm."
          }
        },
        "required": [
          "symbol"
        ],
        "additionalProperties": false
      }
    }
  },
  "required": [
    "room",
    "items"
  ],
  "additionalProperties": false
}