spritekiln — Claude Code rule: what it does, install
spritekiln is a Claude Code rule for building SpriteKiln sprites from YAML specs. It activates on files matching specs/**/*.yaml.
MIT ★ 177 updated 2026-11-12
.cursor/rules/spritekiln.mdcWhat spritekiln does
The spritekiln rule defines how SpriteKiln sprites are created and edited from YAML specifications. A spec can describe the skeleton, SDF primitives, materials, palette, and animations; SpriteKiln then produces animated 8-direction pixel art with an atlas, JSON, normal maps, and emissive maps.
For an asset task, the agent reads docs/agent/workflow.md, docs/agent/style.md, and docs/agent/spec.md, then consults the modeling, animation, and art-direction notes as needed. Each edit is followed by spritekiln validate <spec>. Preview work uses spritekiln pose <spec> --dirs all, while the final output uses spritekiln render.
A session starts with spritekiln style; when no style has been recorded, the style questions in docs/agent/style.md are answered before generation. Content under out/ is generated and must not be edited. Export uses the engine configured in spritekiln.toml; an MCP client can access the tool operations through spritekiln mcp.
What it helps with
- describe a sprite in a YAML specification
- validate a spec after editing it
- inspect poses across all directions
- check the motion of an animation clip
- export a render to the game engine
Example prompts for the agent
- Create a sprite from
specs/hero.yamland follow the project's recorded style. - After editing
specs/hero.yaml, validate it and show which directions changed. - Check the motion of the
walkclip inspecs/hero.yaml, then make the final render.
How to install spritekiln
Manually: put the files in place
.cursor/rules/spritekiln.mdcFrontmatter: description, globs, alwaysApply
Manually: put the files in place
.claude/rules/spritekiln.mdThe paths frontmatter field limits the files: move globs from the source into paths
AGENTS.md
Codex reads AGENTS.md: paste the rule text there
Manually: put the files in place
.github/instructions/spritekiln.instructions.mdThe applyTo field sets which files it applies to: move globs from the source into applyTo
Manually: put the files in place
.devin/rules/spritekiln.mdManually: put the files in place
.clinerules/spritekiln.mdStep by step, with commands for each platform: Cursor rules: .mdc files, four modes and what replaced .cursorrules
Questions about spritekiln
How do I install spritekiln in Claude Code?
Add the rule file at .claude/rules/spritekiln.md.
What does spritekiln do?
The rule sets a workflow for SpriteKiln sprites defined in YAML, including asset review, pose previews, validation, rendering, and export.
What does spritekiln need to work?
The SpriteKiln commands spritekiln style, spritekiln validate, spritekiln pose, and spritekiln render are required for the described workflow. Export uses the engine configured in spritekiln.toml; MCP operations are available through spritekiln mcp with an MCP client.
Source text
spritekiln.mdc · MIT
--- description: Making and editing SpriteKiln sprites (YAML specs -> 8-direction pixel art) globs: specs/**/*.yaml alwaysApply: false --- ## SpriteKiln assets Sprites in this project are made with SpriteKiln: a YAML spec (skeleton, SDF primitives, materials, palette, animations) is rendered into animated 8-direction pixel art (atlas + JSON + normal/emissive maps). Read before working on an asset: `docs/agent/workflow.md` (commands and the working loop), `docs/agent/style.md` (the project's art style) and `docs/agent/spec.md` (the spec format). Then, as needed: `docs/agent/modeling.md`, `docs/agent/splash-to-model.md`, `docs/agent/animation.md`, `docs/agent/art-direction.md` and `docs/agent/recipe.md` (the modeler → art director → animator recipe). Rules that matter: - Art style first: run `spritekiln style` before the first asset of a session. If no style is recorded, interview the user with the questions of `docs/agent/style.md` and record the answers before generating anything. Follow the recorded style in every asset; change it only when the user explicitly asks. - Run `spritekiln validate <spec>` after every edit; problems come with file:line:column. - Iterate with `spritekiln pose <spec> --dirs all` (about 1 s per direction); `spritekiln render` only at the end. After an edit to a model you have already seen whole, `--changes` shows only the directions that changed. - Tie each `must_keep` trait of the `brief` to its parts in `review.keep`: QA then says where it stops reading. - Judge a clip's motion on `spritekiln arcs <spec> --anim <clip>` before its contact sheet. - A character's head and hair are decided in its `brief.head` and judged up close with `spritekiln pose <spec> --focus head --dirs all`: on a normal preview a face is a few pixels. - Never call something visual good without looking at the PNG. If you cannot see images, use the numbers of `spritekiln review` (value, contrast, pixels per material, IoU) and `qa.json`. - Keep the camera pitch, light and `camera.scale` shared by every asset of the game. - Outputs under `out/` are generated: never edit them. - `spritekiln export <spec>` hands a render to the engine configured in `spritekiln.toml`. - With an MCP client, `spritekiln mcp` serves these operations as tools that return images and JSON.
© LucasJRamos · MIT · LucasJRamos/spritekiln