mcpixels.app

read_canvas

Read the canvas back in the same {origin, palette, rows} format draw_pixel_art accepts, so you can read, edit the rows and draw them straight back. Here "." marks an empty cell, but drawn back it preserves the destination — use "-" to erase. Omit region for an overview of everything painted, downscaled to at most 48 characters a side; name a region for native resolution up to 64x64. A larger region comes back exact as "format":"rle" runs when it compresses well enough — up to 262144 cells — and is block-downscaled only when it does not. Always check "format" before reading the rows. "exact" is true only when scale is 1 AND the region holds at most 52 distinct colors; rarer colors fold into the nearest kept one. When it is false the rows are an approximation: read smaller regions in turn before relying on them. Every read also reports the state you need to plan with — "painted"/"empty"/"colors" counts that stay exact however coarse the rows are, plus "art", "selection", "view", "history" and the full "limits" table. Read once before a large draw and you will not have to learn a cap by hitting it.

Input schema

{
  "type": "object",
  "properties": {
    "region": {
      "type": "array",
      "items": {
        "type": "integer",
        "minimum": -512,
        "maximum": 511
      },
      "minItems": 4,
      "maxItems": 4,
      "description": "[x0, y0, x1, y1] rectangle to read, inclusive, corners in any order. Defaults to everything painted."
    },
    "shade": {
      "type": "boolean",
      "description": "Also return \"shaded\": a thumbnail at most 48 characters a side, drawn \".:-=+*#%@\" dark to light with space for empty. It shows how light each cell is rather than which color it is, so you can see the composition instead of decoding it. For looking at, not for drawing back."
    }
  },
  "additionalProperties": false
}