Reference · Checking

pxart check

Check .px and .map files: format errors with a code and location, size, colors, budget and unused keys; one line per file. Exits 1 on any failure.

check FILE|DIR... [--palette P] [--size WxH] [--max-colors N] [--strict] [-v] [--exclude GLOB]
usage: pxart check [-h] [--palette PALETTE] [--size SIZE] [--max-colors MAX_COLORS] [--strict]
                   [-v] [--exclude GLOB] [--tile TILE] [--tileset T.tsj]
                   files [files ...]

  check FILE|DIR... [--palette P] [--size WxH] [--max-colors N] [--strict] [-v] [--exclude GLOB]
      Check .px and .map files: format errors with a code and location, size, colors, budget and
      unused keys; one line per file. Exits 1 on any failure.

positional arguments:
  files

options:
  -h, --help               show this help message and exit
  --palette PALETTE
  --size SIZE
  --max-colors MAX_COLORS
  --strict
  -v, --verbose            a line per frame, not per file
  --exclude GLOB           leave out files whose name or path under DIR matches GLOB, or under a matching directory (repeatable)
  --tile TILE              a world source's tile size: WxH, or N for NxN (default 16x16)
  --tileset T.tsj          a world source's rooms may draw with this tileset too (repeatable)

      Every format error with a code and location, then size / off-palette colors / color budget /
      unused keys / see-through px. One line per file: 'ok   party.px: 40 frames, 32x32, 16x16,
      3-14c', or 'FAIL party.px: 2 of 40 frames fail' and a line for each of those frames (a file
      of one frame gets that frame's line); -v prints a line for every frame, as
      'ok   party.px:walk/down/0: 32x32 9c'. Notes follow their file's line, and checking more than
      one file ends with a summary: '6 files, 150 frames, 3 warnings' (', 1 failed' when one did;
      a warning is a note line). A directory checks every .px and .map under it, recursively,
      sorted by path; a palette file (no frames) is checked as one: 'ok   palette.px: palette file,
      17 key(s), variants night'. P is a .px, .gpl, .hex, or text of #rrggbb. --strict also
      rejects unknown @sections and @anim/@still lines whose group has no frames (else a note).
      Exit 1 on any failure. --exclude GLOB leaves files out, as for sheet.
      A .map (scene --map) is checked too: every row char has a legend line and every legend
      entry loads as one frame; .world, .tmj: help worlds.
      Non-ASCII chars that look like ASCII (Cyrillic/Greek 'а е о р с х у', fullwidth 'k') get
      a note naming the line, row and column and the letter they pass for.

See also, in pxart help all: FORMAT: still groups (@still GROUP, @still *); FORMAT: paths
  (what a path is read from: the current directory, or a file's own).

pxart help all has the whole reference, pxart help TOPIC one part of it.

This is the output of pxart help check. The other checking commands and their shared notes are in pxart help CHECKING.

This page is built from site/src/data/reference.json in the repository.Edit on GitHub