@wasm-gaming/fbneo-wasm 0.2.0 → 0.3.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wasm-gaming/fbneo-wasm",
-  "version": "0.2.0",
+  "version": "0.3.0",
   "description": "FBNeo (FinalBurn Neo arcade emulator) compiled to WebAssembly, with a self-contained JS SDK implementing the wasm-gaming engine contract.",
   "repository": {
     "type": "git",

package/src/app/app.js

@@ -619,7 +619,7 @@ export async function mount(target, host) {
     render();
     play = await new FbneoSDK()
       .mount(stage)
-      .options({ driver })
+      .options({ driver, ...(host.options?.neogeo ? { neogeo: host.options.neogeo } : {}) })
       .assets({ ...host.assets, rom })
       .storage(host.storage)
       .on('error', ({ detail }) => console.error('[fbneo app]', detail))

package/src/fbneo.options.ts

@@ -34,6 +34,12 @@ export interface FbneoOptions {
   driver?: string;
   /** The ROM zip's file name (`mslug.zip`), used for the driver when `driver` is empty. */
   romFileName?: string;
+  /**
+   * 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.
+   */
+  neogeo?: 'mvs' | 'aes';
 }
 
 export interface FbneoAssets {
@@ -99,6 +105,12 @@ export const FBNEO_SPEC: EngineSpec<FbneoPayloads> = {
       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: {

package/src/fbneo.sdk.ts

@@ -54,6 +54,7 @@ export type {
   FbneoStorage,
 } from './fbneo.options.js';
 export { FBNEO_SPEC, FBNEO_VIDEO } from './fbneo.options.js';
+import { parseZipEntries } from './romset.js';
 
 const ENGINE_ID = 'fbneo';
 const DEFAULT_STORAGE_NAMESPACE = 'default';
@@ -86,6 +87,8 @@ interface FbneoModule {
   _web_load_state(slot: number): number;
   _web_running(): number;
   _web_quit(): void;
+  _web_memcard_insert(): number;
+  ccall(name: string, returnType: 'number', argTypes: string[], args: unknown[]): number;
   SDL2?: { audioContext?: AudioContext };
 }
 
@@ -153,6 +156,30 @@ function sameBytes(a: Uint8Array | undefined, b: Uint8Array): boolean {
   return true;
 }
 
+/** 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]>;
+}
+
+const AES_WORLD_CRC = 'd27a71f1'; // neo-epo.bin
+const UNIBIOS_40_CRC = 'a7aab458'; // uni-bios_4_0.rom
+
+/**
+ * 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 function neoGeoAesBios(entries: Array<{ crc: string }>): NeoGeoBiosChoice | null {
+  const crcs = new Set(entries.map((entry) => entry.crc.toLowerCase()));
+  if (crcs.has(AES_WORLD_CRC)) return { bios: 'aes', dips: [['BIOS', 'AES World']] };
+  if (crcs.has(UNIBIOS_40_CRC)) {
+    return { bios: 'unibios', dips: [['BIOS', 'Universe BIOS (Hack, Ver. 4.0)'], ['Unibios mode', 'AES']] };
+  }
+  return null;
+}
+
 /** The player's save-state slots: 0-3. */
 export const STATE_SLOTS = 4;
 /**
@@ -198,6 +225,7 @@ export class FbneoPlay extends EnginePlayBase<FbneoPayloads> {
   #destroyed = false;
   #pauseOwner: string | null = null;
   #driver = '';
+  #neogeo: { mode: 'aes'; bios: 'aes' | 'unibios'; card: boolean } | null = null;
 
   #canvas: HTMLCanvasElement | null = null;
   #ownsCanvas = false;
@@ -234,6 +262,11 @@ export class FbneoPlay extends EnginePlayBase<FbneoPayloads> {
     return this.#driver;
   }
 
+  /** 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 {
+    return this.#neogeo;
+  }
+
   /** Who holds the pause, or null while running. */
   get pausedBy(): string | null {
     return this.#pauseOwner;
@@ -572,6 +605,8 @@ export class FbneoPlay extends EnginePlayBase<FbneoPayloads> {
       );
     }
 
+    if (options.neogeo === 'aes') await this.#bootAes(Module, bios);
+
     if (this.#persist) {
       this.#saveTimer = setInterval(() => void this.flushSaves(), SAVE_INTERVAL_MS);
       document.addEventListener('visibilitychange', this.#onHidden);
@@ -580,6 +615,40 @@ export class FbneoPlay extends EnginePlayBase<FbneoPayloads> {
     this.#fit();
   }
 
+  /**
+   * Neo Geo as the AES: pick the BIOS from the BIOS zip, set the driver's BIOS settings,
+   * insert the game's memory card and reset, so the machine boots that BIOS (FBNeo
+   * loads it at reset). A set that isn't Neo Geo has no "BIOS" setting: left as is.
+   */
+  async #bootAes(Module: FbneoModule, bios: Uint8Array | null): Promise<void> {
+    let choice: NeoGeoBiosChoice | null = null;
+    try {
+      choice = bios ? neoGeoAesBios(parseZipEntries(bios)) : null;
+    } catch {
+      choice = null; // not a zip: no BIOS to choose from
+    }
+    const setDip = (group: string, option: string): boolean =>
+      Module.ccall('web_set_dip', 'number', ['string', 'string'], [group, option]) === 1;
+    if (!choice) {
+      // Only a Neo Geo driver has the setting; anything else plays as it always has.
+      if (!setDip('BIOS', 'AES World')) return;
+      throw new Error(
+        'fbneo: Neo Geo as the AES needs a BIOS zip (neogeo.zip) with the AES BIOS (neo-epo.bin) or Universe BIOS 4.0',
+      );
+    }
+    for (const [group, option] of choice.dips) {
+      if (!setDip(group, option)) {
+        if (group === 'BIOS') return; // not a Neo Geo set
+        throw new Error(`fbneo: this FBNeo build has no "${group}: ${option}" setting`);
+      }
+    }
+    const card = Module._web_memcard_insert() === 1;
+    // The settings reach the driver on the next frame; the BIOS is loaded at reset.
+    await new Promise((resolve) => setTimeout(resolve, 100));
+    Module._web_reset();
+    this.#neogeo = { mode: 'aes', bios: choice.bios, card };
+  }
+
   /** The plain values behind one payload's descriptors. */
   async #values<T>(kind: 'config' | 'options' | 'assets' | 'storage'): Promise<T> {
     const described = (await this[kind]()) as Record<string, { value: unknown }>;
@@ -669,7 +738,7 @@ export class FbneoPlay extends EnginePlayBase<FbneoPayloads> {
 export class FbneoSDK extends EngineSDKBase<FbneoPayloads> {
   static readonly id = ENGINE_ID;
   /** Kept in step with package.json by `node scripts/sync-version.mjs`. */
-  static readonly version = '0.2.0';
+  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.';