Install

git clone https://github.com/pinionfall/engine.git pinionfall
cd pinionfall
npm ci
gh auth login          # once per machine, if you have not already
npm run setup:assets   # about 2.2 GB: textures, models, audio, props, baked data
npm run dev            # http://localhost:5173

setup:assets downloads the asset bundles of the release your checkout is on (the version in package.json), checks each tarball it downloads against the release’s SHA256SUMS and extracts it in place. It records what it installed in .assets-installed.json, so running it again only touches bundles that changed. Downloads are cached per release in .asset-cache/, which you can delete afterwards.

npm run setup:assets -- v2026.09.11   # the assets of a specific release
npm run setup:assets -- --force       # extract every bundle again
node scripts/setup/fetch-assets.mjs --from ../release-assets   # offline, from downloaded tarballs

A --from directory holds the release’s tarballs and its SHA256SUMS (and, to update only changed bundles, its release-manifest.json).

Written by release:site-sync from SETUP.md at v2026.09.22. Edit the engine document, not this page.