game-koi 0.6.0 → 0.7.0

package/README.md

@@ -83,7 +83,9 @@ Games that save — the ones whose cartridge has a battery — keep their saves
 `localStorage` automatically, so a reload or a later visit picks up where the player
 left off. Nothing needs configuring. The save is written about every two seconds while
 the game has unsaved changes, and again on `pause()`, `loadRom()`, `dispose()`, and when
-the tab is hidden or closed.
+the tab is hidden or closed. Each write, and each save restored when a ROM loads, is
+logged with `console.info`, so the browser console shows when a game saved and under
+which key.
 
 A few things worth knowing:
 
@@ -150,6 +152,9 @@ element. Pass `overlayKey: null` to bind no key.
   button edges, from any input path. `on` returns a function that unsubscribes. The
   payload is `{ button, source: "keyboard" | "gamepad" | "api", pressed: Set<Button> }`.
 - `koi.pressed` — everything held right now, as a `Set<Button>` snapshot.
+- `koi.version` — the emulator's version, e.g. `"0.6.0"`. It is also logged once per
+  page (`console.info`) when the wasm module loads. It is read from the wasm binary
+  itself, so a stale cached `.wasm` shows up as a mismatch here.
 - `koi.toggleOverlay()` / `koi.overlayVisible` — the debug stats panel.
 - `koi.pause()` / `koi.resume()`.
 - `koi.dispose()` — stops the loop and tears down the audio graph. Call this before

package/dist/index.d.ts

@@ -111,6 +111,8 @@ export declare class GameKoi {
     importSave(data: Uint8Array): boolean;
     press(button: Button): void;
     release(button: Button): void;
+    /** The version of the emulator core running — the same number logged at startup. */
+    get version(): string;
     /** Everything the joypad has down right now — a snapshot, safe to keep. */
     get pressed(): ReadonlySet<Button>;
     /**

package/dist/index.js

@@ -7,7 +7,7 @@
  * ships as a normal ES module asset next to this file, and the audio worklet is
  * inlined as a Blob URL.
  */
-import init, { Emulator } from "../wasm/game_koi_web.js";
+import init, { Emulator, version as wasmVersion } from "../wasm/game_koi_web.js";
 import { WORKLET_SOURCE } from "./worklet.js";
 import { DEFAULT_GAMEPAD_MAP, GamepadInput } from "./gamepad.js";
 import { Emitter } from "./events.js";
@@ -31,11 +31,16 @@ const DEFAULT_KEYMAP = {
     ShiftRight: "select",
 };
 // The wasm module only needs instantiating once per page, no matter how many
-// `GameKoi` instances are created.
+// `GameKoi` instances are created. The version line is logged here for the same
+// reason: once per page, not once per instance or per `loadRom`.
 let wasmReady = null;
 function ensureWasm() {
-    if (!wasmReady)
-        wasmReady = init();
+    if (!wasmReady) {
+        wasmReady = init().then((wasm) => {
+            console.info(`game-koi ${wasmVersion()}`);
+            return wasm;
+        });
+    }
     return wasmReady;
 }
 /** A running Game Boy, attached to a canvas and driving an AudioWorklet. */
@@ -182,6 +187,10 @@ export class GameKoi {
     release(button) {
         this.setButton(button, false, "api");
     }
+    /** The version of the emulator core running — the same number logged at startup. */
+    get version() {
+        return wasmVersion();
+    }
     /** Everything the joypad has down right now — a snapshot, safe to keep. */
     get pressed() {
         return new Set(this.held);
@@ -388,8 +397,15 @@ export class GameKoi {
         if (!this.emulator.has_save())
             return;
         const data = this.saves.load(this.saveKey);
-        if (data && !this.emulator.load_save(data)) {
-            console.warn(`game-koi: ignoring ${this.saveKey}, it is smaller than this cartridge's RAM`);
+        // No stored save is the normal first run, and not worth a line.
+        if (!data)
+            return;
+        const where = `localStorage["${this.saveKey}"]`;
+        if (this.emulator.load_save(data)) {
+            console.info(`game-koi: restored ${data.length} bytes from ${where}`);
+        }
+        else {
+            console.warn(`game-koi: ignoring ${where}, it is smaller than this cartridge's RAM`);
         }
     }
     /**
@@ -408,6 +424,9 @@ export class GameKoi {
         try {
             this.saves.store(this.saveKey, data);
             this.emulator.mark_saved();
+            // Only reached when the game wrote its save RAM, so this is one line per in-game
+            // save (give or take the ~2 s autosave batching), not one per autosave tick.
+            console.info(`game-koi: saved ${data.length} bytes to localStorage["${this.saveKey}"]`);
         }
         catch (error) {
             console.warn("game-koi: could not store save", error);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "game-koi",
-  "version": "0.6.0",
+  "version": "0.7.0",
   "description": "A Game Boy (DMG) emulator, compiled to WebAssembly, with a drop-in canvas + audio wrapper",
   "type": "module",
   "main": "dist/index.js",

package/wasm/game_koi_web.d.ts

@@ -82,6 +82,15 @@ export class Emulator {
     static width(): number;
 }
 
+/**
+ * The workspace version this module was built from.
+ *
+ * Read from Cargo at compile time rather than from `package.json`, so it names the
+ * binary actually loaded: a stale `.wasm` cached next to a newer JS wrapper reports
+ * its own, older, number instead of the wrapper's.
+ */
+export function version(): string;
+
 export type InitInput = RequestInfo | URL | Response | BufferSource | WebAssembly.Module;
 
 export interface InitOutput {
@@ -101,6 +110,7 @@ export interface InitOutput {
     readonly emulator_save_dirty: (a: number) => number;
     readonly emulator_take_samples: (a: number) => [number, number];
     readonly emulator_width: () => number;
+    readonly version: () => [number, number];
     readonly __wbindgen_externrefs: WebAssembly.Table;
     readonly __wbindgen_malloc: (a: number, b: number) => number;
     readonly __externref_table_dealloc: (a: number) => void;

package/wasm/game_koi_web.js

@@ -169,6 +169,27 @@ export class Emulator {
     }
 }
 if (Symbol.dispose) Emulator.prototype[Symbol.dispose] = Emulator.prototype.free;
+
+/**
+ * The workspace version this module was built from.
+ *
+ * Read from Cargo at compile time rather than from `package.json`, so it names the
+ * binary actually loaded: a stale `.wasm` cached next to a newer JS wrapper reports
+ * its own, older, number instead of the wrapper's.
+ * @returns {string}
+ */
+export function version() {
+    let deferred1_0;
+    let deferred1_1;
+    try {
+        const ret = wasm.version();
+        deferred1_0 = ret[0];
+        deferred1_1 = ret[1];
+        return getStringFromWasm0(ret[0], ret[1]);
+    } finally {
+        wasm.__wbindgen_free(deferred1_0, deferred1_1, 1);
+    }
+}
 function __wbg_get_imports() {
     const import0 = {
         __proto__: null,

package/wasm/game_koi_web_bg.wasm.d.ts

@@ -16,6 +16,7 @@ export const emulator_save_data: (a: number) => [number, number];
 export const emulator_save_dirty: (a: number) => number;
 export const emulator_take_samples: (a: number) => [number, number];
 export const emulator_width: () => number;
+export const version: () => [number, number];
 export const __wbindgen_externrefs: WebAssembly.Table;
 export const __wbindgen_malloc: (a: number, b: number) => number;
 export const __externref_table_dealloc: (a: number) => void;