lares-woad.vercel.app

{
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "description": "What to call the room, e.g. 'Living room'.",
      "maxLength": 60
    },
    "widthMm": {
      "type": "integer",
      "description": "East-west size of the room in millimetres. 4.2 metres is 4200.",
      "minimum": 1000,
      "maximum": 20000
    },
    "depthMm": {
      "type": "integer",
      "description": "North-south size of the room in millimetres. 3.8 metres is 3800.",
      "minimum": 1000,
      "maximum": 20000
    },
    "openings": {
      "type": "array",
      "description": "Every door and window in the room.",
      "items": {
        "type": "object",
        "description": "A door or window in one of the room's walls.",
        "properties": {
          "type": {
            "type": "string",
            "enum": [
              "door",
              "window"
            ],
            "description": "Door or window."
          },
          "wall": {
            "type": "string",
            "enum": [
              "north",
              "east",
              "south",
              "west"
            ],
            "description": "Which wall the opening sits in."
          },
          "offsetMm": {
            "type": "integer",
            "description": "Distance in millimetres from the clockwise start of that wall to the near edge of the opening. Walls run clockwise from the north-west corner.",
            "minimum": 0,
            "maximum": 20000
          },
          "widthMm": {
            "type": "integer",
            "description": "Width of the opening in millimetres.",
            "minimum": 300,
            "maximum": 6000
          },
          "heightMm": {
            "type": "integer",
            "description": "Head height for a door, or sill-to-head height for a window, in millimetres.",
            "minimum": 300,
            "maximum": 3000
          },
          "hingeSide": {
            "type": "string",
            "enum": [
              "start",
              "end"
            ],
            "description": "Doors only. 'start' hinges at the end of the opening nearest the wall's clockwise start; 'end' hinges at the far end."
          },
          "swingDirection": {
            "type": "string",
            "enum": [
              "inward",
              "outward"
            ],
            "description": "Doors only. 'inward' swings into this room and its arc must be kept clear; 'outward' swings away."
          }
        },
        "required": [
          "type",
          "wall",
          "offsetMm",
          "widthMm"
        ],
        "additionalProperties": false
      },
      "maxItems": 12
    },
    "obstructions": {
      "type": "array",
      "description": "Fixed things furniture cannot occupy.",
      "items": {
        "type": "object",
        "description": "A fixed thing furniture cannot occupy, such as a bulkhead or a column.",
        "properties": {
          "label": {
            "type": "string",
            "description": "Short natural-language label, e.g. 'corner bulkhead'.",
            "maxLength": 80
          },
          "kind": {
            "type": "string",
            "enum": [
              "bulkhead",
              "column",
              "radiator",
              "stair",
              "fireplace",
              "other"
            ],
            "description": "What kind of fixed thing it is."
          },
          "x": {
            "type": "integer",
            "description": "Millimetres east of the room's north-west corner.",
            "minimum": 0,
            "maximum": 20000
          },
          "y": {
            "type": "integer",
            "description": "Millimetres south of the room's north-west corner.",
            "minimum": 0,
            "maximum": 20000
          },
          "widthMm": {
            "type": "integer",
            "description": "East-west size in millimetres.",
            "minimum": 50,
            "maximum": 20000
          },
          "depthMm": {
            "type": "integer",
            "description": "North-south size in millimetres.",
            "minimum": 50,
            "maximum": 20000
          }
        },
        "required": [
          "label",
          "kind",
          "x",
          "y",
          "widthMm",
          "depthMm"
        ],
        "additionalProperties": false
      },
      "maxItems": 12
    },
    "keepPlacements": {
      "type": "boolean",
      "description": "Keep the existing furniture when redefining the room. Leave this off when describing a new room, since old coordinates will rarely still make sense."
    }
  },
  "required": [
    "widthMm",
    "depthMm"
  ],
  "additionalProperties": false
}