@wasm-gaming/fbneo-wasm 0.1.1 → 0.1.2

package/README.md

@@ -66,6 +66,11 @@ The dataset ships as `data/romsets/<system>.json` (also served at `/romsets/…`
 from the built `dist/`); `data/romsets/index.json` lists the systems and game
 counts. Regenerate it from a pinned FBNeo checkout with `make romsets`.
 
+Each ROM entry carries its internal name (`n`) and CRC-32 (`c`). `neogeo.json`
+additionally carries each chip's size (`s`) and hardware region (`r`) — the chip
+*layout* — which is what lets the `neo` helper below rebuild a ROM set from a
+flash-cart image.
+
 Because the match is by CRC-32 — and FBNeo itself looks ROM chips up by CRC
 before falling back to their names — a set is usually accepted as downloaded:
 extra files, subdirectories, and non-canonical chip filenames inside the zip do
@@ -78,18 +83,36 @@ FBNeo reads `.zip` and `.7z` ROM sets only. A `.neo` — the single-file format
 NeoSD/Terraonion flash carts, and how most Neo Geo homebrew is distributed — is a
 4 KiB header followed by each ROM region as one contiguous blob (with the sprite
 region byte-interleaved as the cartridge wires it), so it cannot be handed to the
-engine as-is. Convert it to a bootable ROM set first:
+engine as-is. The opt-in `@wasm-gaming/fbneo-wasm/neo` helper rebuilds the chip
+split FBNeo expects, in the browser and with no dependencies:
+
+```js
+import { isNeoFile, neoToRomset } from '@wasm-gaming/fbneo-wasm/neo';
+
+const neogeo = await fetch('/romsets/neogeo.json').then((r) => r.json());
+
+if (isNeoFile(bytes)) {
+  const { driver, zip } = neoToRomset(bytes, neogeo); // throws if it cannot be rebuilt
+  await load({ canvas, assets: { rom: zip }, options: { driver } });
+}
+```
+
+It identifies the driver by matching the `.neo`'s region sizes against the chip
+layouts in `data/romsets/neogeo.json`, rebuilds the individual chip dumps
+(de-interleaving sprites, undoing the `HARDWARE_SNK_SWAPP` program-ROM swap), and
+CRC-32 verifies every chip before returning — so it throws loudly rather than
+handing the engine a broken set. The zip it returns is *stored*, not deflated:
+FBNeo decompresses each chip immediately, so compressing would only be undone.
+
+The same conversion is available offline, which is handy for preparing a set once
+rather than on every page load:
 
 ```sh
-node scripts/neo2romset.mjs mygame.neo --out ./roms
+node scripts/neo2romset.mjs mygame.neo --out ./roms   # needs `make build-lib`
 ```
 
-It identifies the driver by matching the `.neo`'s region sizes against FBNeo's own
-chip tables, rebuilds the individual chip dumps (de-interleaving sprites, undoing
-the `HARDWARE_SNK_SWAPP` program-ROM swap), and CRC-verifies every chip before
-writing `<driver>.zip` — so it fails loudly rather than emitting a broken set. It
-reads the chip tables from a FBNeo checkout (`.tmp/fbneo-build/…` by default, as
-left by `make build-wasm-ci`; override with `--src`).
+Sets whose program ROM lives inside the SMA custom chip cannot be reproduced by a
+straight carve; those fail CRC verification and are reported rather than written.
 
 ### Options
 

package/data/romsets/capcom.json

@@ -816,10 +816,6 @@
           "n": "rt_23.13b",
           "c": "abfca165"
         },
-        {
-          "n": "rt_23.13b",
-          "c": "7d5a77a7"
-        },
         {
           "n": "rt_30.12c",
           "c": "26b211ab"
@@ -2445,10 +2441,6 @@
           "n": "q5_35.11f",
           "c": "abacee26"
         },
-        {
-          "n": "q5_35.11f",
-          "c": "59961612"
-        },
         {
           "n": "q5_41.11h",
           "c": "d3654067"
@@ -12672,10 +12664,6 @@
         {
           "n": "ps-q4.4k",
           "c": "bed42f03"
-        },
-        {
-          "n": "sound.bin",
-          "c": "aeec9dc6"
         }
       ]
     },
