modules.json

{
  "name": "JS-modules",
  "license": "MIT",
  "copyright": "LFC Foundry",
  "repository": "https://github.com/lfcfoundry/JS-modules",
  "pages": "https://lfcfoundry.github.io/JS-modules/",
  "origin": "Extracted from Apple Press, https://github.com/lfcfoundry/apple-press (play: https://lfcfoundry.github.io/apple-press/), and Fancy, the Banana, https://github.com/lfcfoundry/fancy-banana (play: https://lfcfoundry.github.io/fancy-banana/)",
  "modules": [
    {
      "id": "stage-curtains",
      "version": "1.4.0",
      "api": 1,
      "global": "StageCurtains",
      "summary": "Velvet stage curtains that slide shut over a page, then fly open; the velvet is painted by a small WebAssembly loop with plain JavaScript as the fallback.",
      "short": "Velvet stage curtains that slide shut over a page and fly open.",
      "file": "modules/stage-curtains/stage-curtains.js",
      "readme": "modules/stage-curtains/README.md",
      "demo": "modules/stage-curtains/demo.html",
      "dependencies": "none",
      "formats": "browser global, CommonJS (module.exports)",
      "category": "looks"
    },
    {
      "id": "save-kit",
      "version": "1.2.2",
      "api": 1,
      "global": "SaveKit",
      "summary": "Safe localStorage saves, backup slot, checksummed copy-paste save codes with a size limit on what a paste may unpack to.",
      "short": "Safe saves in localStorage: backup slot, checksums, copy-paste save codes.",
      "file": "modules/save-kit/save-kit.js",
      "readme": "modules/save-kit/README.md",
      "demo": "modules/save-kit/demo.html",
      "dependencies": "none",
      "formats": "browser global, CommonJS (module.exports)",
      "category": "saving"
    },
    {
      "id": "hold-press",
      "version": "1.1.0",
      "api": 1,
      "global": "HoldPress",
      "summary": "Hold-to-repeat for buttons that survives Android Chrome pointercancel.",
      "short": "Hold-to-repeat buttons that survive Android Chrome's pointercancel.",
      "file": "modules/hold-press/hold-press.js",
      "readme": "modules/hold-press/README.md",
      "demo": "modules/hold-press/demo.html",
      "dependencies": "none",
      "formats": "browser global, CommonJS (module.exports)",
      "category": "controls"
    },
    {
      "id": "env-probes",
      "version": "1.1.0",
      "api": 1,
      "global": "EnvProbes",
      "summary": "Detects privacy modes that round timers (including Firefox's 16.67 ms clock), scramble canvas read-back or block storage, and says what it found in plain words.",
      "short": "Detects privacy modes that blur timers, scramble canvas reads or block storage.",
      "file": "modules/env-probes/env-probes.js",
      "readme": "modules/env-probes/README.md",
      "demo": "modules/env-probes/demo.html",
      "dependencies": "none",
      "formats": "browser global, CommonJS (module.exports)",
      "category": "adaptation"
    },
    {
      "id": "fx-governor",
      "version": "1.1.1",
      "api": 1,
      "global": "FxGovernor",
      "summary": "Steps visual effects down when the device cannot keep up; never back up behind the player.",
      "short": "Steps visual effects down when the device cannot keep up; never back up mid-play.",
      "file": "modules/fx-governor/fx-governor.js",
      "readme": "modules/fx-governor/README.md",
      "demo": "modules/fx-governor/demo.html",
      "dependencies": "none",
      "formats": "browser global, CommonJS (module.exports)",
      "category": "adaptation"
    },
    {
      "id": "gpu-blur",
      "version": "1.0.0",
      "api": 1,
      "global": "GpuBlur",
      "summary": "Blurs a picture (a canvas, an ImageBitmap or RGBA bytes) on the graphics card with WebGL 2, or in WebAssembly, or in plain JavaScript, whichever the device does best; every way gives the same picture, and a big blur never freezes the page.",
      "short": "Blurs a picture on the card (WebGL 2), in WebAssembly or plain JavaScript; same picture every way.",
      "file": "modules/gpu-blur/gpu-blur.js",
      "readme": "modules/gpu-blur/README.md",
      "demo": "modules/gpu-blur/demo.html",
      "dependencies": "none",
      "formats": "browser global, CommonJS (module.exports)",
      "category": "looks"
    },
    {
      "id": "fly-to-mini",
      "version": "1.2.0",
      "api": 1,
      "global": "FlyToMini",
      "summary": "A big element scrolls away and a copy flies to its sticky mini version (and back).",
      "short": "A big element scrolls away and a copy flies to its sticky mini version.",
      "file": "modules/fly-to-mini/fly-to-mini.js",
      "readme": "modules/fly-to-mini/README.md",
      "demo": "modules/fly-to-mini/demo.html",
      "dependencies": "none",
      "formats": "browser global, CommonJS (module.exports)",
      "category": "looks"
    },
    {
      "id": "sticker-text",
      "version": "1.1.0",
      "api": 1,
      "global": "StickerText",
      "summary": "Die-cut sticker lettering in plain CSS text-shadow rings, no images.",
      "short": "Die-cut sticker lettering in plain CSS, no images.",
      "file": "modules/sticker-text/sticker-text.js",
      "readme": "modules/sticker-text/README.md",
      "demo": "modules/sticker-text/demo.html",
      "dependencies": "none",
      "formats": "browser global, CommonJS (module.exports)",
      "category": "looks"
    },
    {
      "id": "idle-core",
      "version": "1.2.0",
      "api": 1,
      "global": "IdleCore",
      "summary": "Tested maths for idle/clicker games: costs, buy-many and buy-max, milestones, away income, boost queue, number format.",
      "short": "Tested maths for idle and clicker games: costs, buy-max, away income, number format.",
      "file": "modules/idle-core/idle-core.js",
      "readme": "modules/idle-core/README.md",
      "demo": "modules/idle-core/demo.html",
      "dependencies": "none",
      "formats": "browser global, CommonJS (module.exports)",
      "category": "math"
    },
    {
      "id": "frame-kit",
      "version": "1.2.1",
      "api": 1,
      "global": "EvenDt, QualityGovernor, JobPump, FrameMeter",
      "summary": "Frame pacing for canvas games: even-dt smooths the frame time, quality-governor steps effects down and back up, job-pump spreads heavy jobs across frames, frame-meter shows frames a second, hitches and tap delay in plain words.",
      "short": "Frame pacing for canvas games: smooth frame time, effect governor, job pump, frame meter.",
      "file": "modules/frame-kit/",
      "readme": "modules/frame-kit/README.md",
      "demo": "modules/frame-kit/demo.html",
      "dependencies": "none",
      "formats": "browser globals, CommonJS (module.exports) per file",
      "files": [
        "even-dt.js",
        "quality-governor.js",
        "job-pump.js",
        "frame-meter.js"
      ],
      "category": "adaptation"
    },
    {
      "id": "field-report",
      "version": "1.0.2",
      "api": 1,
      "global": "FieldReport",
      "summary": "Two hidden buttons for a game or app: five taps in a corner open a panel that saves a speed report (start-up, frames a second, slowest frames, heavy tasks, plain verdict) and an error log, as small Markdown files. No network.",
      "short": "Hidden buttons that save a speed report and an error log from a real device. No network.",
      "file": "modules/field-report/field-report.js",
      "readme": "modules/field-report/README.md",
      "demo": "modules/field-report/demo.html",
      "dependencies": "none",
      "formats": "browser global, CommonJS (module.exports)",
      "category": "adaptation"
    },
    {
      "id": "sprite-baker",
      "version": "1.7.1",
      "api": 1,
      "global": "SpriteBaker",
      "summary": "Tiny software 3D rasterizer that bakes shaded sprites to canvases once at load, or one frame per tick; also makes silhouette masks and packs sprite sheets. Optional WebAssembly fill add-on (same pixels, about 1.1 to 1.4 times faster baking in Chromium and Firefox).",
      "short": "Tiny software 3D rasterizer that bakes shaded sprites to canvases.",
      "file": "modules/sprite-baker/sprite-baker.js",
      "readme": "modules/sprite-baker/README.md",
      "demo": "modules/sprite-baker/demo.html",
      "dependencies": "none",
      "formats": "browser global, CommonJS (module.exports)",
      "category": "looks"
    },
    {
      "id": "pad-nav",
      "version": "1.1.0",
      "api": 1,
      "global": "PadNav",
      "summary": "Gamepad API to DOM focus: move through buttons, menus, sliders and drop-downs with a controller, no game code.",
      "short": "Gamepad to focus: move through buttons, menus and sliders with a controller.",
      "file": "modules/pad-nav/pad-nav.js",
      "readme": "modules/pad-nav/README.md",
      "demo": "modules/pad-nav/demo.html",
      "dependencies": "none",
      "formats": "browser global, CommonJS (module.exports)",
      "category": "controls"
    },
    {
      "id": "image-decode",
      "version": "1.2.2",
      "api": 1,
      "global": "ImageDecode",
      "summary": "Loads PNG, JPEG, WebP and AVIF pictures so the page does not freeze when they are first drawn: picks the right off-thread way for each browser, loads a list in order, and tells whether the browser can read WebP or AVIF.",
      "short": "Loads pictures with no freeze at first draw, the right way per browser, plus WebP/AVIF checks.",
      "file": "modules/image-decode/image-decode.js",
      "readme": "modules/image-decode/README.md",
      "demo": "modules/image-decode/demo.html",
      "dependencies": "none",
      "formats": "browser global, CommonJS (module.exports)",
      "category": "adaptation"
    },
    {
      "id": "tab-guard",
      "version": "1.1.1",
      "api": 1,
      "global": "TabGuard",
      "summary": "Keeps one open copy of a page in charge (Web Locks), so two tabs do not overwrite each other's saved data, and tells the game when the other copy closes.",
      "short": "Keeps one tab in charge so two tabs never overwrite each other's saves.",
      "file": "modules/tab-guard/tab-guard.js",
      "readme": "modules/tab-guard/README.md",
      "demo": "modules/tab-guard/demo.html",
      "dependencies": "none",
      "formats": "browser global, CommonJS (module.exports)",
      "category": "saving"
    },
    {
      "id": "wake-keeper",
      "version": "1.1.0",
      "api": 1,
      "global": "WakeKeeper",
      "summary": "Keeps the screen awake only while a game wants it: released on pause, hidden tab and idle, asked again when allowed, no retry storms.",
      "short": "Keeps the screen awake only while a game wants it.",
      "file": "modules/wake-keeper/wake-keeper.js",
      "readme": "modules/wake-keeper/README.md",
      "demo": "modules/wake-keeper/demo.html",
      "dependencies": "none",
      "formats": "browser global, CommonJS (module.exports)",
      "category": "controls"
    },
    {
      "id": "back-close",
      "version": "1.2.0",
      "api": 1,
      "global": "BackClose",
      "summary": "Makes the phone back swipe or back button close the top panel instead of leaving the page (CloseWatcher, with an opt-in history fallback for browsers without it).",
      "short": "Makes the phone's back swipe close the top panel instead of leaving the page.",
      "file": "modules/back-close/back-close.js",
      "readme": "modules/back-close/README.md",
      "demo": "modules/back-close/demo.html",
      "dependencies": "none",
      "formats": "browser global, CommonJS (module.exports)",
      "category": "controls"
    },
    {
      "id": "lzma-decode",
      "version": "1.3.0",
      "api": 1,
      "global": "lzmaDecode",
      "summary": "LZMA1 decoder that uses WebAssembly first (about 1.5 to 2.6 times faster to open a page) and falls back to a small readable ES5 JavaScript decoder; tested against Python's lzma. Browsers can only unpack gzip and deflate natively.",
      "short": "LZMA decoder: WebAssembly first, small readable JavaScript fallback; tested against Python's lzma.",
      "file": "modules/lzma-decode/lzma-decode-with-wasm.js",
      "readme": "modules/lzma-decode/README.md",
      "demo": "tools/lzma-pack/example/packed-base64.html",
      "dependencies": "none",
      "formats": "browser global, CommonJS (module.exports)",
      "category": "size"
    },
    {
      "id": "ppmd-decode",
      "version": "1.3.0",
      "api": 1,
      "global": "ppmd7Decode",
      "summary": "A PPMd (7-Zip PPMd7) decoder that uses WebAssembly first (about 1.4 to 1.8 times faster to open a page) and falls back to one ES5 JavaScript function, about 6.6 KB packed. It unpacks web-page data about 10% smaller than LZMA, but slower. PPMd is by Dmitry Shkarin; the public-domain code it follows is Igor Pavlov's, from 7-Zip.",
      "short": "A PPMd (7-Zip PPMd7) decoder: WebAssembly first, JavaScript fallback; smaller than LZMA.",
      "file": "modules/ppmd-decode/ppmd-decode-with-wasm.js",
      "readme": "modules/ppmd-decode/README.md",
      "demo": "tools/ppmd-pack/example/packed-base64.html",
      "dependencies": "none",
      "formats": "browser global, CommonJS (module.exports)",
      "category": "size"
    },
    {
      "id": "cartoon-3d-kit",
      "version": "1.3.0",
      "api": 1,
      "summary": "A written style guide plus demo for the soft, glossy cartoon 3D look done in plain CSS and SVG.",
      "short": "A written style guide and demo for the soft, glossy cartoon 3D look in CSS and SVG.",
      "file": "modules/cartoon-3d-kit/STYLE-GUIDE.md",
      "readme": "modules/cartoon-3d-kit/README.md",
      "demo": "modules/cartoon-3d-kit/demo.html",
      "dependencies": "none",
      "category": "looks"
    },
    {
      "id": "gif-writer",
      "version": "1.5.1",
      "api": 1,
      "global": "GifWriter",
      "summary": "Writes animated GIFs from canvas pictures with one shared palette, storing only the pixels that changed (about 6.8 times smaller than gifenc on a mostly still animation).",
      "short": "Writes animated GIFs from canvas frames with one shared palette.",
      "file": "modules/gif-writer/gif-writer.js",
      "readme": "modules/gif-writer/README.md",
      "demo": "modules/gif-writer/demo.html",
      "dependencies": "none",
      "formats": "browser global, CommonJS (module.exports)",
      "category": "visualization"
    },
    {
      "id": "clip-writer",
      "version": "1.0.1",
      "api": 1,
      "global": "ClipWriter",
      "summary": "Turns pictures into a short MP4 or WebM video in the browser with the browser's own video encoder and two small file writers, no libraries; the same add/finish shape as gif-writer, and about 8 times smaller than a GIF of the same pictures in Netflow Map.",
      "short": "Turns pictures into an MP4 or WebM video file.",
      "file": "modules/clip-writer/clip-writer.js",
      "readme": "modules/clip-writer/README.md",
      "demo": "modules/clip-writer/demo.html",
      "dependencies": "none (needs the browser's WebCodecs video encoder)",
      "formats": "browser global, CommonJS (module.exports; the file writers work in Node)",
      "category": "visualization"
    },
    {
      "id": "zip-open",
      "version": "1.3.1",
      "api": 1,
      "global": "ZipOpen",
      "summary": "Opens .zip and Excel .xlsx files safely: limits counted on what really unpacks, so a zip bomb stops at the limit with a plain-words note.",
      "short": "Opens .zip and .xlsx files safely, with limits counted on what really unpacks.",
      "file": "modules/zip-open/zip-open.js",
      "readme": "modules/zip-open/README.md",
      "demo": "modules/zip-open/demo.html",
      "dependencies": "none",
      "formats": "browser global, CommonJS (module.exports)",
      "category": "size"
    },
    {
      "id": "memory-compression",
      "version": "2.6.5",
      "api": 2,
      "global": "MemoryCompression",
      "summary": "Keeps big data packed in memory and brings it back exactly, in one file with one pack/unpack: bytes and typed arrays (a 120 MB scene shrinks to 52%, 41% in small mode, and restores in about 239 ms in Firefox 158.0, against 312 ms with lz4-wasm and 1.5 s with fflate; lower is better) and big lists of plain JavaScript objects (300,000 link objects shrink to 14% of their JSON text, 35% for msgpackr with records). Picks the right layer by itself; MemoryCompressionJSO stays as an alias.",
      "short": "Keeps big arrays, bytes and lists of objects packed in memory and brings them back exactly.",
      "file": "modules/memory-compression/memory-compression.js",
      "readme": "modules/memory-compression/README.md",
      "demo": "modules/memory-compression/demo.html",
      "dependencies": "none",
      "formats": "browser global, CommonJS (module.exports)",
      "category": "efficiency"
    },
    {
      "id": "elias-fano",
      "version": "1.4.0",
      "api": 1,
      "global": "EliasFano",
      "summary": "Keeps sorted whole numbers (ids, positions, links of every item of a map) in a third to a half of the memory of plain arrays and still answers 'value number i' and 'first value at or above x' without unpacking; also keeps many sorted lists in one structure and decodes them all at once. WebAssembly with SIMD, plain JavaScript fallback with the same answers.",
      "short": "Packs sorted number lists small and searches them without unpacking.",
      "file": "modules/elias-fano/elias-fano.js",
      "readme": "modules/elias-fano/README.md",
      "demo": "modules/elias-fano/demo.html",
      "dependencies": "none",
      "formats": "browser global, CommonJS (module.exports)",
      "category": "efficiency"
    },
    {
      "id": "graph-walk",
      "version": "0.1.0",
      "api": 0,
      "global": "GraphWalk",
      "summary": "Breadth-first distances and depth-first loop marking over a links-of-every-item layout in typed arrays, with no recursion. Same answers as Netflow Map's inline walks.",
      "short": "Breadth-first distances and loop marking for link lists, in typed arrays.",
      "file": "modules/graph-walk/graph-walk.js",
      "readme": "modules/graph-walk/README.md",
      "dependencies": "none",
      "formats": "browser global, CommonJS (module.exports)",
      "category": "math"
    },
    {
      "id": "lfc-pack",
      "version": "0.1.8",
      "api": 0,
      "global": "LfcPack",
      "summary": "Packs newline-delimited JSON (logs, events, API dumps) into LFC-pack (.json.lfc): every field becomes a typed column inside zstd blocks, with a footer of per-block number ranges. Reads back the same rows as JSON.parse (or the exact original bytes), only some keys, or only a time range, with helper workers for big files. WebAssembly is required; a Python reader is included.",
      "short": "Packs NDJSON into small column files and reads the rows back, exactly if you ask.",
      "file": "modules/lfc-pack/lfc-pack.js",
      "readme": "modules/lfc-pack/README.md",
      "demo": "modules/lfc-pack/demo.html",
      "dependencies": "none (needs WebAssembly)",
      "formats": "browser global, CommonJS (module.exports)",
      "category": "efficiency"
    },
    {
      "id": "text-columns",
      "version": "0.1.1",
      "api": 0,
      "global": "TextColumns",
      "summary": "Reads CSV or TSV text into typed columns: plain decimal columns come out as Float64Array straight from the bytes, the rest as text. The field scan runs in WebAssembly SIMD; plain JavaScript gives the same answers.",
      "short": "Reads CSV and TSV into number and text columns, 3 to 11 times faster than common parsers.",
      "file": "modules/text-columns/text-columns.js",
      "readme": "modules/text-columns/README.md",
      "demo": "modules/text-columns/demo.html",
      "dependencies": "none",
      "formats": "browser global, CommonJS (module.exports)",
      "category": "efficiency"
    },
    {
      "id": "pcodec-js",
      "version": "1.6.1",
      "api": 1,
      "global": "PcodecJS",
      "summary": "Pcodec for web pages: unpacks (and optionally packs) big lists of numbers in a browser, one file, same bytes as any other Pcodec. The unpack-only file is 61 KB gzipped (the other JavaScript build of Pcodec is 324 KB), streams a 4,000,000-number file in 6.3 MB of memory, and WebAssembly is required (no plain-JavaScript backup).",
      "short": "Pcodec number compression for web pages: unpack, and optionally pack, big lists of numbers.",
      "file": "modules/pcodec-js/pcodec-js.js",
      "readme": "modules/pcodec-js/README.md",
      "demo": "modules/pcodec-js/demo.html",
      "dependencies": "none (needs WebAssembly)",
      "formats": "browser global, CommonJS (module.exports)",
      "category": "size"
    },
    {
      "id": "netflow-sankey",
      "version": "2.3.0",
      "api": 2,
      "global": "NetflowSankey",
      "summary": "Lays out a flow chart (Sankey) from a plain list of links, with about half the weighted crossings of d3-sankey on the charts measured, backward links drawn instead of crashing, and an SVG drawer.",
      "short": "Lays out a Sankey flow chart from a list of links, with an SVG drawer.",
      "file": "modules/netflow-sankey/netflow-sankey.js",
      "readme": "modules/netflow-sankey/README.md",
      "demo": "modules/netflow-sankey/demo.html",
      "dependencies": "none",
      "formats": "browser global, CommonJS (module.exports)",
      "category": "visualization"
    },
    {
      "id": "netflow-engine",
      "version": "2.2.2",
      "api": 2,
      "global": "NetflowEngine",
      "summary": "The engine of Netflow Map as a module you can copy and adapt: nine views of a map and eleven network layouts, no two items on top of each other, WebAssembly twins for Force and Distances, and a use() hand-over for the layers and Sankey add-ons; a 30,000-item network lays out in about 0.8 s in the Netflow Map app (Firefox).",
      "short": "Netflow Map's engine as an adaptable module: nine views, network layouts, add-on hand-over.",
      "file": "modules/netflow-engine/netflow-engine.js",
      "readme": "modules/netflow-engine/README.md",
      "demo": "modules/netflow-engine/demo.html",
      "dependencies": "none to run; netflow-layers 1.2.0 or newer for the story views",
      "formats": "browser global, CommonJS (module.exports)",
      "category": "visualization"
    },
    {
      "id": "netflow-layers",
      "version": "1.5.1",
      "api": 1,
      "global": "NetflowLayers",
      "summary": "Lays out a graph in rows (top to bottom or left to right) with story order, tags instead of very long links, a column for the pages every route passes, and tall maps cut into columns.",
      "short": "Lays out a graph in rows, with tags for long links and tall maps cut into columns.",
      "file": "modules/netflow-layers/netflow-layers.js",
      "readme": "modules/netflow-layers/README.md",
      "demo": "modules/netflow-layers/demo.html",
      "dependencies": "none",
      "formats": "browser global, CommonJS (module.exports)",
      "category": "visualization"
    },
    {
      "id": "netflow-scene",
      "version": "1.3.1",
      "api": 1,
      "global": "NetflowScene",
      "summary": "Turns a Netflow Map layout into plain drawing lists (dots, links, labels, ribbons, shapes) that Canvas 2D, WebGL2, WebGPU or SVG can draw the same way; big flat maps keep links in typed lists and reuse link looks between pictures.",
      "short": "Turns a laid-out map into plain drawing lists for Canvas, WebGL or SVG.",
      "file": "modules/netflow-scene/netflow-scene.js",
      "readme": "modules/netflow-scene/README.md",
      "demo": "modules/netflow-scene/demo.html",
      "dependencies": "none (uses netflow-engine output; netflow-engine's number formatter when present; the optional position index file needs elias-fano)",
      "formats": "browser global, CommonJS (module.exports)",
      "category": "visualization"
    },
    {
      "id": "walker-sim",
      "version": "2.4.0",
      "api": 2,
      "global": "WalkerSim",
      "summary": "Simulates random walkers on a network with seeded, repeatable runs, 16 random-number distributions, 95% ranges and the exact odds to check against (1,000,000 walkers in about 52 ms with the WebAssembly loop in Chromium 155 and Firefox 158, lower is better). Big runs use a WebAssembly loop first, JavaScript when it cannot.",
      "short": "Simulates random walkers on a network: seeded runs, 95% ranges, exact odds.",
      "file": "modules/walker-sim/walker-sim-with-wasm.js",
      "readme": "modules/walker-sim/README.md",
      "demo": "modules/walker-sim/demo.html",
      "dependencies": "none",
      "formats": "browser global, CommonJS (module.exports)",
      "category": "simulation"
    },
    {
      "id": "slow-note",
      "version": "1.0.0",
      "api": 1,
      "global": "SlowNote",
      "summary": "Keeps a short note, only on the device, of the errors, slow taps and long frames a page had; copyable as plain text, nothing is sent anywhere.",
      "short": "A short private note of errors, slow taps and long frames, copyable as text.",
      "file": "modules/slow-note/slow-note.js",
      "readme": "modules/slow-note/README.md",
      "demo": "modules/slow-note/demo.html",
      "dependencies": "none",
      "formats": "browser global, CommonJS (module.exports)",
      "category": "adaptation"
    },
    {
      "id": "grown-ups-door",
      "version": "1.0.0",
      "api": 1,
      "global": "GrownUpsDoor",
      "summary": "A hold-then-drag task a young child will not finish, in front of the buttons and links a grown-up should press (a speed bump, not security).",
      "short": "A hold-and-drag task a young child will not finish, in front of grown-up buttons.",
      "file": "modules/grown-ups-door/grown-ups-door.js",
      "readme": "modules/grown-ups-door/README.md",
      "demo": "modules/grown-ups-door/demo.html",
      "dependencies": "none",
      "formats": "browser global, CommonJS (module.exports)",
      "category": "assist"
    },
    {
      "id": "spotlight-tour",
      "version": "1.1.1",
      "api": 1,
      "global": "SpotlightTour",
      "summary": "A first-time tour: one dimmed layer, a bright window over the current part, Skip and Back, remembers who saw it and gives a finishing gift once.",
      "short": "A first-visit tour: dimmed page, bright window, Skip and Back, remembers who saw it.",
      "file": "modules/spotlight-tour/spotlight-tour.js",
      "readme": "modules/spotlight-tour/README.md",
      "demo": "modules/spotlight-tour/demo.html",
      "dependencies": "none",
      "formats": "browser global, CommonJS (module.exports)",
      "category": "assist"
    }
  ],
  "tools": [
    {
      "id": "single-file-tools",
      "version": "1.2.0",
      "api": 1,
      "summary": "Font subsetting, safe inline-SVG tightening and a Zopfli self-extracting packer for one-file games.",
      "short": "Font subsetting, safe inline-SVG tightening and a Zopfli self-extracting packer.",
      "folder": "tools/single-file-tools",
      "readme": "tools/single-file-tools/README.md",
      "category": "efficiency",
      "file": [
        "tools/single-file-tools/optfonts.py",
        "tools/single-file-tools/optsvg.js",
        "tools/single-file-tools/pack.py"
      ]
    },
    {
      "id": "lzma-pack",
      "version": "2.0.0",
      "api": 2,
      "summary": "Packs one HTML file into a smaller self-unpacking file with LZMA and a hash check (Python 3 standard library).",
      "short": "Packs one HTML file into a smaller self-unpacking file with LZMA (Python 3).",
      "folder": "tools/lzma-pack",
      "readme": "tools/lzma-pack/README.md",
      "category": "size",
      "file": [
        "tools/lzma-pack/pack.py"
      ]
    },
    {
      "id": "ppmd-pack",
      "version": "2.0.0",
      "api": 2,
      "summary": "Packs one HTML file into a self-unpacking file with PPMd, the 7-Zip text compressor (PPMd by Dmitry Shkarin; public-domain code by Igor Pavlov, 7-Zip). Pure Python; pays off above about 60 KB of compressed data.",
      "short": "Packs one HTML file into a self-unpacking file with PPMd (pure Python).",
      "folder": "tools/ppmd-pack",
      "readme": "tools/ppmd-pack/README.md",
      "category": "size",
      "file": [
        "tools/ppmd-pack/pack.py",
        "tools/ppmd-pack/ppmd7_encode.py"
      ]
    },
    {
      "id": "fuzz-kit",
      "version": "1.3.4",
      "api": 1,
      "summary": "Seeded, reproducible random-input fuzzer engine with weighted operations, invariants, liveness checks and failure shrinking; Playwright and Puppeteer runners with real input and CPU throttling; stock-Firefox recipe; test-hook stripper.",
      "short": "Seeded random-input fuzzer for games, with failure shrinking and browser runners.",
      "folder": "tools/fuzz-kit",
      "readme": "tools/fuzz-kit/README.md",
      "category": "testing",
      "file": [
        "tools/fuzz-kit/src/fuzz-core.js",
        "tools/fuzz-kit/runner/fuzz_playwright.py",
        "tools/fuzz-kit/runner/fuzz_puppeteer.mjs",
        "tools/fuzz-kit/runner/page-driver.js",
        "tools/fuzz-kit/tools/check-shipped.js",
        "tools/fuzz-kit/tools/strip-test-hooks.js"
      ]
    },
    {
      "id": "canvas-probe",
      "version": "1.1.1",
      "api": 1,
      "summary": "Test-build counter for canvas 2D games: calls per frame, save/restore leaks, overhanging drawImage sources, draws below half size, style-write repeats, painted area.",
      "short": "Test-build counter for canvas 2D games: calls per frame, leaks, repeated style writes.",
      "folder": "tools/canvas-probe",
      "readme": "tools/canvas-probe/README.md",
      "category": "testing",
      "file": [
        "tools/canvas-probe/src/canvas-probe.js"
      ]
    },
    {
      "id": "storage-probe",
      "version": "1.1.0",
      "api": 1,
      "summary": "Page that tells you in plain words whether copies of a page saved in different folders share their saved data, see each other's writes and locks; one button, copyable report.",
      "short": "A one-button page that says whether copies of a page share their saved data.",
      "folder": "tools/storage-probe",
      "readme": "tools/storage-probe/README.md",
      "category": "testing",
      "file": [
        "tools/storage-probe/storage-probe.html"
      ],
      "demo": "tools/storage-probe/storage-probe.html"
    },
    {
      "id": "firefox-stand-in",
      "version": "1.1.0",
      "api": 1,
      "summary": "Runs a Playwright-for-Python test in stock Firefox (through Selenium and geckodriver) without rewriting it; says plainly which calls it supports and stops with a clear message on the rest.",
      "short": "Runs a Playwright-for-Python test in stock Firefox without rewriting it.",
      "folder": "tools/firefox-stand-in",
      "readme": "tools/firefox-stand-in/README.md",
      "category": "testing",
      "file": [
        "tools/firefox-stand-in/pwfirefox.py",
        "tools/firefox-stand-in/run-in-firefox.py"
      ]
    },
    {
      "id": "webkit-driver",
      "version": "1.4.1",
      "api": 1,
      "summary": "Drives WebKitGTK or GNOME Web from Node with no dependencies, using the call names of Playwright and Puppeteer (goto, evaluate, waitForFunction, mouse, keyboard, screenshot, console errors), so a test written for them can also run in WebKit.",
      "short": "Drives WebKitGTK or GNOME Web from Node with Playwright-style calls, no dependencies.",
      "folder": "tools/webkit-driver",
      "readme": "tools/webkit-driver/README.md",
      "category": "testing",
      "file": [
        "tools/webkit-driver/webkit-driver.js"
      ]
    },
    {
      "id": "test-isolation",
      "version": "1.1.0",
      "api": 1,
      "summary": "Puts a prefix in front of every localStorage key on a test page, so a speed test or random-play run never touches the real saved game.",
      "short": "Prefixes every localStorage key on a test page so tests never touch the real save.",
      "folder": "tools/test-isolation",
      "readme": "tools/test-isolation/README.md",
      "category": "testing",
      "file": [
        "tools/test-isolation/test-isolation.js"
      ]
    },
    {
      "id": "speed-lab",
      "version": "1.1.1",
      "api": 1,
      "summary": "One-button speed test run on the device: compares your page with parts switched off, keeps the scene in view and uncovered, and says the answer in plain sentences with a copyable table.",
      "short": "A one-button speed test on the device: switches parts off and says what costs time.",
      "folder": "tools/speed-lab",
      "readme": "tools/speed-lab/README.md",
      "category": "testing",
      "file": [
        "tools/speed-lab/speed-lab.js"
      ],
      "demo": "tools/speed-lab/demo.html"
    },
    {
      "id": "test-runner",
      "version": "1.3.0",
      "api": 1,
      "summary": "Shared pieces for browser checks and speed tests: warm browsers, a four-browser runner, fair timing, skip-unchanged wasm builds, a wasm-versus-JavaScript twin test, a picture fingerprint gate and an automatic bisect.",
      "short": "Warm browsers, fair timing, skipped rebuilds, wasm-vs-JS twin test, picture gate and bisect.",
      "folder": "tools/test-runner",
      "readme": "tools/test-runner/README.md",
      "category": "testing",
      "file": [
        "tools/test-runner/runner.js",
        "tools/test-runner/cli.js",
        "tools/test-runner/warmd.js",
        "tools/test-runner/twin.js",
        "tools/test-runner/noise.js",
        "tools/test-runner/stamp.js",
        "tools/test-runner/fingerprint.js",
        "tools/test-runner/bisect.js"
      ]
    },
    {
      "id": "speed-guard",
      "version": "1.0.0",
      "api": 1,
      "summary": "One command that says whether a release got slower than the one before it, from the speed-history files, and which browser checks a change needs re-run. It runs nothing itself, so it costs no browser time.",
      "short": "Flags speed-history steps over 5% slower than the last release; lists the browser checks to re-run.",
      "folder": "tools/speed-guard",
      "readme": "tools/speed-guard/README.md",
      "category": "testing",
      "file": [
        "tools/speed-guard/speed-guard.py"
      ]
    }
  ],
  "related": {
    "repository": "https://github.com/lfcfoundry/story-editor",
    "pages": "https://lfcfoundry.github.io/story-editor/",
    "note": "Story packages live with the editor they are generated from.",
    "packages": [
      {
        "id": "story-format",
        "summary": "Create, clean, search, import and export interactive stories as JSON, with a JSON Schema. Twine import lives in twine-import.",
        "short": "Create, clean, search, import and export interactive stories as JSON, with a schema.",
        "version": "2.0.0",
        "readme": "https://github.com/lfcfoundry/story-editor/blob/main/packages/story-format/README.md",
        "category": "story-data",
        "file": "packages/story-format/dist/story-format.global.js",
        "size": 50575,
        "gz": 14313
      },
      {
        "id": "twine-import",
        "summary": "Reads Twine stories (Twine 2 HTML, Twee 3, Twine 1) and turns SugarCube and Harlowe code into rules, with a plain-words report.",
        "short": "Reads Twine stories (Twine 2 HTML, Twee 3, Twine 1) and turns their code into rules.",
        "version": "1.0.0",
        "readme": "https://github.com/lfcfoundry/story-editor/blob/main/packages/twine-import/README.md",
        "category": "story-data",
        "file": "packages/twine-import/dist/twine-import.global.js",
        "size": 95682,
        "gz": 25578
      },
      {
        "id": "story-outline",
        "summary": "Turns an indented outline into pages and choices, or into a whole branching story.",
        "short": "Turns an indented outline into pages and choices, or a whole branching story.",
        "version": "1.0.0",
        "readme": "https://github.com/lfcfoundry/story-editor/blob/main/packages/story-outline/README.md",
        "category": "story-data",
        "file": "packages/story-outline/dist/story-outline.global.js",
        "size": 26334,
        "gz": 8135
      },
      {
        "id": "story-diff",
        "summary": "Says in plain words what one edit did to a story, such as \"Add page \u201cThe Cellar\u201d\".",
        "short": "Says in plain words what one edit did to a story.",
        "version": "1.0.0",
        "readme": "https://github.com/lfcfoundry/story-editor/blob/main/packages/story-diff/README.md",
        "category": "story-data",
        "file": "packages/story-diff/dist/story-diff.global.js",
        "size": 6289,
        "gz": 2003
      },
      {
        "id": "story-check",
        "summary": "Exact checker for branching stories with items, numbers and dice: dead ends and endings no player can reach.",
        "short": "Exact checker for branching stories: dead ends and endings no player can reach.",
        "version": "1.0.0",
        "readme": "https://github.com/lfcfoundry/story-editor/blob/main/packages/story-check/README.md",
        "category": "story-validation",
        "file": "packages/story-check/dist/story-check.global.js",
        "size": 73762,
        "gz": 20441
      },
      {
        "id": "story-player",
        "summary": "Build one offline HTML game from a story, or play a story from code or a terminal.",
        "short": "Builds one offline HTML game from a story, or plays a story from code or a terminal.",
        "version": "1.0.1",
        "readme": "https://github.com/lfcfoundry/story-editor/blob/main/packages/story-player/README.md",
        "category": "story-build",
        "file": "packages/story-player/dist/story-player.global.js",
        "size": 75072,
        "gz": 24827
      },
      {
        "id": "story-map",
        "summary": "Layered, arc and matrix drawings of a story graph (SVG) and seeded simulated players.",
        "short": "Layered, arc and matrix drawings of a story graph, plus simulated players.",
        "version": "1.0.0",
        "readme": "https://github.com/lfcfoundry/story-editor/blob/main/packages/story-map/README.md",
        "category": "story-flow",
        "file": "packages/story-map/dist/story-map.global.js",
        "size": 61459,
        "gz": 18222
      },
      {
        "id": "zip-page",
        "summary": "Wrap a finished HTML page into a smaller page that unzips itself, with a pure-JS inflater fallback.",
        "short": "Shrinks a finished HTML page into a self-unzipping page.",
        "version": "1.0.0",
        "readme": "https://github.com/lfcfoundry/story-editor/blob/main/packages/zip-page/README.md",
        "category": "story-packaging",
        "file": "packages/zip-page/dist/zip-page.global.js",
        "size": 6670,
        "gz": 2725
      },
      {
        "id": "qa-kit",
        "summary": "Tiered test runner and a Playwright-style API over WebDriver BiDi for stock Firefox; seeded random-story generator.",
        "short": "Tiered test runner and Playwright-style API for stock Firefox, plus a random-story generator.",
        "version": "0.2.1",
        "readme": "https://github.com/lfcfoundry/story-editor/blob/main/packages/qa-kit/README.md",
        "category": "story-testing",
        "file": "packages/qa-kit/src",
        "size": 95302,
        "gz": 31031
      },
      {
        "id": "contract-kit",
        "summary": "A guide and a helper (about 7.2 KB minified) for keeping two implementations of one rule set from drifting apart: seeded random inputs, a side-by-side comparison (also for async functions), shrinking a failing input to a small one, a field table and a time limit; runs in browsers too.",
        "short": "Keeps two implementations of one rule set in step: random inputs, side-by-side comparison.",
        "version": "1.1.0",
        "readme": "https://github.com/lfcfoundry/story-editor/blob/main/packages/contract-kit/README.md",
        "category": "story-testing",
        "file": "packages/contract-kit/src",
        "size": 16684,
        "gz": 5789
      },
      {
        "id": "ai-collab-kit",
        "summary": "A written process and templates for a person and an AI assistant building software together.",
        "short": "A written process and templates for a person and an AI assistant building software together.",
        "readme": "https://github.com/lfcfoundry/story-editor/blob/main/packages/ai-collab-kit/README.md",
        "category": "ai-helper",
        "file": "packages/ai-collab-kit/GUIDE.md",
        "size": 14103,
        "gz": 6402
      }
    ],
    "storyEditorCommit": "abc02a1"
  },
  "categories": {
    "pieces": {
      "title": "Modules & Tools",
      "groups": [
        {
          "id": "adaptation",
          "title": "Device and browser adaptation",
          "use": "Make a game behave on slow phones, privacy-focused browsers and power-saving screens."
        },
        {
          "id": "saving",
          "title": "Saving and data safety",
          "use": "Keep a player's progress safe and let them move it between devices."
        },
        {
          "id": "looks",
          "title": "Games - Looks and effects",
          "use": "Curtains, flying elements, lettering and 3D-looking sprites."
        },
        {
          "id": "controls",
          "title": "Games - Controls",
          "use": "Let players hold a button, or play with a gamepad."
        },
        {
          "id": "assist",
          "title": "Games - Assist",
          "use": "Show a new player around, and keep small children away from the buttons that matter."
        },
        {
          "id": "math",
          "title": "Games - Math",
          "use": "The numbers behind idle and clicker games."
        },
        {
          "id": "testing",
          "title": "Games - Testing",
          "use": "Test a game by playing it at random, shrinking any failure to a short replay, counting what it draws and driving real browsers."
        },
        {
          "id": "efficiency",
          "title": "App - Efficiency",
          "use": "Keep a one-file app small and light: smaller data in memory, smaller pages on the wire."
        },
        {
          "id": "simulation",
          "title": "Model simulation",
          "use": "Simulate random walkers over a graph."
        },
        {
          "id": "visualization",
          "title": "Visualization",
          "use": "Draw maps, flow charts and animated pictures from data."
        },
        {
          "id": "size",
          "title": "Size and packaging",
          "use": "Open zip and Excel files safely, and pack a finished page into a smaller file that unpacks itself."
        }
      ]
    },
    "stories": {
      "title": "Story editor packages",
      "groups": [
        {
          "id": "story-data",
          "title": "Story data",
          "use": "Create, clean, import and save stories in one shared file format."
        },
        {
          "id": "story-validation",
          "title": "Story validation",
          "use": "Find dead ends and endings nobody can reach before a reader does."
        },
        {
          "id": "story-flow",
          "title": "Story flow",
          "use": "See a story's shape: maps of its pages and simulated readers."
        },
        {
          "id": "story-build",
          "title": "Story build and distribute",
          "use": "Turn a story into a game, or play it from code or a terminal."
        },
        {
          "id": "story-packaging",
          "title": "Story packaging",
          "use": "Pack a finished story page into a smaller page."
        },
        {
          "id": "story-testing",
          "title": "Story testing",
          "use": "Run tests on stock Firefox, generate random stories and keep two implementations in step."
        }
      ]
    },
    "ai": {
      "title": "AI knowledge base",
      "groups": [
        {
          "id": "ai-helper",
          "title": "Working with an AI helper",
          "use": "A written process for a person and an AI assistant building software together."
        }
      ]
    }
  }
}