hearth.yadneshsalvi.com

{
  "type": "object",
  "properties": {
    "item": {
      "type": "string",
      "minLength": 1,
      "description": "Placed item id (e.g. sofa-1) or its name. Use selected for the human's current selection."
    },
    "anchor": {
      "type": "object",
      "properties": {
        "wall": {
          "description": "Wall the back goes against: north, east, south, west, or a wall id such as w2.",
          "type": "string",
          "minLength": 1
        },
        "along": {
          "description": "Position along that wall: start, center, end, or a number of cm from the wall's start (clockwise).",
          "anyOf": [
            {
              "type": "string",
              "enum": [
                "start",
                "center",
                "end"
              ]
            },
            {
              "type": "number"
            }
          ]
        },
        "facing": {
          "description": "What the front faces: an item id or name, room_center, wall:<side>, or window:<id>.",
          "type": "string",
          "minLength": 1
        },
        "next_to": {
          "description": "Item id or name to sit beside.",
          "type": "string",
          "minLength": 1
        },
        "side": {
          "description": "Side of next_to to use: left, right, front or behind (from that item's point of view).",
          "type": "string",
          "enum": [
            "left",
            "right",
            "front",
            "behind"
          ]
        },
        "gap_cm": {
          "description": "Gap in cm between the two items (default 10).",
          "type": "number",
          "minimum": 0
        },
        "centered": {
          "description": "true to centre the item in the room.",
          "type": "boolean"
        },
        "under": {
          "description": "window:<id> to centre the item under that window with its back to the wall.",
          "type": "string",
          "minLength": 1
        }
      },
      "additionalProperties": false,
      "description": "Where to put it, in words: wall + along, facing, next_to + side + gap_cm, centered, or under a window. Preferred over pos."
    },
    "pos": {
      "type": "object",
      "properties": {
        "x": {
          "type": "number",
          "description": "Footprint centre x in cm; positive points east."
        },
        "y": {
          "type": "number",
          "description": "Footprint centre y in cm; positive points south."
        }
      },
      "required": [
        "x",
        "y"
      ],
      "additionalProperties": false,
      "description": "Raw footprint centre in cm, room-local (origin north-west corner, x east, y south). Use anchor when possible."
    },
    "delta_cm": {
      "description": "Shift by this many cm: x positive = east, y positive = south.",
      "type": "object",
      "properties": {
        "x": {
          "description": "East-west shift in cm; positive is east.",
          "type": "number"
        },
        "y": {
          "description": "North-south shift in cm; positive is south.",
          "type": "number"
        }
      },
      "additionalProperties": false
    },
    "rotation": {
      "type": "number",
      "enum": [
        0,
        90,
        180,
        270
      ],
      "description": "0, 90, 180 or 270 degrees clockwise; 0 = front faces south."
    },
    "rotate_by": {
      "description": "Turn by 90 (clockwise), -90 (counter-clockwise) or 180 degrees.",
      "type": "number",
      "enum": [
        90,
        -90,
        180
      ]
    },
    "room": {
      "description": "Move the item into this room (id or name). Defaults to its current room.",
      "type": "string",
      "minLength": 1
    }
  },
  "required": [
    "item"
  ],
  "additionalProperties": false
}