@makefully/platypus 4.1.1 → 4.1.5

package/CHANGELOG.md

@@ -1,86 +1,122 @@
-# Changelog
-
-All notable changes to this project are documented in this file.
-
-The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
-and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
-
-## [Unreleased]
-
-## [4.1.1] - 2026-06-04
-
-### Added
-
-- GitHub Actions [release workflow](.github/workflows/release.yml): when `package.json` version changes on `main`, builds `lib/*.js` and publishes a GitHub release from [CHANGELOG.md](CHANGELOG.md).
-- `scripts/extract-changelog.mjs` for release note extraction.
-- Vitest tests for `ControllerInput`.
-
-### Changed
-
-- Docs CI ([docs workflow](.github/workflows/docs.yml)) deploys with `GITHUB_TOKEN` instead of an SSH deploy key.
-- `npm run docs` copies `assets/` into `docs/api/` so the README header image works on GitHub Pages.
-- `ControllerInput` JSDoc corrected (was incorrectly documented as `CollectiblesManager`).
-
-### Fixed
-
-- `ControllerInput#unattachControls` now removes the bound pointer listeners registered at setup.
-
-## [4.1.0] - 2026-06-03
-
-### Added
-
-- npm package published as [`@makefully/platypus`](https://www.npmjs.com/package/@makefully/platypus) (UMD build in `lib/` only; `prepack` runs the release build).
-- Webpack 5 build pipeline (`webpack serve`, production and development modes).
-- API documentation tooling: `npm run docs`, `npm run docs:publish`, and [docs/README.md](docs/README.md).
-- Vitest unit tests for core types and components (including `RenderDebug`, `StateMap`, `AABB`, and others).
-- TiledLoader compatibility assessment (`npm run assess:tiled`, [test/tiled/README.md](test/tiled/README.md)).
-- `StateMap#toJSON` (boolean key/value object) and `StateMap#toString` (comma/`!` format compatible with `updateFromString`).
-- `StateMap` constructor support for copying from another `StateMap`.
-
-### Changed
-
-- Package name scoped to `@makefully/platypus`; repository and homepage point at [Makefully-Studios/platypus](https://github.com/Makefully-Studios/platypus).
-- `lib/` is a build artifact (gitignored); clone builds via `npm run build:release`.
-- Upgraded from Webpack 4 to Webpack 5; removed Babel, `worker-loader`, and OpenSSL legacy provider workarounds.
-- `TickerClient` uses native `new Worker(new URL(..., import.meta.url))` again.
-- Internal imports no longer use `import 'platypus'` (relative modules / globals instead).
-- `StateMap` coerces stored values to booleans.
-- README and contributor docs updated for install, development, peers, and publishing.
-- Legacy JSDoc type expressions updated for current JSDoc parsing.
-
-### Fixed
-
-- `RenderDebug` draws each `CollisionBasic` shape from its own `aABB` instead of the combined AABB dimensions.
-- `CollisionGroup` collision grid not updated for non-moving entities with a collision group.
-- `package.json` `engines` field corrected to `engines` (Node `>=20`).
-
-## [4.0.3] - 2026-06-03
-
-### Added
-
-- Vitest test suite and coverage reporting.
-- Tiled format spec catalog and coverage assessment scripts.
-
-### Changed
-
-- Removed legacy `Camera` component; use `HandlerCamera` / `EntityCamera` instead.
-
-### Fixed
-
-- `TimeEvent` scheduling edge case.
-- Test and base-class coverage gaps addressed in core utilities.
-
-## [4.0.1] - 2026-05-28
-
-### Added
-
-- Rotated one-way (`jumpThrough`) collision support on `CollisionShape` / `CollisionBasic`.
-
-### Fixed
-
-- Collision handling when entities have multiple `CollisionBasic` components (`CollisionGroup`).
-- `HandlerCollision` grid updates for grouped, non-moving entities.
-
-## Earlier versions
-
-Tags and history for releases prior to 4.0.x (for example `v2.0.2`) are available in [GitHub releases](https://github.com/Makefully-Studios/platypus/releases) and `git tag`.
+# Changelog
+
+All notable changes to this project are documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [4.1.5] - 2026-06-10
+
+### Added
+
+- ESM build (`lib/platypus.mjs`) as the `import` entry in `package.json` exports; UMD (`lib/platypus.js`) remains the `require` entry.
+
+### Fixed
+
+- Pixi `collectRenderablesWithEffects` crash (`Cannot read properties of undefined (reading 'push')`) when consuming the npm package instead of `/src`: the prebuilt UMD hid Platypus's `pixi.js` sub-imports, so bundlers could omit mask/render pipes that masked sprites need. The ESM entry preserves those imports in the consumer's module graph.
+
+## [4.1.4] - 2026-06-10
+
+### Changed
+
+- Release workflow publishes to npm via trusted publishing (OIDC) instead of `NPM_TOKEN`, avoiding `EOTP` failures when npm 2FA is enabled.
+
+## [4.1.3] - 2026-06-10
+
+### Added
+
+- Release workflow publishes `@makefully/platypus` to npm when `package.json` version changes on `main`.
+
+### Changed
+
+- GitHub Actions workflows use Node.js 24 and action versions with a Node 24 runtime (`actions/checkout@v6`, `actions/setup-node@v6`, `softprops/action-gh-release@v3`, `peaceiris/actions-gh-pages@v4.1.0`).
+
+## [4.1.2] - 2026-06-10
+
+### Added
+
+- `platypus.css` shipped in the npm tarball under `lib/` and exposed as `@makefully/platypus/platypus.css` (release build copies `src/platypus.css`).
+
+### Changed
+
+- README documents the supported CSS import path for npm consumers (replaces v3 `src/platypus.css` imports).
+
+## [4.1.1] - 2026-06-04
+
+### Added
+
+- GitHub Actions [release workflow](.github/workflows/release.yml): when `package.json` version changes on `main`, builds `lib/*.js` and publishes a GitHub release from [CHANGELOG.md](CHANGELOG.md).
+- `scripts/extract-changelog.mjs` for release note extraction.
+- Vitest tests for `ControllerInput`.
+
+### Changed
+
+- Docs CI ([docs workflow](.github/workflows/docs.yml)) deploys with `GITHUB_TOKEN` instead of an SSH deploy key.
+- `npm run docs` copies `assets/` into `docs/api/` so the README header image works on GitHub Pages.
+- `ControllerInput` JSDoc corrected (was incorrectly documented as `CollectiblesManager`).
+
+### Fixed
+
+- `ControllerInput#unattachControls` now removes the bound pointer listeners registered at setup.
+
+## [4.1.0] - 2026-06-03
+
+### Added
+
+- npm package published as [`@makefully/platypus`](https://www.npmjs.com/package/@makefully/platypus) (UMD build in `lib/` only; `prepack` runs the release build).
+- Webpack 5 build pipeline (`webpack serve`, production and development modes).
+- API documentation tooling: `npm run docs`, `npm run docs:publish`, and [docs/README.md](docs/README.md).
+- Vitest unit tests for core types and components (including `RenderDebug`, `StateMap`, `AABB`, and others).
+- TiledLoader compatibility assessment (`npm run assess:tiled`, [test/tiled/README.md](test/tiled/README.md)).
+- `StateMap#toJSON` (boolean key/value object) and `StateMap#toString` (comma/`!` format compatible with `updateFromString`).
+- `StateMap` constructor support for copying from another `StateMap`.
+
+### Changed
+
+- Package name scoped to `@makefully/platypus`; repository and homepage point at [Makefully-Studios/platypus](https://github.com/Makefully-Studios/platypus).
+- `lib/` is a build artifact (gitignored); clone builds via `npm run build:release`.
+- Upgraded from Webpack 4 to Webpack 5; removed Babel, `worker-loader`, and OpenSSL legacy provider workarounds.
+- `TickerClient` uses native `new Worker(new URL(..., import.meta.url))` again.
+- Internal imports no longer use `import 'platypus'` (relative modules / globals instead).
+- `StateMap` coerces stored values to booleans.
+- README and contributor docs updated for install, development, peers, and publishing.
+- Legacy JSDoc type expressions updated for current JSDoc parsing.
+
+### Fixed
+
+- `RenderDebug` draws each `CollisionBasic` shape from its own `aABB` instead of the combined AABB dimensions.
+- `CollisionGroup` collision grid not updated for non-moving entities with a collision group.
+- `package.json` `engines` field corrected to `engines` (Node `>=20`).
+
+## [4.0.3] - 2026-06-03
+
+### Added
+
+- Vitest test suite and coverage reporting.
+- Tiled format spec catalog and coverage assessment scripts.
+
+### Changed
+
+- Removed legacy `Camera` component; use `HandlerCamera` / `EntityCamera` instead.
+
+### Fixed
+
+- `TimeEvent` scheduling edge case.
+- Test and base-class coverage gaps addressed in core utilities.
+
+## [4.0.1] - 2026-05-28
+
+### Added
+
+- Rotated one-way (`jumpThrough`) collision support on `CollisionShape` / `CollisionBasic`.
+
+### Fixed
+
+- Collision handling when entities have multiple `CollisionBasic` components (`CollisionGroup`).
+- `HandlerCollision` grid updates for grouped, non-moving entities.
+
+## Earlier versions
+
+Tags and history for releases prior to 4.0.x (for example `v2.0.2`) are available in [GitHub releases](https://github.com/Makefully-Studios/platypus/releases) and `git tag`.

package/CONTRIBUTORS.md

@@ -1,10 +1,10 @@
-# Contributors
-
-## Maintainers
-
-- [Derek Detweiler](https://github.com/probityrules)
-- [Todd Lewis](https://github.com/GopherwoodTodd)
-
-## History
-
-Platypus was originally developed by [PBS KIDS](https://pbskids.org/) and [Gopherwood Studios](https://gopherwoodstudios.com/). Many others have contributed over the years; see `git log` and [GitHub contributors](https://github.com/Makefully-Studios/platypus/graphs/contributors) for the full list.
+# Contributors
+
+## Maintainers
+
+- [Derek Detweiler](https://github.com/probityrules)
+- [Todd Lewis](https://github.com/GopherwoodTodd)
+
+## History
+
+Platypus was originally developed by [PBS KIDS](https://pbskids.org/) and [Gopherwood Studios](https://gopherwoodstudios.com/). Many others have contributed over the years; see `git log` and [GitHub contributors](https://github.com/Makefully-Studios/platypus/graphs/contributors) for the full list.

package/README.md

@@ -1,77 +1,85 @@
-[![Platypus](./assets/platypus-title.png)](https://github.com/Makefully-Studios/platypus)
-========
-
-2D tile based game framework in HTML5
-
-The Platypus Engine allows rapid development of 2D orthogonal tile based games for deployment in HTML5 compatible browsers. The engine uses a component based model, and includes many ready to use components to allow users to start adding assets and editing levels right away. The component based model lends itself to community members adding new functionality, we hope you'll share what you've done!
-
-Platypus uses:
-
-* The [Tiled](https://www.mapeditor.org/) map editor for level creation.
-* [SpringRoll (v2)](https://springroll.io) for application management.
-* [Pixi.js](https://pixijs.com/) for rendering visuals.
-
-## Install
-
-```bash
-npm install @makefully/platypus
-```
-
-The npm package ships a **Webpack 5 UMD build** in `lib/` (not `src/`). Your game must also install peer dependencies and expose them to the bundle (same as a classic script-tag setup):
-
-| Package | Notes |
-|---------|--------|
-| `pixi.js` (^8.1.5) | Rendering |
-| `springroll` (^2.6.0) | Application shell |
-| `@tweenjs/tween.js` | Tweens |
-| `@pixi/sound` | Audio (Makefully fork; see `package.json`) |
-| `@esotericsoftware/spine-pixi-v8` | Spine animations (`RenderSpine`) |
-| `pako` | Compression helpers where used |
-
-Optional: `box2d3-wasm`, `jsmediatags`, `poly-decomp` (see `optionalDependencies` in [package.json](package.json)).
-
-Entry point: `lib/platypus.js` (plus any worker chunks emitted alongside it in `lib/`).
-
-## Development
-
-Requires **Node.js 20+**.
-
-```bash
-npm install
-npm run build:release   # production bundle → lib/ (gitignored)
-npm run test:run        # unit tests (Vitest)
-npm run docs            # API reference → docs/api/ (gitignored)
-```
-
-| Script | Purpose |
-|--------|---------|
-| `npm start` | Webpack dev server (`src/`, development mode) |
-| `npm run build:debug` | Development bundle with source maps |
-| `npm run pack:check` | Preview the npm tarball contents |
-| `npm run assess:tiled` | TiledLoader vs Tiled spec report ([test/tiled/README.md](test/tiled/README.md)) |
-
-Contributor workflow, API docs publishing, and `npm publish` are described in [docs/README.md](docs/README.md).
-
-When `package.json` **version** changes on `main`, [.github/workflows/release.yml](.github/workflows/release.yml) builds `lib/*.js`, reads the matching [CHANGELOG.md](CHANGELOG.md) section, and publishes a GitHub release (skips if that tag already exists).
-
-## Key Features
-
-* Deploy on any HTML5 platform supported by SpringRoll v2
-* Multi-platform support
-* Automatic scaling
-* Touch and keyboard input
-* Component-based development model
-* [Documentation](https://makefully-studios.github.io/platypus/) — generated from JSDoc in `src/`
-
-## Platypus in action
-
-* Ready Jet GO! [Mission Earth](https://pbskids.org/readyjetgo/games/mission/index.html)
-* Wild Kratts [Monkey Mayhem](https://pbskids.org/wildkratts/games/monkey-mayhem/)
-
-***
-
-[Code](https://github.com/Makefully-Studios/platypus) · [Docs](https://makefully-studios.github.io/platypus/) · [npm](https://www.npmjs.com/package/@makefully/platypus) · [Changelog](CHANGELOG.md)
-
-Maintained by **Derek Detweiler** and **Todd Lewis** ([CONTRIBUTORS.md](CONTRIBUTORS.md)).
-
-Platypus was originally developed by PBS KIDS and [Gopherwood Studios](https://gopherwoodstudios.com/). It is free to use (see [licenses.txt](licenses.txt)); assets in the example games are © Gopherwood Studios and/or © PBS KIDS.
+[![Platypus](./assets/platypus-title.png)](https://github.com/Makefully-Studios/platypus)
+========
+
+2D tile based game framework in HTML5
+
+The Platypus Engine allows rapid development of 2D orthogonal tile based games for deployment in HTML5 compatible browsers. The engine uses a component based model, and includes many ready to use components to allow users to start adding assets and editing levels right away. The component based model lends itself to community members adding new functionality, we hope you'll share what you've done!
+
+Platypus uses:
+
+* The [Tiled](https://www.mapeditor.org/) map editor for level creation.
+* [SpringRoll (v2)](https://springroll.io) for application management.
+* [Pixi.js](https://pixijs.com/) for rendering visuals.
+
+## Install
+
+```bash
+npm install @makefully/platypus
+```
+
+The npm package ships **Webpack 5 builds** in `lib/` (not `src/`): `platypus.mjs` for `import` (recommended) and `platypus.js` (UMD) for `require` or script tags. Your game must also install peer dependencies:
+
+| Package | Notes |
+|---------|--------|
+| `pixi.js` (^8.1.5) | Rendering |
+| `springroll` (^2.6.0) | Application shell |
+| `@tweenjs/tween.js` | Tweens |
+| `@pixi/sound` | Audio (Makefully fork; see `package.json`) |
+| `@esotericsoftware/spine-pixi-v8` | Spine animations (`RenderSpine`) |
+| `pako` | Compression helpers where used |
+
+Optional: `box2d3-wasm`, `jsmediatags`, `poly-decomp` (see `optionalDependencies` in [package.json](package.json)).
+
+Entry points: `lib/platypus.mjs` (`import`) or `lib/platypus.js` (`require`/script tag), plus worker chunks alongside them in `lib/`.
+
+If you see a Pixi error like `Cannot read properties of undefined (reading 'push')` in `collectRenderablesMixin` when using the UMD build, switch to the ESM entry (`import platypus from '@makefully/platypus'`). The ESM build keeps Platypus's `pixi.js` imports visible to your bundler so mask and render pipes are initialized. Using `/src` directly worked because your bundler already walked those imports.
+
+Include the engine stylesheet in your game's CSS (canvas layout, captions, debug overlay):
+
+```css
+@import '@makefully/platypus/platypus.css';
+```
+
+## Development
+
+Requires **Node.js 20+**.
+
+```bash
+npm install
+npm run build:release   # production bundle → lib/ (gitignored)
+npm run test:run        # unit tests (Vitest)
+npm run docs            # API reference → docs/api/ (gitignored)
+```
+
+| Script | Purpose |
+|--------|---------|
+| `npm start` | Webpack dev server (`src/`, development mode) |
+| `npm run build:debug` | Development bundle with source maps |
+| `npm run pack:check` | Preview the npm tarball contents |
+| `npm run assess:tiled` | TiledLoader vs Tiled spec report ([test/tiled/README.md](test/tiled/README.md)) |
+
+Contributor workflow, API docs publishing, and `npm publish` are described in [docs/README.md](docs/README.md).
+
+When `package.json` **version** changes on `main`, [.github/workflows/release.yml](.github/workflows/release.yml) builds `lib/`, publishes to [npm](https://www.npmjs.com/package/@makefully/platypus), and creates a GitHub release from the matching [CHANGELOG.md](CHANGELOG.md) section (skips each step if that version already exists).
+
+## Key Features
+
+* Deploy on any HTML5 platform supported by SpringRoll v2
+* Multi-platform support
+* Automatic scaling
+* Touch and keyboard input
+* Component-based development model
+* [Documentation](https://makefully-studios.github.io/platypus/) — generated from JSDoc in `src/`
+
+## Platypus in action
+
+* Ready Jet GO! [Mission Earth](https://pbskids.org/readyjetgo/games/mission/index.html)
+* Wild Kratts [Monkey Mayhem](https://pbskids.org/wildkratts/games/monkey-mayhem/)
+
+***
+
+[Code](https://github.com/Makefully-Studios/platypus) · [Docs](https://makefully-studios.github.io/platypus/) · [npm](https://www.npmjs.com/package/@makefully/platypus) · [Changelog](CHANGELOG.md)
+
+Maintained by **Derek Detweiler** and **Todd Lewis** ([CONTRIBUTORS.md](CONTRIBUTORS.md)).
+
+Platypus was originally developed by PBS KIDS and [Gopherwood Studios](https://gopherwoodstudios.com/). It is free to use (see [licenses.txt](licenses.txt)); assets in the example games are © Gopherwood Studios and/or © PBS KIDS.

package/lib/243.platypus.mjs

@@ -0,0 +1 @@
+self.onmessage=({data:e})=>{let a=0;if(e.begin){let t=performance.now();clearInterval(a),a=setInterval(()=>{const e=performance.now();self.postMessage({deltaTime:e-t}),t=e},e.begin.delta)}e.stop&&clearInterval(a)};

package/lib/platypus.css

@@ -0,0 +1,68 @@
+div#captions {
+    user-select: none;
+    -moz-user-select: none;
+    -webkit-user-select: none;
+    -ms-user-select: none;
+    -webkit-touch-callout: none;
+}
+
+canvas.platypus-canvas {
+    height: 100%;
+    position: relative;
+    width: 100%;
+
+    user-select: none;
+    -moz-user-select: none;
+    -webkit-user-select: none;
+    -ms-user-select: none;
+    -webkit-touch-callout: none;
+}
+
+.platypus-debugging {
+    position: fixed;
+    pointer-events: none;
+    color: #fff;
+    font-size: 12px;
+    padding: 5px;
+    background: rgba(0, 0, 0, 0.4);
+    z-index: 2;
+    font-family: "Lucida Console", Monaco, monospace;
+    -webkit-touch-callout: none;
+    user-select: none;
+    cursor: default;
+    margin: 0;
+    line-height: 1.5em;
+}
+
+#framerate {
+    top: 0;
+    left: 0;
+}
+
+#platypus-logging {
+    top: 0;
+    right: 0;
+    max-width: 40%;
+    max-height: 40%;
+    overflow-x: auto;
+}
+
+#platypus-logging .general {color: lightgreen;}
+#platypus-logging .log {color: white;}
+#platypus-logging .warn {color: yellow;}
+#platypus-logging .debug {color: lightblue;}
+#platypus-logging .error {color: lightcoral;}
+#platypus-logging span {padding-right: 1.5em;}
+
+#toggle-platypus-debugging {
+    position: fixed;
+    top: 0;
+    right: 0;
+    font-size: 12px;
+    padding: 5px;
+    background: rgba(0, 0, 0, 0.4);
+    font-family: "Lucida Console", Monaco, monospace;
+    border: none;
+    color: white;
+    z-index: 3;
+}