@kvmet/beefwife-canvas 0.0.0-stage → 0.1.0

package/CHANGELOG.md

@@ -0,0 +1,22 @@
+# Changelog
+
+Notable changes to `@kvmet/beefwife-canvas`, newest first. This package follows
+[semantic versioning](https://semver.org/spec/v2.0.0.html).
+
+## 0.1.0 (2026-11-14)
+
+First release.
+
+The bundle auto-mounts every `canvas[data-beefwife-canvas]` once the DOM is
+ready, loads its creatures from a manifest, and routes them around the page
+with Terrain. `BeefwifeCanvas.mount`, `get`, and `scan` drive mounting by hand.
+
+A mounted canvas reports through `data-beefwife-state`, the
+`beefwifecanvasready` and `beefwifecanvaserror` events, and the handle's
+`state` and `pauseReason` getters. It pauses itself when hidden, offscreen, or
+sized to zero.
+
+`@kvmet/beefwife` and `@kvmet/terrain` are bundled in, so the page loads Pixi 8
+and this one file. Two entries carry it: the classic script reads `window.PIXI`
+and runs where no renderer is present, and the module build imports the peer so
+a bundler shares one copy with the page. Pixi 8.21.0 is the minimum.

package/LICENSE

@@ -0,0 +1,373 @@
+Mozilla Public License Version 2.0
+==================================
+
+1. Definitions
+--------------
+
+1.1. "Contributor"
+    means each individual or legal entity that creates, contributes to
+    the creation of, or owns Covered Software.
+
+1.2. "Contributor Version"
+    means the combination of the Contributions of others (if any) used
+    by a Contributor and that particular Contributor's Contribution.
+
+1.3. "Contribution"
+    means Covered Software of a particular Contributor.
+
+1.4. "Covered Software"
+    means Source Code Form to which the initial Contributor has attached
+    the notice in Exhibit A, the Executable Form of such Source Code
+    Form, and Modifications of such Source Code Form, in each case
+    including portions thereof.
+
+1.5. "Incompatible With Secondary Licenses"
+    means
+
+    (a) that the initial Contributor has attached the notice described
+        in Exhibit B to the Covered Software; or
+
+    (b) that the Covered Software was made available under the terms of
+        version 1.1 or earlier of the License, but not also under the
+        terms of a Secondary License.
+
+1.6. "Executable Form"
+    means any form of the work other than Source Code Form.
+
+1.7. "Larger Work"
+    means a work that combines Covered Software with other material, in
+    a separate file or files, that is not Covered Software.
+
+1.8. "License"
+    means this document.
+
+1.9. "Licensable"
+    means having the right to grant, to the maximum extent possible,
+    whether at the time of the initial grant or subsequently, any and
+    all of the rights conveyed by this License.
+
+1.10. "Modifications"
+    means any of the following:
+
+    (a) any file in Source Code Form that results from an addition to,
+        deletion from, or modification of the contents of Covered
+        Software; or
+
+    (b) any new file in Source Code Form that contains any Covered
+        Software.
+
+1.11. "Patent Claims" of a Contributor
+    means any patent claim(s), including without limitation, method,
+    process, and apparatus claims, in any patent Licensable by such
+    Contributor that would be infringed, but for the grant of the
+    License, by the making, using, selling, offering for sale, having
+    made, import, or transfer of either its Contributions or its
+    Contributor Version.
+
+1.12. "Secondary License"
+    means either the GNU General Public License, Version 2.0, the GNU
+    Lesser General Public License, Version 2.1, the GNU Affero General
+    Public License, Version 3.0, or any later versions of those
+    licenses.
+
+1.13. "Source Code Form"
+    means the form of the work preferred for making modifications.
+
+1.14. "You" (or "Your")
+    means an individual or a legal entity exercising rights under this
+    License. For legal entities, "You" includes any entity that
+    controls, is controlled by, or is under common control with You. For
+    purposes of this definition, "control" means (a) the power, direct
+    or indirect, to cause the direction or management of such entity,
+    whether by contract or otherwise, or (b) ownership of more than
+    fifty percent (50%) of the outstanding shares or beneficial
+    ownership of such entity.
+
+2. License Grants and Conditions
+--------------------------------
+
+2.1. Grants
+
+Each Contributor hereby grants You a world-wide, royalty-free,
+non-exclusive license:
+
+(a) under intellectual property rights (other than patent or trademark)
+    Licensable by such Contributor to use, reproduce, make available,
+    modify, display, perform, distribute, and otherwise exploit its
+    Contributions, either on an unmodified basis, with Modifications, or
+    as part of a Larger Work; and
+
+(b) under Patent Claims of such Contributor to make, use, sell, offer
+    for sale, have made, import, and otherwise transfer either its
+    Contributions or its Contributor Version.
+
+2.2. Effective Date
+
+The licenses granted in Section 2.1 with respect to any Contribution
+become effective for each Contribution on the date the Contributor first
+distributes such Contribution.
+
+2.3. Limitations on Grant Scope
+
+The licenses granted in this Section 2 are the only rights granted under
+this License. No additional rights or licenses will be implied from the
+distribution or licensing of Covered Software under this License.
+Notwithstanding Section 2.1(b) above, no patent license is granted by a
+Contributor:
+
+(a) for any code that a Contributor has removed from Covered Software;
+    or
+
+(b) for infringements caused by: (i) Your and any other third party's
+    modifications of Covered Software, or (ii) the combination of its
+    Contributions with other software (except as part of its Contributor
+    Version); or
+
+(c) under Patent Claims infringed by Covered Software in the absence of
+    its Contributions.
+
+This License does not grant any rights in the trademarks, service marks,
+or logos of any Contributor (except as may be necessary to comply with
+the notice requirements in Section 3.4).
+
+2.4. Subsequent Licenses
+
+No Contributor makes additional grants as a result of Your choice to
+distribute the Covered Software under a subsequent version of this
+License (see Section 10.2) or under the terms of a Secondary License (if
+permitted under the terms of Section 3.3).
+
+2.5. Representation
+
+Each Contributor represents that the Contributor believes its
+Contributions are its original creation(s) or it has sufficient rights
+to grant the rights to its Contributions conveyed by this License.
+
+2.6. Fair Use
+
+This License is not intended to limit any rights You have under
+applicable copyright doctrines of fair use, fair dealing, or other
+equivalents.
+
+2.7. Conditions
+
+Sections 3.1, 3.2, 3.3, and 3.4 are conditions of the licenses granted
+in Section 2.1.
+
+3. Responsibilities
+-------------------
+
+3.1. Distribution of Source Form
+
+All distribution of Covered Software in Source Code Form, including any
+Modifications that You create or to which You contribute, must be under
+the terms of this License. You must inform recipients that the Source
+Code Form of the Covered Software is governed by the terms of this
+License, and how they can obtain a copy of this License. You may not
+attempt to alter or restrict the recipients' rights in the Source Code
+Form.
+
+3.2. Distribution of Executable Form
+
+If You distribute Covered Software in Executable Form then:
+
+(a) such Covered Software must also be made available in Source Code
+    Form, as described in Section 3.1, and You must inform recipients of
+    the Executable Form how they can obtain a copy of such Source Code
+    Form by reasonable means in a timely manner, at a charge no more
+    than the cost of distribution to the recipient; and
+
+(b) You may distribute such Executable Form under the terms of this
+    License, or sublicense it under different terms, provided that the
+    license for the Executable Form does not attempt to limit or alter
+    the recipients' rights in the Source Code Form under this License.
+
+3.3. Distribution of a Larger Work
+
+You may create and distribute a Larger Work under terms of Your choice,
+provided that You also comply with the requirements of this License for
+the Covered Software. If the Larger Work is a combination of Covered
+Software with a work governed by one or more Secondary Licenses, and the
+Covered Software is not Incompatible With Secondary Licenses, this
+License permits You to additionally distribute such Covered Software
+under the terms of such Secondary License(s), so that the recipient of
+the Larger Work may, at their option, further distribute the Covered
+Software under the terms of either this License or such Secondary
+License(s).
+
+3.4. Notices
+
+You may not remove or alter the substance of any license notices
+(including copyright notices, patent notices, disclaimers of warranty,
+or limitations of liability) contained within the Source Code Form of
+the Covered Software, except that You may alter any license notices to
+the extent required to remedy known factual inaccuracies.
+
+3.5. Application of Additional Terms
+
+You may choose to offer, and to charge a fee for, warranty, support,
+indemnity or liability obligations to one or more recipients of Covered
+Software. However, You may do so only on Your own behalf, and not on
+behalf of any Contributor. You must make it absolutely clear that any
+such warranty, support, indemnity, or liability obligation is offered by
+You alone, and You hereby agree to indemnify every Contributor for any
+liability incurred by such Contributor as a result of warranty, support,
+indemnity or liability terms You offer. You may include additional
+disclaimers of warranty and limitations of liability specific to any
+jurisdiction.
+
+4. Inability to Comply Due to Statute or Regulation
+---------------------------------------------------
+
+If it is impossible for You to comply with any of the terms of this
+License with respect to some or all of the Covered Software due to
+statute, judicial order, or regulation then You must: (a) comply with
+the terms of this License to the maximum extent possible; and (b)
+describe the limitations and the code they affect. Such description must
+be placed in a text file included with all distributions of the Covered
+Software under this License. Except to the extent prohibited by statute
+or regulation, such description must be sufficiently detailed for a
+recipient of ordinary skill to be able to understand it.
+
+5. Termination
+--------------
+
+5.1. The rights granted under this License will terminate automatically
+if You fail to comply with any of its terms. However, if You become
+compliant, then the rights granted under this License from a particular
+Contributor are reinstated (a) provisionally, unless and until such
+Contributor explicitly and finally terminates Your grants, and (b) on an
+ongoing basis, if such Contributor fails to notify You of the
+non-compliance by some reasonable means prior to 60 days after You have
+come back into compliance. Moreover, Your grants from a particular
+Contributor are reinstated on an ongoing basis if such Contributor
+notifies You of the non-compliance by some reasonable means, this is the
+first time You have received notice of non-compliance with this License
+from such Contributor, and You become compliant prior to 30 days after
+Your receipt of the notice.
+
+5.2. If You initiate litigation against any entity by asserting a patent
+infringement claim (excluding declaratory judgment actions,
+counter-claims, and cross-claims) alleging that a Contributor Version
+directly or indirectly infringes any patent, then the rights granted to
+You by any and all Contributors for the Covered Software under Section
+2.1 of this License shall terminate.
+
+5.3. In the event of termination under Sections 5.1 or 5.2 above, all
+end user license agreements (excluding distributors and resellers) which
+have been validly granted by You or Your distributors under this License
+prior to termination shall survive termination.
+
+************************************************************************
+*                                                                      *
+*  6. Disclaimer of Warranty                                           *
+*  -------------------------                                           *
+*                                                                      *
+*  Covered Software is provided under this License on an "as is"       *
+*  basis, without warranty of any kind, either expressed, implied, or  *
+*  statutory, including, without limitation, warranties that the       *
+*  Covered Software is free of defects, merchantable, fit for a        *
+*  particular purpose or non-infringing. The entire risk as to the     *
+*  quality and performance of the Covered Software is with You.        *
+*  Should any Covered Software prove defective in any respect, You     *
+*  (not any Contributor) assume the cost of any necessary servicing,   *
+*  repair, or correction. This disclaimer of warranty constitutes an   *
+*  essential part of this License. No use of any Covered Software is   *
+*  authorized under this License except under this disclaimer.         *
+*                                                                      *
+************************************************************************
+
+************************************************************************
+*                                                                      *
+*  7. Limitation of Liability                                          *
+*  --------------------------                                          *
+*                                                                      *
+*  Under no circumstances and under no legal theory, whether tort      *
+*  (including negligence), contract, or otherwise, shall any           *
+*  Contributor, or anyone who distributes Covered Software as          *
+*  permitted above, be liable to You for any direct, indirect,         *
+*  special, incidental, or consequential damages of any character      *
+*  including, without limitation, damages for lost profits, loss of    *
+*  goodwill, work stoppage, computer failure or malfunction, or any    *
+*  and all other commercial damages or losses, even if such party      *
+*  shall have been informed of the possibility of such damages. This   *
+*  limitation of liability shall not apply to liability for death or   *
+*  personal injury resulting from such party's negligence to the       *
+*  extent applicable law prohibits such limitation. Some               *
+*  jurisdictions do not allow the exclusion or limitation of           *
+*  incidental or consequential damages, so this exclusion and          *
+*  limitation may not apply to You.                                    *
+*                                                                      *
+************************************************************************
+
+8. Litigation
+-------------
+
+Any litigation relating to this License may be brought only in the
+courts of a jurisdiction where the defendant maintains its principal
+place of business and such litigation shall be governed by laws of that
+jurisdiction, without reference to its conflict-of-law provisions.
+Nothing in this Section shall prevent a party's ability to bring
+cross-claims or counter-claims.
+
+9. Miscellaneous
+----------------
+
+This License represents the complete agreement concerning the subject
+matter hereof. If any provision of this License is held to be
+unenforceable, such provision shall be reformed only to the extent
+necessary to make it enforceable. Any law or regulation which provides
+that the language of a contract shall be construed against the drafter
+shall not be used to construe this License against a Contributor.
+
+10. Versions of the License
+---------------------------
+
+10.1. New Versions
+
+Mozilla Foundation is the license steward. Except as provided in Section
+10.3, no one other than the license steward has the right to modify or
+publish new versions of this License. Each version will be given a
+distinguishing version number.
+
+10.2. Effect of New Versions
+
+You may distribute the Covered Software under the terms of the version
+of the License under which You originally received the Covered Software,
+or under the terms of any subsequent version published by the license
+steward.
+
+10.3. Modified Versions
+
+If you create software not governed by this License, and you want to
+create a new license for such software, you may create and use a
+modified version of this License if you rename the license and remove
+any references to the name of the license steward (except to note that
+such modified license differs from this License).
+
+10.4. Distributing Source Code Form that is Incompatible With Secondary
+Licenses
+
+If You choose to distribute Source Code Form that is Incompatible With
+Secondary Licenses under the terms of this version of the License, the
+notice described in Exhibit B of this License must be attached.
+
+Exhibit A - Source Code Form License Notice
+-------------------------------------------
+
+  This Source Code Form is subject to the terms of the Mozilla Public
+  License, v. 2.0. If a copy of the MPL was not distributed with this
+  file, You can obtain one at https://mozilla.org/MPL/2.0/.
+
+If it is not possible or desirable to put the notice in a particular
+file, then You may include the notice in a location (such as a LICENSE
+file in a relevant directory) where a recipient would be likely to look
+for such a notice.
+
+You may add additional accurate notices of copyright ownership.
+
+Exhibit B - "Incompatible With Secondary Licenses" Notice
+---------------------------------------------------------
+
+  This Source Code Form is "Incompatible With Secondary Licenses", as
+  defined by the Mozilla Public License, v. 2.0.

package/README.md

@@ -1,3 +1,252 @@
-# Temporary Holding Version
+# BeefwifeCanvas
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+`BeefwifeCanvas` mounts the Beefwife runtime into a canvas that belongs to the
+page. The canvas can have any ID, class, layout, or stacking rules; the API only
+looks for `data-beefwife-canvas` when auto-mounting.
+
+```html
+<canvas
+  id="my-beefwives"
+  data-beefwife-canvas
+  data-beefwife-manifest="beefwives/manifest.json"
+  data-beefwife-count="8"
+  data-beefwife-resolution-scale="0.25"
+  data-beefwife-image-rendering="pixelated"
+  data-beefwife-round-vertices="true"
+  data-beefwife-antialias="false"
+  data-beefwife-simulation-fps="60"
+  data-beefwife-draw-fps="24"
+  data-beefwife-target-mode="wander"
+  data-beefwife-pointer-input="click"
+  data-beefwife-wander-delay="4"
+  data-beefwife-knee-projection-center="canvas"
+></canvas>
+```
+
+## Install
+
+Load Pixi 8, then the runtime. Beefwife and Terrain ride inside
+`beefwife-canvas.js`, so the page needs nothing else and gains one global,
+`BeefwifeCanvas`.
+
+Creatures are separate: the canvas draws whichever descriptors it is pointed
+at. `@kvmet/beefwife` ships seven samples under `samples/`, reachable from a
+CDN without installing it.
+
+From a CDN:
+
+```html
+<script src="https://cdn.jsdelivr.net/npm/pixi.js@8.23.0/dist/pixi.min.js"></script>
+<script src="https://cdn.jsdelivr.net/npm/@kvmet/beefwife-canvas@0.1.0/beefwife-canvas.min.js"></script>
+```
+
+With npm:
+
+```sh
+npm install @kvmet/beefwife-canvas pixi.js
+```
+
+With a bundler, import the module entry. Pixi stays external, so the page
+and the runtime share one copy:
+
+```js
+import BeefwifeCanvas from "@kvmet/beefwife-canvas";
+```
+
+The import mounts every marked canvas on its own, the same as the script
+does, so importing for the side effect alone is enough. Without a bundler,
+serve the script instead:
+
+```html
+<script src="/node_modules/pixi.js/dist/pixi.min.js"></script>
+<script src="/node_modules/@kvmet/beefwife-canvas/beefwife-canvas.min.js"></script>
+```
+
+Pixi 8.21.0 is the minimum: in earlier 8.x releases, destroying one WebGPU
+renderer can break another. The script entry reads `window.PIXI` and the
+module entry imports the peer, so only the script entry runs where no
+renderer is present.
+
+`beefwife-canvas.js` is the readable build and creates the same global;
+`beefwife-canvas.mjs` is the module build. `npm run build` writes all three
+from [`src`](src/); all are committed. The integrated development example is
+in [`examples/beefwife-canvas`](../examples/beefwife-canvas/).
+
+The bundle auto-mounts every marked canvas after the DOM is ready.
+Listen for `beefwifecanvasready` or `beefwifecanvaserror`, await the `ready`
+promise on a handle returned by `BeefwifeCanvas.get(canvas)`, or inspect
+`data-beefwife-state`, whose values are `loading`, `ready`, `running`, `paused`,
+`stopped`, `error`, and `destroyed`. A paused canvas also exposes
+`data-beefwife-pause-reason` as `hidden`, `offscreen`, or `zero-size`. A mount
+or a texture render that fails dispatches the error event, stops the runtime,
+cleans itself up, and leaves the canvas in the `error` state, ready to mount again.
+The mounted handle exposes the same information through its read-only `state`
+and `pauseReason` getters; `pauseReason` is `null` unless state is `paused`.
+
+`BeefwifeCanvas.scan()` mounts any currently unmounted
+`canvas[data-beefwife-canvas]` elements. The initial document is scanned
+automatically; call `scan()` after adding declarative canvases dynamically.
+Already mounted canvases are left alone.
+
+The manifest is deliberately small and versioned. Relative source URLs are
+resolved from the manifest URL. Weights affect random spawning, not loading.
+
+```json
+{
+  "schemaVersion": 1,
+  "sources": ["slug-a.json", { "src": "slug-b.json", "weight": 3 }]
+}
+```
+
+`manifest`, `sources`, and `descriptors` are additive when more than one is
+provided. Programmatic `manifest` may be either a manifest URL or the parsed
+manifest object. `sources` accepts one descriptor URL, one `{ src, weight }`
+entry, or an array of either. `descriptors` likewise accepts one descriptor,
+one `{ descriptor, weight }` entry, or an array. Declarative attributes support
+a manifest URL and a comma-separated source URL list; parsed descriptors are
+JavaScript-only. Every resulting descriptor name must be unique across all
+inputs or the mount fails atomically. When `count` is omitted it defaults to
+the number of unique descriptors, with weighted names sampled with replacement.
+
+JavaScript options override attributes and can supply already-parsed
+descriptors or arbitrary caller-owned Pixi filters. Omit `data-beefwife-canvas`
+when mounting programmatically so auto-mount and programmatic mount do not race.
+
+```js
+const canvas = document.querySelector("#programmatic-beefwives");
+const runtime = await BeefwifeCanvas.mount(canvas, {
+  descriptors: [descriptorA, { descriptor: descriptorB, weight: 3 }],
+  filters: [new PIXI.NoiseFilter({ noise: 0.08 })],
+  targetMode: "manual",
+  pointerInput: "none",
+});
+
+runtime.setTarget({ x: 300, y: 180 });
+runtime.getActors()[0].setTarget({ x: 80, y: 120 });
+```
+
+`mount` resolves a frozen runtime handle. `BeefwifeCanvas.get(canvas)` and the
+`detail.controller` of either lifecycle event return the same handle while the
+event is being dispatched. A failed handle is released after its error event,
+so `get(canvas)` then returns `null` and a new mount can begin.
+
+The lifecycle methods are `start()`, `stop()`, `destroy()`, `setCount(count)`,
+`setTimeScale(scale)`, `setTarget(point)`, `clearTarget()`,
+`setTargetMode(mode)`, `setPointerInput(input)`, `setDebug(flags)`,
+`refreshTerrain()`, `respawn()`, `getActors()`, `getTerrainView()`, and
+`getStats()`.
+`getActors()` returns frozen Canvas control handles with stable `id` and `name`
+fields plus `getPose()`, `getRoute()`, `getTarget()`, target, mode, and respawn
+methods; it does not expose the host's mutable actor or route objects.
+Targets and poses use canvas-local CSS pixels. Target policy and DOM input are
+independent. `targetMode` is `wander` or `manual`; `pointerInput` is `none`,
+`click`, or `move`. A click or pointer movement merely supplies a target and
+does not change what happens after arrival. In `manual`, every supplied target
+produces one finite route and the beefwife then stops until another target is
+supplied. In `wander`, the host waits a random duration from zero through
+`wanderDelay` seconds before supplying another target. `move` retains its last
+destination after the pointer leaves the canvas. The host chooses goals and
+Beefwife only receives its usual direction and throttle controls. Attribute
+values are read once. Use the methods for live changes.
+
+`destroy()` removes the scene and runtime listeners but leaves the author's
+canvas in place. While the canvas stays in the page, its Pixi renderer is kept
+dormant so the same element can be mounted again without a second GPU context.
+`antialias` is fixed for the life of that renderer, so a remount cannot change
+it. When a destroyed canvas leaves the page, its renderer and GPU context are
+released and the canvas can be garbage collected; mounting that element again
+fails, so mount a new canvas instead. A canvas removed without `destroy()`
+keeps its renderer and GPU context for the life of the page, so call
+`destroy()` when you remove one, before or after removing it.
+
+Performance and appearance options are `resolutionScale`, `roundVertices`,
+`antialias`, `simulationFps`, `drawFps`, `maxPixelRatio`, `imageRendering`,
+`kneePerspective`, `maxKneeOffset`, `kneeProjectionCenter`, and programmatic
+`filters`. `drawFps` is held at `simulationFps`, because a draw between two
+simulation steps repeats the frame before it. `simulationFps` defaults to 60
+and `drawFps` to 24; both accept 1 through 240, and a `drawFps` of zero asks
+for the `simulationFps` ceiling by name.
+
+The substep size is fixed, so a simulated second always costs the same number
+of substeps however `simulationFps` batches them. Lowering it buys fewer,
+larger steps and the routing saved between them, not cheaper physics: 10
+against 60 saves 8% of the simulation cost at 400 creatures. It also steers
+more coarsely, because a route advances once a tick, so creatures take
+visibly different paths. To spend less on physics, lower `timeScale`, which
+reduces simulated seconds per real second and says so by moving the creature
+slower. `drawFps` is the knob that pays without touching behaviour.
+
+A host that cannot deliver `simulationFps` is not the same as a lower
+`simulationFps`. It plays slower and follows the same path, because each tick
+steps once whatever the frame took, so the route still advances one 60th of a
+second at a time.
+
+Rates need not divide each other. A step that is not a whole number of
+substeps carries its remainder, so `simulationFps` of 24 or a `timeScale` of
+0.7 stays within one substep of exact for any run length rather than drifting.
+
+Knee perspective affects
+leg-knee rendering only; planted feet and
+the simulated body are unchanged. `kneeProjectionCenter` is
+`canvas` by default; `viewport` makes separate canvases share one apparent
+knee-projection field. `resolutionScale` accepts 0.125 through 1 and defaults
+to 0.25, where quarter resolution costs a sixteenth of the fill work. When
+vertex rounding is enabled, vertices snap to pixels at the effective renderer
+resolution, including device pixel ratio and `resolutionScale`.
+`imageRendering` independently selects `pixelated` (the default) or `auto`,
+allowing either interpolation style at any resolution. For color effects, pass
+a configured `PIXI.ColorMatrixFilter` in `filters`.
+
+Debug rendering is off by default. The boolean options `debugTargets`,
+`debugRoutes`, and `debugTerrain` show destination crosshairs, waypoint paths,
+and avoidance bounds, respectively. Their declarative forms are
+`data-beefwife-debug-targets`, `data-beefwife-debug-routes`,
+and `data-beefwife-debug-terrain`. Toggle layers after mounting with a partial
+update:
+
+```js
+runtime.setDebug({ targets: true, routes: true });
+runtime.setDebug({ routes: false, terrain: true });
+```
+
+Terrain draws below the beefwives; routes and targets draw above them. These
+layers are diagnostic and do not affect routing or simulation. Their marks are
+sized in renderer pixels, so a mark keeps its shape at every `resolutionScale`
+and grows on screen as the renderer coarsens.
+
+To draw a debug layer of your own instead, read the same state and draw it at
+whatever resolution you like. `getTerrainView()` returns the field as the last
+build measured it, `{ bounds, rectangles }` in canvas-local CSS pixels, and each
+control handle answers `getRoute()` with the remaining waypoints and
+`getTarget()` with the current goal or `null`. All three return copies.
+
+`getStats()` reports the last whole second: `actors`, `steps` and `draws` a
+second, and `stepMs` and `drawMs` for the mean cost of one simulation step and
+one draw. Those milliseconds are this thread's work alone. A draw returns once
+the frame is submitted and the GPU renders it afterwards, so what a resolution
+costs to rasterise is not in `drawMs`.
+
+```js
+const { steps, drawMs } = runtime.getStats();
+for (const actor of runtime.getActors())
+  overlay.plot(actor.getRoute(), actor.getTarget());
+```
+
+Simulation and routing options are `timeScale`, `wanderDelay`, `edgeMargin`,
+`obstaclePadding`, `waypointRadius`, `arrivalRadius`, `throttleEase`,
+`stuckReplanSeconds`, and `escapeReplanSeconds`. `waypointRadius` controls how
+closely an intermediate corner must be followed, while `arrivalRadius`
+controls final-target satisfaction; both default to 10 CSS pixels.
+`wanderDelay` defaults to 4 seconds and may be zero.
+`avoid` defaults to `.beefwife-avoid`, `edgeMargin` defaults to 25, and
+`obstaclePadding` defaults to zero CSS pixels. Terrain is re-measured when the
+window resizes, an obstacle or the canvas resizes, or a window scroll moves an
+obstacle relative to the canvas, as with a fixed canvas or a sticky obstacle.
+Call `refreshTerrain()` after transform-only obstacle movement, or a scroll
+inside a nested scroll container, because the runtime cannot see either.
+`pauseHidden` and `pauseOffscreen` default to true.
+
+Avoidance and visual occlusion are independent. `avoid` changes routing. To
+make beefwives appear to walk behind a widget, place that DOM element above the
+canvas in normal stacking order. A widget may be an avoid element, an
+occluder, both, or neither; no Pixi mask is needed for ordinary DOM occlusion.