Skip to content

Versions and stability ​

Pawn. follows semver for 0.x versions:

  • A patch fixes. 0.1.0 to 0.1.1 changes no public API.
  • A minor may break. 0.1.x to 0.2.0 may change or remove public API. Every break is listed in the package's CHANGELOG.md, with what to change.
  • Prereleases break between themselves. Until 0.1.0 every version is 0.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 import exports and no require.
  • 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/three next to three: without it, the three.js types in the Pawn. API are any, silently when skipLibCheck is on (as in the starter). Its versions follow three's.

Peer dependencies ​

  • koota is pinned to one minor, ^0.6.6 today; install 0.6.6 exactly 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, below 0.200.0; the repository tests with 0.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.