Agents / skills / oxframe-check

oxframe-check skill

Read and fix oxframe check reports: storyboard.png and report.json with named rules (out_of_frame, text_overflow, too_fast, low_contrast, dead_time…). Use after any change to an oxframe scene, or when check exits 1.

npx skills add oxygenframe/oxframe-sdk

Installs every oxframe skill into Claude Code, Codex, Cursor, Copilot and other agents. The source is skills/oxframe-check in oxframe-sdk.

Uses the oxframe skill (workflow, full API cheat sheet); install both with npx skills add oxygenframe/oxframe-sdk.

oxframe check type-checks the project, runs every scene and writes out/check/storyboard.png and out/check/report.json. It exits 1 on errors; warnings do not fail it. oxframe --json check prints the report on stdout.

Each issue has rule, severity, a time range, a node and file:line. Fix errors first, then warnings, then run check again until it exits 0. Look at the storyboard before reporting: a clean report is necessary, not sufficient.

RuleWhat it meansUsual fix
out_of_frameA node leaves the frame or the safe areaSmaller size, pct(), to_edge(Edge::…), or move the camera
text_overflowText wider than its box or the frameShorter text, .caption()/.body() instead of a heading, a wider box
text_overlap / covers_textText on top of text, or a shape over textnext_to, a Layout, or fade one out first
low_contrastText too close to its backgroundA theme role: .fill(Text) on Surface, OnAccent on Accent
too_fastText not on screen long enough to read, or a large move too quickwait_for(…) after it appears, a longer tween
dead_timeNothing changes for too longShorten the wait or animate something
voice_cut / voice_overlapA spoken line runs past the scene, or two lines overlapline.await before the scene ends; start the next line after
shader_error, param_unknown, shader_slow, input_cycleShader problemsSee the Shaders section of the cheat sheet
nondeterministicTwo paints of one frame differDraw only from signals and ctx.time(); randomness from ctx.rng(seed)
video_unavailableA clip cannot be openedCheck the path and the video feature; install ffmpeg

oxframe inspect --at <seconds> prints the node tree (kind, name, bounds, text) when the picture is unclear; --graph adds the render passes. oxframe snapshot --at <seconds> writes one full-size frame. Thresholds live in oxframe.toml under [check]; change them only when the user asks.