Appearance
Versions and stability
Pawn. follows semver for 0.x versions:
- A patch fixes.
0.1.0to0.1.1changes no public API. - A minor may break.
0.1.xto0.2.0may change or remove public API. Every break is listed in the package'sCHANGELOG.md, with what to change. - Prereleases break between themselves. Until
0.1.0every version is0.1.0-alpha.N, and any of them may break.
All @pawnjs/* packages share one version. Install the same version of each, as bun create pawn does.
Public API is what a package exports and these docs describe. Direct access to a library underneath, such as physics.rapierWorld, follows that library's versions instead.
Modules and environments
- ESM only. The packages have
importexports and norequire. - Browsers with WebGL 2, which three.js needs.
- Bun and Node. The packages load in Node's ESM loader; tests and headless engines are tested with Bun, as these docs show. The starter runs with Bun or Node 20.12 or later, and its templates build with Vite 8.
- React 19 or later, for
@pawnjs/react. - TypeScript needs
@types/threenext tothree: without it, the three.js types in the Pawn. API areany, silently whenskipLibCheckis on (as in the starter). Its versions followthree's.
Peer dependencies
- koota is pinned to one minor,
^0.6.6today; install0.6.6exactly for the koota patch. Its types (Entity,World,Trait) are part of the Pawn. API, so a new koota minor comes with a new minor of Pawn. - three is supported from
0.186.0, below0.200.0; the repository tests with0.186.1. A version of Pawn. that tests an older or newer one widens the range.
Packages not on npm yet
A package whose page says "Not on npm yet" is experimental. Until it is published, its API may break in any version.