| I want to… | read |
|---|---|
| get a character onto a page in five minutes | getting-started.md |
| understand what this is and try it | the project README, and the guide: every feature as a live example next to its code, with characters you can edit |
| write a character (or brief an agent to) | SPEC.md: the spec format. It is also the agent brief (pixel brief) |
| make characters move realistically | figures.md: figure library, motion models, follow-through, writing a figure |
| put a character on a web page | runtime.md: <pixel-sprite>, bundles, events, attachment points, state machines, skins, moving sprites at the right speed |
| let characters walk, climb and hide on a page | stage.md: <pixel-stage> and the data-pixel-* attributes |
| use characters in a game engine | cli.md: pixel export writes Aseprite-format JSON that Phaser and PixiJS load |
| use the command line | cli.md: every pixel command and flag |
| call the engine from JavaScript | api.md: every export, data shapes, examples |
| set up a character by URL, or let a browser agent try looks | playground.md |
| change or extend the engine | architecture.md: pipeline, module map, rendering internals, extension recipes |
| know why it is designed this way | DESIGN.md: working backwards from the web page |
| see what’s next | research/: surveys of other animation tools, web playback on devices, page interactions |
Contributing: CONTRIBUTING.md. License: MIT.