# shallot

> webgpu game engine. fast by default, instant iteration, runs where webgpu does.

The source is the reference: every public export carries a JSDoc contract, and there is no docs site to drift from it. Two files carry the consumer surface. Read the first before writing a project; grep the second for the problem you have.

## Read

- [Consumer contract](https://raw.githubusercontent.com/dylanebert/shallot/50cf366/packages/shallot/AGENTS.md): commands, the ECS and plugin conventions, the GPU, render, physics and verify rules. Ships in the npm package as AGENTS.md.
- [Examples index](https://raw.githubusercontent.com/dylanebert/shallot/50cf366/examples/AGENTS.md): one line per recipe and showcase project, with the concept each teaches.
- [README](https://raw.githubusercontent.com/dylanebert/shallot/50cf366/README.md): quick start, live demos, building from source.

## Start

```
bun create shallot my-game
cd my-game
bun install
bunx shallot dev
```

`bunx shallot verify` boots the project in a headless browser and exits 0 or nonzero, so a change can be checked without a person watching.

## Links

- Source: https://github.com/dylanebert/shallot
- Package: https://www.npmjs.com/package/@dylanebert/shallot
- Demos: https://dylanebert.com/shallot/
- Brand: https://dylanebert.com/shallot/brand/