# AGENTS.md

Phaser is a fun, free and fast 2D game framework for making HTML5 games for desktop and mobile web browsers, supporting Canvas and WebGL rendering.

## Setup

```
npm ci
```

## Commands

```
npm run build     # produce a build
npm run test      # run the test suite, must pass before any commit
npm run lint      # lint
npm run beta
npm run help
npm run watch
npm run watchns
npm run dist
```

## Layout

- `src/`     2182 source files
- `tests/`   1099 source files
- `scripts/` 13 source files
- `config/`  3 source files
- `dist/`    3 source files
- `types/`   3 source files

## Conventions

- Tests live alongside the code they cover, following `scripts/tsgen/test/bin/game.js`.
- CI defines what passing means. See `.github/workflows/lock-comments.yml`, and keep it green.
- TODO: add the two or three conventions a newcomer always gets wrong here.

## Gotchas

- Generated output is committed (`dist/`). Search will return the compiled copy, so edit the source, not that.
- `dist/phaser.esm.js` is 8345KB. It will not fit comfortably in context, so read it in parts.

---

Drafted by agentreadme.com from what is in this repository. Everything marked TODO
needs a human. Check it in as AGENTS.md at the root.