# Pixel Studio

> The README, what changed in each release, and how to contribute.

**Agents describe characters; the engine draws them as pixel art at every level of detail; websites play them with one tag.**

Docs, demos and the playground: **[pixel-studio.sh](https://pixel-studio.sh)**.

| Package | What | Install |
|---|---|---|
| [`@pixel-studio/core`](https://github.com/pavelpascari/pixel-studio/tree/main/packages/pixel-studio) | The engine, the `pixel` CLI, the figure library, examples and the reference docs. | `npm i @pixel-studio/core` |
| [`@pixel-studio/runtime`](https://github.com/pavelpascari/pixel-studio/tree/main/packages/runtime) | `<pixel-sprite>` and `<pixel-stage>`: the web components that play finished sprites on a page. No dependencies. | `npm i @pixel-studio/runtime` |

The two are always released together, with the same version; `@pixel-studio/core` depends on exactly that runtime.
Start with [getting started](/docs/reference/getting-started/). Changes are in the
[changelog](/docs/project/changelog/).

## This repository

| Path | What |
|---|---|
| [`packages/pixel-studio/`](https://github.com/pavelpascari/pixel-studio/tree/main/packages/pixel-studio) | The `@pixel-studio/core` package ([README](https://github.com/pavelpascari/pixel-studio/blob/main/packages/pixel-studio/README.md), [docs](/docs/reference/)). |
| [`packages/runtime/`](https://github.com/pavelpascari/pixel-studio/tree/main/packages/runtime) | The `@pixel-studio/runtime` package. |
| [`studio/`](https://github.com/pavelpascari/pixel-studio/tree/main/studio) | The studio, the figure viewer, the goose workbench and the URL-driven playground. |
| [`demo/`](https://github.com/pavelpascari/pixel-studio/tree/main/demo) | Demo pages: a landing page, a flock on a lawn, characters on cards, a tiny runner game. |
| [`website/`](https://github.com/pavelpascari/pixel-studio/tree/main/website) | pixel-studio.sh (Astro and [astro-project-site](https://github.com/pavelpascari/astro-project-site), on Cloudflare Workers). |
| [`docs/research/`](https://github.com/pavelpascari/pixel-studio/tree/main/docs/research) | Research notes behind the design. |
| [`scripts/`](https://github.com/pavelpascari/pixel-studio/tree/main/scripts) | The dev server, the demo build, the version script and browser checks. |

```bash
npm install          # links the two packages; no third-party dependencies
npm test             # both packages
npm run build:demo   # the demo's bundles and posters
npm run studio       # http://localhost:5173/studio/ , /demo/
```

See [CONTRIBUTING.md](/docs/project/contributing/). Released under the [MIT License](https://github.com/pavelpascari/pixel-studio/blob/main/LICENSE). Motion data comes only from
public-domain and openly licensed sources, each credited in
[references/CREDITS.md](https://github.com/pavelpascari/pixel-studio/blob/main/packages/pixel-studio/references/CREDITS.md).
