Reference · Looking

pxart sheet

Many frames (.px/.png files, or every .px under a directory) side by side on one PNG, each labeled with its id, size and color count.

sheet FILE|DIR... -o sheet.png [--scale 8] [--cols 8] [--grid] [--variant V] [--bg COLOR] [--fit] [--align bottom|pivot] [--rows cols|group] [--slots N|K=I] [--exclude GLOB] [--dry-run]
usage: pxart sheet [-h] [-o O] [--scale SCALE] [--cols COLS] [--bg BG] [--grid] [--variant V]
                   [--slots N|K=I] [--fit] [--align {bottom,pivot}] [--rows {cols,group}]
                   [--dry-run] [--exclude GLOB]
                   files [files ...]

  sheet FILE|DIR... -o sheet.png [--scale 8] [--cols 8] [--grid] [--variant V] [--bg COLOR]
        [--fit] [--align bottom|pivot] [--rows cols|group] [--slots N|K=I] [--exclude GLOB]
        [--dry-run]
      Many frames (.px/.png files, or every .px under a directory) side by side on one PNG, each
      labeled with its id, size and color count.

positional arguments:
  files

options:
  -h, --help              show this help message and exit
  -o O
  --scale SCALE
  --cols COLS
  --bg BG                 a flat color behind each frame (default: a grey checkerboard)
  --grid
  --variant V             draw every frame in V; each label says so (idle/0%night), as FILE%V's do, and an argument's own %VARIANT wins
  --slots N|K=I           draw the frames in N combinations of their slots' colors (the base, then others, the same every run), or with K=I,... those slots' colors by index, 0 the base: 'N,f=2' mixes both (help slots)
  --fit                   each cell its own frame's size, each row its tallest frame's
  --align {bottom,pivot}  pivot: line up each animation's frames by pivot, as anim does (default: bottom)
  --rows {cols,group}     group: one animation group per row, wrapping within it past --cols (default: --cols a row)
  --dry-run               print the readout and each output's size and layout, write nothing ('(dry run; nothing written)'); -o may be left off
  --exclude GLOB          leave out files whose name or path under DIR matches GLOB, or under a matching directory (repeatable)

      Compare any mix of .px/.png frames, labeled with id, WxH and color count. A directory
      stands for every .px under it, recursively, sorted by path (PNGs in it are left out, a
      sheet rendered there too). --exclude GLOB (repeatable) leaves files out: one whose
      name or path under the directory matches ('_*.px', 'wip/*.px'), or every file under a
      directory that does ('wip'). A glob that leaves out every file is E_FILE. A palette
      file (no frames) among the inputs, a directory's or a glob's, is skipped with a note
      ('note: sheet skips palette.px: a palette file, no frames'); given alone it is
      E_NO_FRAMES. Every cell is the largest frame's size (a frame over 8x the median
      frame's area gets a note); --fit makes each cell its own frame's width (or its
      label's, if wider) and each row as tall as its tallest frame, --cols cells to a row,
      frames bottom-aligned in their row. A PNG whose four corners are exactly the --bg
      color (a scene rendered with the same --bg) doesn't count that color: it's the
      backdrop. Frames with the same id from different files are labeled with their file's
      stem in front (hero:idle/0, beast:idle/0); render and anim label them the same way.
      --align pivot lines up each animation group's frames by pivot, as anim and onion do:
      the group's frames are drawn on one canvas, every pivot on the same pixel. The
      default, --align bottom, bottom-aligns each frame in its cell.
      --rows group starts a row for each animation group (one file's walk/down, then its
      walk/up, ...; a file's top-level frames share one; a PNG has its own) and wraps within
      a group only when it has more than --cols frames: 'sheet party.px --fit --rows group
      --align pivot -o party.png' is one walk per row. The default, --rows cols, fills each
      row with --cols frames.

See also, in pxart help all: FORMAT: variants (@variant, %VARIANT); LOOKING: centering
  (frames of different sizes, --bg, --dry-run).

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

This is the output of pxart help sheet. The other looking commands and their shared notes are in pxart help LOOKING.

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