@@ -14302,22 +14290,6 @@
           "n": "sh-street-a-sd145.1",
           "c": "a258de13"
         },
-        {
-          "n": "9.u5",
-          "c": "25ae23bc"
-        },
-        {
-          "n": "11.u2",
-          "c": "e5819676"
-        },
-        {
-          "n": "10.u3",
-          "c": "0ad7fb2b"
-        },
-        {
-          "n": "8.u6",
-          "c": "b6b8a84b"
-        },
         {
           "n": "c-se005.bin",
           "c": "c781bf87"
@@ -17510,10 +17482,6 @@
     "sf2rk2": {
       "parent": "sf2",
       "roms": [
-        {
-          "n": "u222.bin",
-          "c": "49422b6f"
-        },
         {
           "n": "u222.bin",
           "c": "10eea0b4"
@@ -17550,18 +17518,10 @@
           "n": "sound.u191",
           "c": "a4823a1b"
         },
-        {
-          "n": "u210.bin",
-          "c": "44d62caa"
-        },
         {
           "n": "u210.bin",
           "c": "6cfffb11"
         },
-        {
-          "n": "u31.bin",
-          "c": "3a85a275"
-        },
         {
           "n": "u31.bin",
           "c": "3e9b4e52"
@@ -21658,10 +21618,6 @@
     "sf2amf6": {
       "parent": "sf2ce",
       "roms": [
-        {
-          "n": "stf2th-5.bin",
-          "c": "3127302c"
-        },
         {
           "n": "stf2th-7.bin",
           "c": "03991fba"
@@ -22408,54 +22364,6 @@
           "n": "tat-12.bin",
           "c": "6ee19b94"
         },
-        {
-          "n": "mask01.bin",
-          "c": "5733d44e"
-        },
-        {
-          "n": "mask05.bin",
-          "c": "42d7635d"
-        },
-        {
-          "n": "mask03.bin",
-          "c": "e24eb699"
-        },
-        {
-          "n": "mask07.bin",
-          "c": "a18ac61a"
-        },
-        {
-          "n": "mask02.bin",
-          "c": "a480eeb7"
-        },
-        {
-          "n": "mask06.bin",
-          "c": "dc03b5c7"
-        },
-        {
-          "n": "mask04.bin",
-          "c": "64c474af"
-        },
-        {
-          "n": "mask08.bin",
-          "c": "f6db1877"
-        },
-        {
-          "n": "mask09.bin",
-          "c": "169d85a6"
-        },
-        {
-          "n": "mask10.bin",
-          "c": "0c638630"
-        },
-        {
-          "n": "mask11.bin",
-          "c": "32a3a841"
-        },
-        {
-          "n": "mask12.bin",
-          "c": "6ee19b94"
-        },
         {
           "n": "2.bin",
           "c": "08f6b60e"
@@ -22565,10 +22473,6 @@
           "n": "s92_09.bin",
           "c": "08f6b60e"
         },
-        {
-          "n": "jyg-5.bin.maybe.bad",
-          "c": "5b98f225"
-        },
         {
           "n": "s92_18.bin",
           "c": "7f162009"
@@ -22577,10 +22481,6 @@
           "n": "s92_19.bin",
           "c": "beade53f"
         },
-        {
-          "n": "jyg-4.bin",
-          "c": "5c9054e3"
-        },
         {
           "n": "29.bin",
           "c": "6de44671"
@@ -22682,10 +22582,6 @@
           "n": "s92_09.bin",
           "c": "08f6b60e"
         },
-        {
-          "n": "jyg-5.bin.maybe.bad",
-          "c": "5b98f225"
-        },
         {
           "n": "s92_18.bin",
           "c": "7f162009"
@@ -22694,10 +22590,6 @@
           "n": "s92_19.bin",
           "c": "beade53f"
         },
-        {
-          "n": "jyg-4.bin",
-          "c": "5c9054e3"
-        },
         {
           "n": "e.bin",
           "c": "6de44671"
@@ -23083,10 +22975,6 @@
           "n": "4.mdta",
           "c": "bd98ff15"
         },
-        {
-          "n": "pf4 sh058.ic89",
-          "c": "40fdf624"
-        },
         {
           "n": "pf4 sh058.ic89",
           "c": "16289710"
@@ -24174,10 +24062,6 @@
     "sf2ceuab2": {
       "parent": "sf2ce",
       "roms": [
-        {
-          "n": "u221.epr",
-          "c": "d8276822"
-        },
         {
           "n": "k4-222",
           "c": "db567b66"
@@ -63160,10 +63044,6 @@
     "vhunt2d": {
       "parent": "vhunt2",
       "roms": [
-        {
-          "n": "vh2j_d.06",
-          "c": "f320ea30"
-        },
         {
           "n": "vh2j_d.03a",
           "c": "696e0157"
@@ -63253,22 +63133,6 @@
     "vsav2d": {
       "parent": "vsav2",
       "roms": [
-        {
-          "n": "vs2j_d.03",
-          "c": "5ee19aee"
-        },
-        {
-          "n": "vs2j_d.04",
-          "c": "80116c47"
-        },
-        {
-          "n": "vs2j_d.05",
-          "c": "dc74a062"
-        },
-        {
-          "n": "vs2j_d.08",
-          "c": "97554918"
-        },
         {
           "n": "vs2j_d.03",
           "c": "50865f7b"
@@ -63447,14 +63311,6 @@
     "xmvsfu1d": {
       "parent": "xmvsf",
       "roms": [
-        {
-          "n": "xvsd.05a",
-          "c": "de347b11"
-        },
-        {
-          "n": "xvsd.07",
-          "c": "f761ded7"
-        },
         {
           "n": "xvsud.03h",
           "c": "4e2e76b7"

package/data/romsets/index.json

@@ -42,7 +42,7 @@
     },
     {
       "system": "megadrive",
-      "games": 2925
+      "games": 2923
     },
     {
       "system": "midway",
@@ -54,11 +54,11 @@
     },
     {
       "system": "neogeo",
-      "games": 687
+      "games": 682
     },
     {
       "system": "nes",
-      "games": 3153
+      "games": 3144
     },
     {
       "system": "pce",
@@ -66,7 +66,7 @@
     },
     {
       "system": "pgm",
-      "games": 200
+      "games": 199
     },
     {
       "system": "pgm2",
@@ -74,7 +74,7 @@
     },
     {
       "system": "pre90s",
-      "games": 2071
+      "games": 2074
     },
     {
       "system": "psikyo",
@@ -86,7 +86,7 @@
     },
     {
       "system": "sega",
-      "games": 665
+      "games": 658
     },
     {
       "system": "sg1000",
@@ -94,7 +94,7 @@
     },
     {
       "system": "sms",
-      "games": 1504
+      "games": 1503
     },
     {
       "system": "snes",

package/data/romsets/konami.json

@@ -19503,10 +19503,6 @@
           "n": "i10.bin",
           "c": "22a3d9d6"
         },
-        {
-          "n": "1.e8",
-          "c": "35a85077"
-        },
         {
           "n": "1.e8",
           "c": "f040c484"
@@ -19607,10 +19603,6 @@
         {
           "n": "064eab04_sr.10e",
           "c": "56bb2e75"
-        },
-        {
-          "n": "064eab05_sr.10g",
-          "c": "0aad4619"
         }
       ]
     },

package/data/romsets/megadrive.json

@@ -26347,24 +26347,6 @@
           "c": "bf9ba3bc"
         }
       ]
-    },
-    "md_spritemask": {
-      "parent": null,
-      "roms": [
-        {
-          "n": "SpriteMaskingTestRom.bin",
-          "c": "6986aa96"
-        }
-      ]
-    },
-    "md_testinstspeed": {
-      "parent": null,
-      "roms": [
-        {
-          "n": "test_inst_speed.bin",
-          "c": "093f3d29"
-        }
-      ]
     }
   }
 }