@wasm-gaming/fbneo-wasm 0.1.2 → 0.3.0

package/dist/fbneo/fbneo.options.d.ts

@@ -1,27 +1,80 @@
-import type { JSONSchema } from '@wasm-gaming/engine-specs';
+/**
+ * What FBNeo accepts, as types and as data.
+ *
+ * The four payloads of the wasm-gaming engine contract, closed for this engine, and
+ * {@link FBNEO_SPEC} — the same thing as data the contract's base class reads: every
+ * default lives there and nowhere else.
+ */
+import type { EnginePayloads, EngineSpec } from '@wasm-gaming/engine-specs';
+/** Bytes, or a thunk that produces them only when the engine actually needs them. */
+export type FbneoAsset = Uint8Array | ArrayBuffer | null | (() => Uint8Array | ArrayBuffer | null | Promise<Uint8Array | ArrayBuffer | null>);
+/** The engine: fixed for the life of the wasm instance (`renderFilter` aside). */
+export interface FbneoConfig {
+    /** How the picture is scaled to the mount: crisp pixels or linear filtering. */
+    renderFilter?: 'pixelated' | 'smooth';
+    /** Emscripten glue URL. Defaults to `./fbneo.js` next to the SDK. */
+    jsUrl?: string;
+    /** WASM URL. Defaults to `./fbneo.wasm` next to the SDK. */
+    wasmUrl?: string;
+}
+/** The session: which game the ROM set is. */
 export interface FbneoOptions {
     /**
-     * Filename used when writing the ROM zip bytes to Emscripten MEMFS.
-     * FBNeo identifies a game by the zip filename (without extension), so this
-     * should match the driver's expected ROM set name (e.g. "mslug" for Metal Slug).
+     * The FBNeo driver (ROM-set short name, e.g. `mslug`). When empty it is taken from
+     * {@link FbneoOptions.romFileName}; the `romset` helper can recover it from a zip's
+     * contents when the file name is unreliable.
      */
+    driver?: string;
+    /** The ROM zip's file name (`mslug.zip`), used for the driver when `driver` is empty. */
     romFileName?: string;
     /**
-     * The FBNeo driver/game name to load (e.g. "mslug", "sf2", "kof98").
-     * If omitted, the driver is inferred from `romFileName` (without extension).
+     * How a Neo Geo set boots: `mvs`, the arcade board (coins, credits — FBNeo's default),
+     * or `aes`, the home console: the AES BIOS from the `bios` zip (or Universe BIOS 4.0 in
+     * AES mode) and a memory card per game. Other systems ignore it.
      */
-    driver?: string;
-    /** Canvas scaling filter: `pixelated` for crisp pixels, `smooth` for linear filtering. */
-    renderFilter?: 'pixelated' | 'smooth';
-    /** Target audio sample rate in Hz. FBNeo defaults to 44100. */
-    audioSampleRate?: number;
-    /** Enable vertical sync. Defaults to true. */
-    vsync?: boolean;
-    /** Use integer scaling (no fractional stretching). Defaults to false. */
-    integerScale?: boolean;
-    /** Window scale multiplier for the internal render resolution. Defaults to 2. */
-    windowScale?: number;
+    neogeo?: 'mvs' | 'aes';
+}
+export interface FbneoAssets {
+    /** The game's ROM set: a `.zip` (or `.7z`) named after its driver. Required to start. */
+    rom?: FbneoAsset;
+    /** A system BIOS set some games need (`neogeo.zip` for Neo Geo). */
+    bios?: FbneoAsset;
+}
+/** Where this engine's files live, and whether they outlive the page. */
+export interface FbneoStorage {
+    /**
+     * Per-game folder for NVRAM/EEPROM, hiscores and save states.
+     *
+     * Relative to the engine's own folder: the SDK always prefixes `fbneo/`, so the files
+     * land in OPFS `fbneo/<namespace>/` and no namespace can reach another engine's
+     * files. Segments are cleaned (`.`/`..` dropped, odd characters → `_`); anything
+     * unusable becomes `"default"`. `play.storagePath` gives the result.
+     *
+     * @defaultValue `"default"`
+     */
+    namespace?: string;
+    /** `null` keeps nothing; leaving it out (or `'opfs'`) mirrors the save folder to OPFS. */
+    persist?: 'opfs' | null;
+}
+/** Engine events beyond the contract's core set. */
+export interface FbneoEvents {
+    /** Save files were just written to `fbneo/<namespace>/` (names relative to it). */
+    saves: {
+        files: string[];
+    };
+}
+export interface FbneoPayloads extends EnginePayloads {
+    config: FbneoConfig;
+    options: FbneoOptions;
+    assets: FbneoAssets;
+    storage: FbneoStorage;
+    events: FbneoEvents;
 }
