theater.needle.tools

{
  "type": "object",
  "properties": {
    "stage": {
      "type": "string",
      "description": "Which scene. Omit for the one being shown."
    },
    "cast": {
      "type": "array",
      "description": "Who stands where.",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "description": "The layer."
          },
          "x": {
            "type": "number",
            "description": "Move them here (canvas x, top-left corner) while casting — the same world units piece_list reports and piece_move takes. LEAVE IT OUT to cast them exactly where they stand: the arrangement on the canvas usually IS the blocking."
          },
          "y": {
            "type": "number",
            "description": "Canvas y (top-left corner). Leave out to keep their spot."
          },
          "width": {
            "type": "number",
            "description": "Resize them while casting (canvas units; height follows their shape). Clamped to 0.5–1.5× the current width per call. Leave out to keep their size — compare against piece_list's widths."
          },
          "rotation": {
            "type": "number",
            "description": "Degrees, clockwise."
          },
          "entrance": {
            "type": "string",
            "enum": [
              "fade",
              "left",
              "right",
              "above",
              "below",
              "grow",
              "none"
            ],
            "description": "How it arrives when the scene builds up."
          },
          "flip": {
            "type": "boolean",
            "description": "Mirror the artwork so they face the other way. A cut-out faces whichever way it was drawn — look with show_look to see which — and two people in conversation should face each other. The \"turn\" move flips somebody mid-scene."
          },
          "as": {
            "type": "string",
            "description": "Who this picture is playing — 'the grandmother', 'the wolf'. It is what the credits call them at the end, beside their picture, so cast everybody who should be thanked."
          },
          "voice": {
            "type": "object",
            "additionalProperties": false,
            "properties": {
              "speed": {
                "type": "number",
                "minimum": 0,
                "maximum": 2,
                "description": "0 is 1×, 1 is the default 1.7×, 2 is 2×."
              },
              "age": {
                "type": "number",
                "minimum": 0,
                "maximum": 1,
                "description": "0 young, 0.5 medium, 1 old."
              },
              "tone": {
                "type": "number",
                "minimum": 0,
                "maximum": 1,
                "description": "0 low, 0.5 medium, 1 high."
              }
            },
            "required": [
              "speed",
              "age",
              "tone"
            ],
            "description": "The character's complete voice: exactly speed, age and tone. For troupe actors, leaving it out chooses a fitting voice from the character; passing it overrides that choice. Vary age and tone across the cast."
          }
        },
        "required": [
          "id"
        ]
      }
    },
    "remove": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Layer ids to take out of this scene. They stay on the canvas."
    }
  }
}