@moonbase-machines/player 0.12.0 → 0.13.0

package/README.md

@@ -36,7 +36,9 @@ No title is named in it. A title is a folder of its own, kept with the title, wh
 - its scenes (`<name>.scene`) and `compiled/` (`moonbase-compile`); `remake/README.md` says what a scene is, how it
   is compiled and run, and the two engines.
 
-Beside it the game's data, `<name>.json` (its disks' files, its kind, and where it saves: `saves`).
+Beside it the game's data, `<name>.json` (its disks' files, its kind, where it saves, `saves`, and its demonstrations,
+`demonstrations`, where its sheet has some: each a name and the steps a person types to see it, which the Original
+types into a Commodore 64 game at a button of that name; `data.js` makes the file and checks every step).
 
 ```html
 <link rel="stylesheet" href="/packages/player/player.css">

package/audio.js

@@ -1,17 +1,25 @@
 // The speaker. The Apple II makes sound by clicking the speaker, a toggle at $C030, and the
 // machine keeps the cycle of each click. `Speaker` turns a run of cycles into a square wave
 // at the sound card's rate and plays it through a worklet, which keeps a queue of what it has
-// been given and holds the last level when the queue runs dry.
+// been given and holds the last level when the queue runs dry. The queue keeps a quarter of a
+// second at most, the oldest dropped: sound made faster than it plays (a machine catching up a
+// hitch, a pause in a hidden tab) would otherwise put the sound behind the picture for good.
 const CYCLES_PER_SECOND = 1020484;
 
 const WORKLET = `
 class SpeakerProcessor extends AudioWorkletProcessor {
-  constructor() { super(); this.queue = []; this.at = 0; this.level = 0; this.port.onmessage = e => this.queue.push(e.data); }
+  constructor() {
+    super(); this.queue = []; this.at = 0; this.level = 0; this.queued = 0;
+    this.port.onmessage = e => {
+      this.queue.push(e.data); this.queued += e.data.length;
+      while (this.queued > sampleRate / 4 && this.queue.length > 1) { this.queued -= this.queue[0].length - this.at; this.queue.shift(); this.at = 0; }
+    };
+  }
   process(inputs, outputs) {
     const out = outputs[0][0];
     for (let i = 0; i < out.length; i++) {
       while (this.queue.length && this.at >= this.queue[0].length) { this.queue.shift(); this.at = 0; }
-      if (this.queue.length) this.level = this.queue[0][this.at++];
+      if (this.queue.length) { this.level = this.queue[0][this.at++]; this.queued--; }
       out[i] = this.level;
     }
     return true;

package/data.js

@@ -4,15 +4,21 @@
 // whole as well, for a machine with Apple's own ROMs, which boots them (`images`, @moonbase-machines/apple2e/disk2.js,
 // blocks.js), the data naming them.
 //
-//   const { data, images } = gameData(slug, { title, kind, disks, system, call, loads, wait, start, saves })
+//   const { data, images } = gameData(slug, { title, kind, disks, system, call, loads, wait, start, saves, demonstrations })
 //     kind      'prodos', 'dos33' or 'c64'
 //     disks     each disk image's bytes, in order (a 140K .dsk, a .2mg; a C64's .d64)
 //     saves     where the game saves, { volume, dos } (@moonbase-machines/apple2e/saves.js), if it does
+//     demonstrations
+//               what the game's own sheet has a person type to see it work, each a name and its steps, typed into the
+//               game by the player's button of that name (play.js): [{ name, steps: [{ key: 'return' }, { key: 'f4' },
+//               { type: '1 PISTONS' }, ...] }] (keys.js `typing` says what a step is); a C64 game's, whose engine types
+//               them (engines/original.js); refused for another kind
 //   data      the game's data, for <slug>.json
 //   images    an Apple game's disks, [{ name: <slug>-<n>.dsk or .2mg, bytes }]
 import { prodos } from '@moonbase-machines/apple2e/prodos-disk.js';
 import { dos33 } from '@moonbase-machines/apple2e/dos33-disk.js';
 import { read as d64 } from '@moonbase-machines/c64/d64.js';
+import { typing } from './keys.js';
 
 const b64 = bytes => Buffer.from(bytes).toString('base64');
 
@@ -35,5 +41,14 @@ export function gameData(slug, game) {
     }
   }
   if (game.saves) data.saves = game.saves;
+  if (game.demonstrations) {
+    if (game.kind !== 'c64') throw new Error(`${slug}: a demonstration is typed into a C64 game only`);
+    if (!Array.isArray(game.demonstrations)) throw new Error(`${slug}: demonstrations is a list`);
+    data.demonstrations = game.demonstrations.map(d => {
+      if (typeof d?.name !== 'string' || !d.name) throw new Error(`${slug}: a demonstration has a name`);
+      typing(d.steps, game.kind);   // (checked here, once, so that the player never meets a step it cannot type)
+      return { name: d.name, steps: d.steps };
+    });
+  }
   return { data, images };
 }