-export declare const DEFAULT_FBNEO_OPTIONS: Required<FbneoOptions>;
-export declare const FBNEO_OPTIONS_SCHEMA: JSONSchema;
+/** The canvas's backing size; FBNeo scales each game's picture into it. */
+export declare const FBNEO_VIDEO: {
+    readonly width: 640;
+    readonly height: 480;
+    readonly aspect: "4:3";
+};
+export declare const FBNEO_SPEC: EngineSpec<FbneoPayloads>;
 //# sourceMappingURL=fbneo.options.d.ts.map

package/dist/fbneo/fbneo.options.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"fbneo.options.d.ts","sourceRoot":"","sources":["../../src/fbneo.options.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,2BAA2B,CAAC;AAE5D,MAAM,WAAW,YAAY;IAC3B;;;;OAIG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,0FAA0F;IAC1F,YAAY,CAAC,EAAE,WAAW,GAAG,QAAQ,CAAC;IACtC,+DAA+D;IAC/D,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,8CAA8C;IAC9C,KAAK,CAAC,EAAE,OAAO,CAAC;IAChB,yEAAyE;IACzE,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB,iFAAiF;IACjF,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED,eAAO,MAAM,qBAAqB,EAAE,QAAQ,CAAC,YAAY,CAQxD,CAAC;AAEF,eAAO,MAAM,oBAAoB,EAAE,UA8ClC,CAAC"}
+{"version":3,"file":"fbneo.options.d.ts","sourceRoot":"","sources":["../../src/fbneo.options.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AACH,OAAO,KAAK,EAAE,cAAc,EAAE,UAAU,EAAE,MAAM,2BAA2B,CAAC;AAE5E,qFAAqF;AACrF,MAAM,MAAM,UAAU,GAClB,UAAU,GACV,WAAW,GACX,IAAI,GACJ,CAAC,MAAM,UAAU,GAAG,WAAW,GAAG,IAAI,GAAG,OAAO,CAAC,UAAU,GAAG,WAAW,GAAG,IAAI,CAAC,CAAC,CAAC;AAEvF,kFAAkF;AAClF,MAAM,WAAW,WAAW;IAC1B,gFAAgF;IAChF,YAAY,CAAC,EAAE,WAAW,GAAG,QAAQ,CAAC;IACtC,qEAAqE;IACrE,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,4DAA4D;IAC5D,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED,8CAA8C;AAC9C,MAAM,WAAW,YAAY;IAC3B;;;;OAIG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,yFAAyF;IACzF,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;;;OAIG;IACH,MAAM,CAAC,EAAE,KAAK,GAAG,KAAK,CAAC;CACxB;AAED,MAAM,WAAW,WAAW;IAC1B,yFAAyF;IACzF,GAAG,CAAC,EAAE,UAAU,CAAC;IACjB,oEAAoE;IACpE,IAAI,CAAC,EAAE,UAAU,CAAC;CACnB;AAED,yEAAyE;AACzE,MAAM,WAAW,YAAY;IAC3B;;;;;;;;;OASG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,0FAA0F;IAC1F,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACzB;AAED,oDAAoD;AACpD,MAAM,WAAW,WAAW;IAC1B,mFAAmF;IACnF,KAAK,EAAE;QAAE,KAAK,EAAE,MAAM,EAAE,CAAA;KAAE,CAAC;CAC5B;AAED,MAAM,WAAW,aAAc,SAAQ,cAAc;IACnD,MAAM,EAAE,WAAW,CAAC;IACpB,OAAO,EAAE,YAAY,CAAC;IACtB,MAAM,EAAE,WAAW,CAAC;IACpB,OAAO,EAAE,YAAY,CAAC;IACtB,MAAM,EAAE,WAAW,CAAC;CACrB;AAED,2EAA2E;AAC3E,eAAO,MAAM,WAAW;;;;CAAsD,CAAC;AAE/E,eAAO,MAAM,UAAU,EAAE,UAAU,CAAC,aAAa,CAqDhD,CAAC"}

package/dist/fbneo/fbneo.options.js

@@ -1,55 +1,56 @@
-export const DEFAULT_FBNEO_OPTIONS = {
-    romFileName: 'game.zip',
-    driver: '',
-    renderFilter: 'pixelated',
-    audioSampleRate: 44100,
-    vsync: true,
-    integerScale: false,
-    windowScale: 2,
-};
-export const FBNEO_OPTIONS_SCHEMA = {
-    type: 'object',
-    additionalProperties: false,
-    properties: {
-        romFileName: {
-            type: 'string',
-            default: 'game.zip',
-            description: 'ROM zip filename written to Emscripten MEMFS when loading a game.',
+/** The canvas's backing size; FBNeo scales each game's picture into it. */
+export const FBNEO_VIDEO = { width: 640, height: 480, aspect: '4:3' };
+export const FBNEO_SPEC = {
+    config: {
+        renderFilter: {
+            default: 'pixelated',
+            enum: ['pixelated', 'smooth'],
+            live: true,
+            description: 'Scaling: crisp pixels or linear filtering.',
         },
+        jsUrl: { live: false, description: 'Emscripten glue URL. Defaults to ./fbneo.js.' },
+        wasmUrl: { live: false, description: 'WASM URL. Defaults to ./fbneo.wasm.' },
+    },
+    options: {
         driver: {
-            type: 'string',
             default: '',
-            description: 'FBNeo driver/game name to load (e.g. "mslug"). If empty, inferred from romFileName without extension.',
+            live: false,
+            description: 'FBNeo driver (ROM-set short name, e.g. "mslug"). Empty: taken from romFileName.',
         },
-        renderFilter: {
-            type: 'string',
-            enum: ['pixelated', 'smooth'],
-            default: 'pixelated',
-            description: 'Canvas scaling filter: pixelated for crisp pixels, smooth for linear filtering.',
-        },
-        audioSampleRate: {
-            type: 'integer',
-            default: 44100,
-            minimum: 11025,
-            maximum: 96000,
-            description: 'Target audio sample rate in Hz.',
-        },
-        vsync: {
-            type: 'boolean',
-            default: true,
-            description: 'Enable vertical sync.',
-        },
-        integerScale: {
-            type: 'boolean',
-            default: false,
-            description: 'Use integer scaling (no fractional stretching).',
-        },
-        windowScale: {
-            type: 'integer',
-            default: 2,
-            minimum: 1,
-            maximum: 8,
-            description: 'Window scale multiplier for the internal render resolution.',
+        romFileName: {
+            default: '',
+            live: false,
+            description: 'The ROM zip file name; its stem is the driver when driver is empty.',
+        },
+        neogeo: {
+            default: 'mvs',
+            enum: ['mvs', 'aes'],
+            live: false,
+            description: 'Neo Geo sets: mvs (arcade, FBNeo default) or aes (home console: AES BIOS, memory card).',
+        },
+    },
+    assets: {
+        rom: {
+            allowedTypes: ['.zip', '.7z'],
+            live: false,
+            description: 'The arcade ROM set, named after its driver. Required to start.',
+        },
+        bios: {
+            allowedTypes: ['.zip'],
+            live: false,
+            description: 'Optional system BIOS set (neogeo.zip for Neo Geo).',
+        },
+    },
+    storage: {
+        namespace: {
+            default: 'default',
+            live: false,
+            description: "Folder for this game's saves, inside the engine's own fbneo/ folder (OPFS fbneo/<namespace>/).",
+        },
+        persist: {
+            enum: ['opfs', null],
+            live: false,
+            description: 'null keeps nothing; otherwise saves are mirrored to OPFS.',
         },
     },
 };

package/dist/fbneo/fbneo.options.js.map

@@ -1 +1 @@
-{"version":3,"file":"fbneo.options.js","sourceRoot":"","sources":["../../src/fbneo.options.ts"],"names":[],"mappings":"AA0BA,MAAM,CAAC,MAAM,qBAAqB,GAA2B;IAC3D,WAAW,EAAE,UAAU;IACvB,MAAM,EAAE,EAAE;IACV,YAAY,EAAE,WAAW;IACzB,eAAe,EAAE,KAAK;IACtB,KAAK,EAAE,IAAI;IACX,YAAY,EAAE,KAAK;IACnB,WAAW,EAAE,CAAC;CACf,CAAC;AAEF,MAAM,CAAC,MAAM,oBAAoB,GAAe;IAC9C,IAAI,EAAE,QAAQ;IACd,oBAAoB,EAAE,KAAK;IAC3B,UAAU,EAAE;QACV,WAAW,EAAE;YACX,IAAI,EAAE,QAAQ;YACd,OAAO,EAAE,UAAU;YACnB,WAAW,EAAE,mEAAmE;SACjF;QACD,MAAM,EAAE;YACN,IAAI,EAAE,QAAQ;YACd,OAAO,EAAE,EAAE;YACX,WAAW,EACT,uGAAuG;SAC1G;QACD,YAAY,EAAE;YACZ,IAAI,EAAE,QAAQ;YACd,IAAI,EAAE,CAAC,WAAW,EAAE,QAAQ,CAAC;YAC7B,OAAO,EAAE,WAAW;YACpB,WAAW,EAAE,iFAAiF;SAC/F;QACD,eAAe,EAAE;YACf,IAAI,EAAE,SAAS;YACf,OAAO,EAAE,KAAK;YACd,OAAO,EAAE,KAAK;YACd,OAAO,EAAE,KAAK;YACd,WAAW,EAAE,iCAAiC;SAC/C;QACD,KAAK,EAAE;YACL,IAAI,EAAE,SAAS;YACf,OAAO,EAAE,IAAI;YACb,WAAW,EAAE,uBAAuB;SACrC;QACD,YAAY,EAAE;YACZ,IAAI,EAAE,SAAS;YACf,OAAO,EAAE,KAAK;YACd,WAAW,EAAE,iDAAiD;SAC/D;QACD,WAAW,EAAE;YACX,IAAI,EAAE,SAAS;YACf,OAAO,EAAE,CAAC;YACV,OAAO,EAAE,CAAC;YACV,OAAO,EAAE,CAAC;YACV,WAAW,EAAE,6DAA6D;SAC3E;KACF;CACF,CAAC"}
+{"version":3,"file":"fbneo.options.js","sourceRoot":"","sources":["../../src/fbneo.options.ts"],"names":[],"mappings":"AAkFA,2EAA2E;AAC3E,MAAM,CAAC,MAAM,WAAW,GAAG,EAAE,KAAK,EAAE,GAAG,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,EAAE,KAAK,EAAW,CAAC;AAE/E,MAAM,CAAC,MAAM,UAAU,GAA8B;IACnD,MAAM,EAAE;QACN,YAAY,EAAE;YACZ,OAAO,EAAE,WAAW;YACpB,IAAI,EAAE,CAAC,WAAW,EAAE,QAAQ,CAAC;YAC7B,IAAI,EAAE,IAAI;YACV,WAAW,EAAE,4CAA4C;SAC1D;QACD,KAAK,EAAE,EAAE,IAAI,EAAE,KAAK,EAAE,WAAW,EAAE,8CAA8C,EAAE;QACnF,OAAO,EAAE,EAAE,IAAI,EAAE,KAAK,EAAE,WAAW,EAAE,qCAAqC,EAAE;KAC7E;IACD,OAAO,EAAE;QACP,MAAM,EAAE;YACN,OAAO,EAAE,EAAE;YACX,IAAI,EAAE,KAAK;YACX,WAAW,EAAE,iFAAiF;SAC/F;QACD,WAAW,EAAE;YACX,OAAO,EAAE,EAAE;YACX,IAAI,EAAE,KAAK;YACX,WAAW,EAAE,qEAAqE;SACnF;QACD,MAAM,EAAE;YACN,OAAO,EAAE,KAAK;YACd,IAAI,EAAE,CAAC,KAAK,EAAE,KAAK,CAAC;YACpB,IAAI,EAAE,KAAK;YACX,WAAW,EAAE,yFAAyF;SACvG;KACF;IACD,MAAM,EAAE;QACN,GAAG,EAAE;YACH,YAAY,EAAE,CAAC,MAAM,EAAE,KAAK,CAAC;YAC7B,IAAI,EAAE,KAAK;YACX,WAAW,EAAE,gEAAgE;SAC9E;QACD,IAAI,EAAE;YACJ,YAAY,EAAE,CAAC,MAAM,CAAC;YACtB,IAAI,EAAE,KAAK;YACX,WAAW,EAAE,oDAAoD;SAClE;KACF;IACD,OAAO,EAAE;QACP,SAAS,EAAE;YACT,OAAO,EAAE,SAAS;YAClB,IAAI,EAAE,KAAK;YACX,WAAW,EAAE,gGAAgG;SAC9G;QACD,OAAO,EAAE;YACP,IAAI,EAAE,CAAC,MAAM,EAAE,IAAI,CAAC;YACpB,IAAI,EAAE,KAAK;YACX,WAAW,EAAE,2DAA2D;SACzE;KACF;CACF,CAAC"}

package/dist/fbneo/fbneo.sdk.d.ts

@@ -1,10 +1,159 @@
-import type { EngineConfig, EngineInstance } from '@wasm-gaming/engine-specs';
-import { manifest } from './fbneo.manifest.js';
-export { manifest };
-export declare function load(config: EngineConfig): Promise<EngineInstance>;
-declare const _default: {
-    manifest: import("@wasm-gaming/engine-specs").EngineManifest;
-    load: typeof load;
+/**
+ * The engine package's entry point: an `EngineSDK` for FBNeo (FinalBurn Neo), the
+ * arcade emulator.
+ *
+ * ```js
+ * import FbneoSDK from '@wasm-gaming/fbneo-wasm';
+ *
+ * const play = await new FbneoSDK()
+ *   .options({ driver: 'mslug' })                       // or romFileName: 'mslug.zip'
+ *   .assets({ rom: () => readZip(), bios: () => readBios() })
+ *   .storage({ namespace: 'mslug' })                    // → OPFS fbneo/mslug/
+ *   .mount(document.querySelector('#stage'))
+ *   .start();
+ *
+ * play.pause('menu'); play.resume('menu');
+ * await play.restart();                                  // soft reset
+ * await play.destroy();                                  // saves flushed, loop stopped
+ * ```
+ *
+ * Everything a host drives is the contract's (`@wasm-gaming/engine-specs`); what is
+ * this engine's own: {@link FbneoConfig} and friends, owner-aware
+ * {@link FbneoPlay.pause} / {@link FbneoPlay.resume}, {@link FbneoPlay.states},
+ * {@link FbneoPlay.storagePath} and the `saves` event.
+ *
+ * Saves: the build points FBNeo's NVRAM/EEPROM and hiscore paths at MEMFS `/save`.
+ * The SDK seeds it from OPFS `fbneo/<namespace>/` before boot and mirrors it back
+ * after asking FBNeo to write (`web_persist`): every 10 s, on pause, when the page is
+ * hidden and on destroy. Upstream only wrote at exit, which a web page never reaches.
+ */
+import { EnginePlayBase, EngineSDKBase, EventEmitter, type EngineInit, type EngineSDKConstructor, type EventsOf } from '@wasm-gaming/engine-specs';
+import { type FbneoOptions, type FbneoPayloads } from './fbneo.options.js';
+export type { FbneoAsset, FbneoAssets, FbneoConfig, FbneoEvents, FbneoOptions, FbneoPayloads, FbneoStorage, } from './fbneo.options.js';
+export { FBNEO_SPEC, FBNEO_VIDEO } from './fbneo.options.js';
+/**
+ * Where an engine keeps one namespace: `<engineId>/<namespace>`, relative to the OPFS
+ * root. Identical to the other engines': segments cleaned, `.` and `..` dropped,
+ * anything outside `[A-Za-z0-9._-]` → `_`, nothing usable → `default`; a leading
+ * `<engineId>/` is stripped once.
+ */
+export declare function storagePath(engineId: string, namespace: unknown): {
+    namespace: string;
+    path: string;
+    prefixed: boolean;
 };
-export default _default;
+/**
+ * The FBNeo driver for a session: `driver` when given, else the ROM file name's stem
+ * (`mslug.zip`, `C:\roms\mslug.7z` → `mslug`). Empty when neither says.
+ */
+export declare function driverName(options: {
+    driver?: string;
+    romFileName?: string;
+}): string;
+/** The Neo Geo BIOS FBNeo should run, from what the BIOS zip holds (by CRC). */
+export interface NeoGeoBiosChoice {
+    /** `aes`: the real AES BIOS; `unibios`: Universe BIOS 4.0 in its AES mode. */
+    bios: 'aes' | 'unibios';
+    /** The driver's settings to apply: `[group, option]`, as FBNeo names them. */
+    dips: Array<[string, string]>;
+}
+/**
+ * How to boot a Neo Geo as the AES (the home console) with the BIOS zip at hand: the
+ * real AES World BIOS when it is there, else Universe BIOS 4.0 in AES mode, else null.
+ */
+export declare function neoGeoAesBios(entries: Array<{
+    crc: string;
+}>): NeoGeoBiosChoice | null;
+/** The player's save-state slots: 0-3. */
+export declare const STATE_SLOTS = 4;
+/**
+ * The *unsaved* suspend point: written when the player leaves, offered when they come
+ * back, and saved into a numbered slot only when they ask.
+ */
+export declare const AUTO_STATE_SLOT = 9;
+/** One save-state slot. */
+export interface FbneoStateSlot {
+    slot: number;
+    /** When the state was written, or null for an empty slot. */
+    savedAt: Date | null;
+    /** The frame saved with it (PNG), when the host handed one over. */
+    thumbnail: Blob | null;
+    /** Protected: cannot be overwritten or removed until unlocked. */
+    locked: boolean;
+}
+/** Save states: whole-machine snapshots kept in the save folder (and OPFS). */
+export interface FbneoStates {
+    /** The player's slots, 0-3. */
+    list(): FbneoStateSlot[];
+    /** Any slot, {@link AUTO_STATE_SLOT} included. */
+    get(slot: number): FbneoStateSlot;
+    /** Save the running game into `slot` (paused or not). Refuses a locked slot. */
+    save(slot: number, options?: {
+        thumbnail?: Blob | null;
+    }): Promise<void>;
+    /** Load `slot` into the running game; false when it is empty or FBNeo refused it. */
+    load(slot: number): boolean;
+    /** Copy a state (and its frame) into another slot — the unsaved point into a numbered one. */
+    copy(from: number, to: number): Promise<void>;
+    lock(slot: number, locked: boolean): Promise<void>;
+    remove(slot: number): Promise<void>;
+}
+/** The live engine: one booted FBNeo and its session. */
+export declare class FbneoPlay extends EnginePlayBase<FbneoPayloads> {
+    #private;
+    constructor(init?: EngineInit<FbneoPayloads>, events?: EventEmitter<EventsOf<FbneoPayloads>>);
+    /** The normalised namespace this session uses. */
+    get namespace(): string;
+    /** Where this session's saves live, relative to the OPFS root: `fbneo/<namespace>`. */
+    get storagePath(): string;
+    /** The driver (ROM-set short name) this session booted. */
+    get driver(): string;
+    /** How a Neo Geo set was booted as the AES: `{ mode, bios, card }`; null otherwise. */
+    get neogeo(): {
+        mode: 'aes';
+        bios: 'aes' | 'unibios';
+        card: boolean;
+    } | null;
+    /** Who holds the pause, or null while running. */
+    get pausedBy(): string | null;
+    /**
+     * The current frame as a PNG (also while paused: the picture is kept). Null when
+     * there is nothing to read.
+     */
+    snapshot(): Promise<Blob | null>;
+    /** Save states — see {@link FbneoStates}. */
+    get states(): FbneoStates;
+    /**
+     * Freeze emulation and sound. The first caller owns the pause, and only that
+     * owner's {@link resume} lifts it, so an overlay cannot resume a game the host had
+     * already frozen. Saves are flushed, since a paused game is often a closed one.
+     */
+    pause(owner?: string): void;
+    resume(owner?: string): void;
+    /**
+     * Ask FBNeo to write its NVRAM, then copy whatever changed in `/save` to OPFS
+     * `fbneo/<namespace>/`. Emits `saves` with the files that moved. Safe to call any
+     * time; overlapping calls share one flush.
+     */
+    flushSaves(): Promise<void>;
+    protected mounted(target: HTMLElement): void;
+    protected open(_options: FbneoOptions): Promise<void>;
+    protected patched(kind: string, patch: object): void;
+    protected close(): Promise<void>;
+}
+/**
+ * The factory a host constructs: static identity, the configuration chain, and a
+ * `start()` that boots FBNeo and opens a session.
+ */
+export declare class FbneoSDK extends EngineSDKBase<FbneoPayloads> {
+    static readonly id = "fbneo";
+    /** Kept in step with package.json by `node scripts/sync-version.mjs`. */
+    static readonly version = "0.3.0";
+    static readonly name = "FinalBurn Neo";
+    static readonly description = "FBNeo, the arcade emulator (Capcom CPS-1/2/3, SNK Neo Geo, Sega System 16 and more), compiled to WebAssembly. Ships no games: the player provides the ROM sets, and they never leave their browser.";
+    protected createPlay(init: EngineInit<FbneoPayloads>, events: EventEmitter<EventsOf<FbneoPayloads>>): FbneoPlay;
+}
+/** CI's conformance line: if this class stops satisfying the contract, `make test` fails. */
+export declare const FBNEO_ENGINE: EngineSDKConstructor<FbneoPayloads>;
+export default FbneoSDK;
 //# sourceMappingURL=fbneo.sdk.d.ts.map

package/dist/fbneo/fbneo.sdk.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"fbneo.sdk.d.ts","sourceRoot":"","sources":["../../src/fbneo.sdk.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAEV,YAAY,EAEZ,cAAc,EAGf,MAAM,2BAA2B,CAAC;AACnC,OAAO,EAAE,QAAQ,EAAE,MAAM,qBAAqB,CAAC;AAG/C,OAAO,EAAE,QAAQ,EAAE,CAAC;AAyGpB,wBAAsB,IAAI,CAAC,MAAM,EAAE,YAAY,GAAG,OAAO,CAAC,cAAc,CAAC,CAyIxE;;;;;AAED,wBAAkC"}
+{"version":3,"file":"fbneo.sdk.d.ts","sourceRoot":"","sources":["../../src/fbneo.sdk.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4BG;AACH,OAAO,EACL,cAAc,EACd,aAAa,EACb,YAAY,EACZ,KAAK,UAAU,EACf,KAAK,oBAAoB,EACzB,KAAK,QAAQ,EACd,MAAM,2BAA2B,CAAC;AACnC,OAAO,EAKL,KAAK,YAAY,EACjB,KAAK,aAAa,EACnB,MAAM,oBAAoB,CAAC;AAE5B,YAAY,EACV,UAAU,EACV,WAAW,EACX,WAAW,EACX,WAAW,EACX,YAAY,EACZ,aAAa,EACb,YAAY,GACb,MAAM,oBAAoB,CAAC;AAC5B,OAAO,EAAE,UAAU,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAC;AAyC7D;;;;;GAKG;AACH,wBAAgB,WAAW,CACzB,QAAQ,EAAE,MAAM,EAChB,SAAS,EAAE,OAAO,GACjB;IAAE,SAAS,EAAE,MAAM,CAAC;IAAC,IAAI,EAAE,MAAM,CAAC;IAAC,QAAQ,EAAE,OAAO,CAAA;CAAE,CAaxD;AAED;;;GAGG;AACH,wBAAgB,UAAU,CAAC,OAAO,EAAE;IAAE,MAAM,CAAC,EAAE,MAAM,CAAC;IAAC,WAAW,CAAC,EAAE,MAAM,CAAA;CAAE,GAAG,MAAM,CAKrF;AA6BD,gFAAgF;AAChF,MAAM,WAAW,gBAAgB;IAC/B,8EAA8E;IAC9E,IAAI,EAAE,KAAK,GAAG,SAAS,CAAC;IACxB,8EAA8E;IAC9E,IAAI,EAAE,KAAK,CAAC,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC;CAC/B;AAKD;;;GAGG;AACH,wBAAgB,aAAa,CAAC,OAAO,EAAE,KAAK,CAAC;IAAE,GAAG,EAAE,MAAM,CAAA;CAAE,CAAC,GAAG,gBAAgB,GAAG,IAAI,CAOtF;AAED,0CAA0C;AAC1C,eAAO,MAAM,WAAW,IAAI,CAAC;AAC7B;;;GAGG;AACH,eAAO,MAAM,eAAe,IAAI,CAAC;AAEjC,2BAA2B;AAC3B,MAAM,WAAW,cAAc;IAC7B,IAAI,EAAE,MAAM,CAAC;IACb,6DAA6D;IAC7D,OAAO,EAAE,IAAI,GAAG,IAAI,CAAC;IACrB,oEAAoE;IACpE,SAAS,EAAE,IAAI,GAAG,IAAI,CAAC;IACvB,kEAAkE;IAClE,MAAM,EAAE,OAAO,CAAC;CACjB;AAED,+EAA+E;AAC/E,MAAM,WAAW,WAAW;IAC1B,+BAA+B;IAC/B,IAAI,IAAI,cAAc,EAAE,CAAC;IACzB,kDAAkD;IAClD,GAAG,CAAC,IAAI,EAAE,MAAM,GAAG,cAAc,CAAC;IAClC,gFAAgF;IAChF,IAAI,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE;QAAE,SAAS,CAAC,EAAE,IAAI,GAAG,IAAI,CAAA;KAAE,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IACzE,qFAAqF;IACrF,IAAI,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC;IAC5B,8FAA8F;IAC9F,IAAI,CAAC,IAAI,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAC9C,IAAI,CAAC,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IACnD,MAAM,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;CACrC;AAMD,yDAAyD;AACzD,qBAAa,SAAU,SAAQ,cAAc,CAAC,aAAa,CAAC;;gBAuB9C,IAAI,CAAC,EAAE,UAAU,CAAC,aAAa,CAAC,EAAE,MAAM,CAAC,EAAE,YAAY,CAAC,QAAQ,CAAC,aAAa,CAAC,CAAC;IAI5F,kDAAkD;IAClD,IAAI,SAAS,IAAI,MAAM,CAEtB;IAED,uFAAuF;IACvF,IAAI,WAAW,IAAI,MAAM,CAExB;IAED,2DAA2D;IAC3D,IAAI,MAAM,IAAI,MAAM,CAEnB;IAED,uFAAuF;IACvF,IAAI,MAAM,IAAI;QAAE,IAAI,EAAE,KAAK,CAAC;QAAC,IAAI,EAAE,KAAK,GAAG,SAAS,CAAC;QAAC,IAAI,EAAE,OAAO,CAAA;KAAE,GAAG,IAAI,CAE3E;IAED,kDAAkD;IAClD,IAAI,QAAQ,IAAI,MAAM,GAAG,IAAI,CAE5B;IAED;;;OAGG;IACG,QAAQ,IAAI,OAAO,CAAC,IAAI,GAAG,IAAI,CAAC;IAWtC,6CAA6C;IAC7C,IAAI,MAAM,IAAI,WAAW,CAmGxB;IAOD;;;;OAIG;IACH,KAAK,CAAC,KAAK,SAAS,GAAG,IAAI;IAU3B,MAAM,CAAC,KAAK,SAAS,GAAG,IAAI;IAS5B;;;;OAIG;IACH,UAAU,IAAI,OAAO,CAAC,IAAI,CAAC;cASR,OAAO,CAAC,MAAM,EAAE,WAAW,GAAG,IAAI;cAoC5B,IAAI,CAAC,QAAQ,EAAE,YAAY,GAAG,OAAO,CAAC,IAAI,CAAC;cAajD,OAAO,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,IAAI;cAIpC,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC;CAoPhD;AAED;;;GAGG;AACH,qBAAa,QAAS,SAAQ,aAAa,CAAC,aAAa,CAAC;IACxD,MAAM,CAAC,QAAQ,CAAC,EAAE,WAAa;IAC/B,yEAAyE;IACzE,MAAM,CAAC,QAAQ,CAAC,OAAO,WAAW;IAClC,MAAM,CAAC,QAAQ,CAAC,IAAI,mBAAmB;IACvC,MAAM,CAAC,QAAQ,CAAC,WAAW,yMAC6K;cAErL,UAAU,CAC3B,IAAI,EAAE,UAAU,CAAC,aAAa,CAAC,EAC/B,MAAM,EAAE,YAAY,CAAC,QAAQ,CAAC,aAAa,CAAC,CAAC,GAC5C,SAAS;CAGb;AAED,6FAA6F;AAC7F,eAAO,MAAM,YAAY,EAAE,oBAAoB,CAAC,aAAa,CAAY,CAAC;AAE1E,eAAe,QAAQ,CAAC"}