sci2-ts 0.3.0 → 0.5.0

package/CHANGELOG.md

@@ -4,6 +4,18 @@ All notable changes to this project. Versions follow [Semantic Versioning](https
 and the entries are generated from commit messages
 ([Conventional Commits](https://www.conventionalcommits.org/)) when a release is made.
 
+## [0.5.0](https://github.com/rlueder/sci-ts/compare/v0.4.0...v0.5.0) (2026-10-01)
+
+### Added
+
+* **lib:** an icon bar for players without a right button ([#3](https://github.com/rlueder/sci-ts/issues/3)) ([a28d5b2](https://github.com/rlueder/sci-ts/commit/a28d5b244417af6985c0c82c825a3af29ad68067))
+
+## [0.4.0](https://github.com/rlueder/sci-ts/compare/v0.3.0...v0.4.0) (2026-10-01)
+
+### Added
+
+* **lib:** saving and restoring ([#2](https://github.com/rlueder/sci-ts/issues/2)) ([117ad9d](https://github.com/rlueder/sci-ts/commit/117ad9ddf4ca87d443d8b7143d66eef380dced9a))
+
 ## [0.3.0](https://github.com/rlueder/sci-ts/compare/v0.2.2...v0.3.0) (2026-10-01)
 
 ### Added

package/apps/viewer/src/session.js

@@ -1,4 +1,4 @@
-import { EventType, ResourceManager, ResourceType, SciKey, SoundDevice, Vm, allKernels, audio, graphics, hostFiles, input, parseAdLibBank, readingTime, restoreGame, saves, snapshot, } from "../../../packages/sci/src/index.js";
+import { EventType, GLOBAL_NAMES_VOCAB, ResourceManager, ResourceType, SciKey, SoundDevice, Vm, allKernels, audio, graphics, hostFiles, input, parseAdLibBank, readingTime, restoreGame, saves, snapshot, } from "../../../packages/sci/src/index.js";
 import { AdLibOutput } from "./adlib.js";
 import { WebAudioOutput } from "./audio.js";
 import { BASE, httpFiles } from "./files.js";
@@ -48,7 +48,7 @@ export class GameSession {
         const vm = new Vm(rm);
         vm.registerKernels(allKernels);
         // Saved games persist in this browser (IndexedDB) and appear in the game's Restore screen.
-        saves(vm).store = await browserSaveStore(options.saveNamespace ?? [...(options.mods ?? [])].sort().join("+"));
+        saves(vm).store = await browserSaveStore(options.saveNamespace ?? defaultSaveNamespace(vm, rm, options.mods ?? []));
         if (options.debug)
             hostFiles(vm).add("18.scr");
         const sound = new WebAudioOutput(httpFiles, (name) => rm.file(name));
@@ -279,6 +279,16 @@ export class GameSession {
         });
     }
 }
+/**
+ * Whose saves these are. Games built by sci-ts (they carry their globals' names, vocab 990)
+ * each get their own, by the game object's name, so games played from one site don't share
+ * save slots; Sierra's games keep the namespace they always had (their mods, if any).
+ */
+function defaultSaveNamespace(vm, rm, mods) {
+    if (rm.has({ type: ResourceType.Vocab, number: GLOBAL_NAMES_VOCAB }))
+        return `game:${vm.object(vm.exportAddress(0, 0)).name}`;
+    return [...mods].sort().join("+");
+}
 const KEY_CODES = {
     Enter: 13, Escape: 27, Backspace: 8, Tab: 9, " ": 32,
     ArrowUp: SciKey.Up, ArrowDown: SciKey.Down, ArrowLeft: SciKey.Left, ArrowRight: SciKey.Right,

package/apps/viewer/src/session.ts

@@ -1,5 +1,5 @@
 import {
-  EventType, ResourceManager, ResourceType, SciKey, SoundDevice, Vm, allKernels, audio, graphics, hostFiles, input, parseAdLibBank, readingTime, restoreGame, saves, snapshot,
+  EventType, GLOBAL_NAMES_VOCAB, ResourceManager, ResourceType, SciKey, SoundDevice, Vm, allKernels, audio, graphics, hostFiles, input, parseAdLibBank, readingTime, restoreGame, saves, snapshot,
   type Frame, type VmSnapshot,
 } from "../../../packages/sci/src/index.ts";
 import { AdLibOutput } from "./adlib.ts";
@@ -76,7 +76,7 @@ export class GameSession {
     const vm = new Vm(rm);
     vm.registerKernels(allKernels);
     // Saved games persist in this browser (IndexedDB) and appear in the game's Restore screen.
-    saves(vm).store = await browserSaveStore(options.saveNamespace ?? [...(options.mods ?? [])].sort().join("+"));
+    saves(vm).store = await browserSaveStore(options.saveNamespace ?? defaultSaveNamespace(vm, rm, options.mods ?? []));
     if (options.debug) hostFiles(vm).add("18.scr");
 
     const sound = new WebAudioOutput(httpFiles, (name) => rm.file(name));
@@ -294,6 +294,16 @@ export class GameSession {
   }
 }
 
+/**
+ * Whose saves these are. Games built by sci-ts (they carry their globals' names, vocab 990)
+ * each get their own, by the game object's name, so games played from one site don't share
+ * save slots; Sierra's games keep the namespace they always had (their mods, if any).
+ */
+function defaultSaveNamespace(vm: Vm, rm: ResourceManager, mods: string[]): string {
+  if (rm.has({ type: ResourceType.Vocab, number: GLOBAL_NAMES_VOCAB })) return `game:${vm.object(vm.exportAddress(0, 0)).name}`;
+  return [...mods].sort().join("+");
+}
+
 const KEY_CODES: Record<string, number> = {
   Enter: 13, Escape: 27, Backspace: 8, Tab: 9, " ": 32,
   ArrowUp: SciKey.Up, ArrowDown: SciKey.Down, ArrowLeft: SciKey.Left, ArrowRight: SciKey.Right,

package/lib/991.sc

@@ -0,0 +1,102 @@
+;;; The icon bar: the verbs, the item, the inventory and the game menu, for players without
+;;; a right mouse button (touch screens, trackpads).
+(script 991)
+(include "system.sh")
+
+;; An icon: a View hit anywhere in its square, not only where it's drawn. Its `actions`
+;; says what it stands for.
+(class Icon of View
+  (properties
+    size ICON_SIZE)
+
+  (method (onMe theX theY)
+    (return (and (>= theX x) (< theX (+ x size)) (>= theY y) (< theY (+ y size))))))
+
+;; Slides down when the pointer reaches the top edge of the screen, or on a tap there. Its
+;; icons are the cels of `view`, loop 0 as they are and loop 1 picked, each ICON_SIZE
+;; square and anchored at the top-left corner: walk, look, do, talk, the inventory, the
+;; game menu (the item in use shows its own icon). A game with its own sets view in its
+;; init: (iconBar view: 266). Picking one, or a click below the bar, closes it.
+(class IconBar of Obj
+  (properties
+    view ICON_BAR_VIEW
+    box 0
+    icons 0
+    height 0)
+
+  (method (show &tmp x)
+    (if box (return))
+    (= box
+      ((TextItem new:)
+        text: ""
+        width: SCREEN_WIDTH
+        height: (+ ICON_SIZE (* 2 ICON_GAP) (* 2 (textStyle margin?)))
+        x: 0 y: 0
+        yourself:))
+    (if (!= (textStyle frame?) -1)
+      (box height: (+ (box height?) (CelHigh (textStyle frame?) 0 4) (CelHigh (textStyle frame?) 0 5))))
+    (box init:)
+    (= height (box height?))
+    (= icons (List new:))
+    (= x (+ (box textLeft?) ICON_GAP))
+    ;; The verbs, then the item, the inventory and the menu.
+    (self addIcon: x 0 V_WALK)
+    (+= x (+ ICON_SIZE ICON_GAP))
+    (self addIcon: x 1 V_LOOK)
+    (+= x (+ ICON_SIZE ICON_GAP))
+    (self addIcon: x 2 V_DO)
+    (+= x (+ ICON_SIZE ICON_GAP))
+    (self addIcon: x 3 V_TALK)
+    (+= x (+ ICON_SIZE ICON_GAP))
+    (self addIcon: x -1 V_ITEM)
+    (+= x (+ ICON_SIZE ICON_GAP))
+    (self addIcon: x 4 ICON_INVENTORY)
+    (+= x (+ ICON_SIZE ICON_GAP))
+    (self addIcon: x 5 ICON_MENU)
+    (= dialog self))
+
+  ;; An icon at x: cel c of the bar's view (-1: the item in use), standing for `what`.
+  (method (addIcon theX c what &tmp icon)
+    (if (and (== c -1) (not theItem)) (return))
+    (= icon
+      ((Icon new:)
+        view: (if (== c -1) (theItem view?) else view)
+        loop: (if (and (!= c -1) (== what (user verb?))) 1 else 0)
+        cel: (if (== c -1) 0 else c)
+        actions: what
+        x: theX
+        y: (+ (box textTop?) ICON_GAP)
+        yourself:))
+    (icon init:)
+    (icon plane: uiPlane setPri: (+ (box priority?) 1))
+    (icons add: icon))
+
+  (method (hide)
+    (if (== dialog self) (= dialog 0))
+    (if icons
+      (icons eachElementDo: #dispose)
+      (icons dispose:)
+      (= icons 0))
+    (if box (box dispose:) (= box 0)))
+
+  (method (dismiss)
+    (self hide:))
+
+  ;; While it's open, the pointer going well below it closes it too.
+  (method (pointerAt theX theY)
+    (if (and box (> theY (+ height ICON_BAR_SLACK))) (self hide:)))
+
+  (method (handleEvent event &tmp icon what)
+    (event claimed: TRUE)
+    (if (!= (event type?) EV_MOUSE_DOWN) (return TRUE))
+    (= icon (icons firstTrue: #onMe (event x?) (event y?)))
+    (if (not icon)
+      (self hide:)
+      (return TRUE))
+    (= what (icon actions?))
+    (self hide:)
+    (switch what
+      (ICON_INVENTORY (inventory showSelf:))
+      (ICON_MENU (game showMenu:))
+      (else (user setVerb: what)))
+    (return TRUE)))

package/lib/992.sc

@@ -0,0 +1,173 @@
+;;; Saving, restoring and restarting: the game menu (Escape), F5 to save and F7 to restore.
+(script 992)
+(include "system.sh")
+
+;; A line to type into, for the interpreter's line editor (EditText): shown over the room
+;; until Enter, Escape or a click outside it, each of which is left for the next event.
+(class EditField of Obj
+  (properties
+    x 0 y 0 z 0
+    view -1 loop 0 cel 0
+    priority 300 fixPriority 1
+    plane 0
+    bitmap 0
+    scaleSignal 0 scaleX 128 scaleY 128
+    text 0
+    font 0
+    fore 0
+    back 255
+    skip 254
+    mode 0
+    borderColor 0
+    nsLeft 0 nsTop 0 nsRight 0 nsBottom 0
+    textLeft 3 textTop 3 textRight 0 textBottom 0
+    width SAVE_DESCRIPTION) ; the most characters
+
+  ;; At (x, y), w pixels wide and one line of text tall.
+  (method (place theX theY w)
+    (= x theX)
+    (= y theY)
+    (= plane uiPlane)
+    (= font (textStyle font?))
+    (= fore (textStyle fore?))
+    (= back (textStyle back?))
+    (= borderColor (if (== (textStyle border?) -1) (textStyle fore?) else (textStyle border?)))
+    (= nsLeft x)
+    (= nsTop y)
+    (= nsRight (+ x w -1))
+    (= nsBottom (+ y (PointSize font) 5))
+    (= textRight (- w 4))
+    (= textBottom (- (- nsBottom nsTop) 3))))
+
+;; What the game menu, F5 and F7 open; (game save:), (game restore:) and (game showMenu:)
+;; open them from a script. A save is a snapshot of the whole game, named with a line the
+;; player types; only saves made by this build of the game are offered.
+(class SaveRestore of Obj
+  (properties
+    mode 0          ; what the open menu is for: SR_MENU, SR_SAVE, SR_RESTORE, or SR_NAME
+    descriptions 0  ; GetSaveFiles: SAVE_DESCRIPTION characters a save, newest first
+    ids 0
+    count 0
+    field 0         ; the description being typed
+    slot 0)         ; the save it goes into
+
+  (method (showMenu &tmp menu)
+    (= mode SR_MENU)
+    (= menu (Menu new:))
+    (menu
+      add: SR_SAVE "Save the game"
+      add: SR_RESTORE "Restore a game"
+      add: SR_RESTART "Start again"
+      add: 0 "Carry on"
+      show: self))
+
+  ;; The saves there are now.
+  (method (load)
+    (self release:)
+    (= descriptions (String ARRAY_NEW 0))
+    (= ids (Array ARRAY_NEW 0 0))
+    (= count (GetSaveFiles "" descriptions ids)))
+
+  (method (release)
+    (if descriptions (String ARRAY_FREE descriptions) (= descriptions 0))
+    (if ids (Array ARRAY_FREE ids) (= ids 0)))
+
+  ;; The description of the i-th save (a new string).
+  (method (description i &tmp s)
+    (= s (String ARRAY_NEW SAVE_DESCRIPTION))
+    (Array ARRAY_COPY s 0 descriptions (* i SAVE_DESCRIPTION) (- SAVE_DESCRIPTION 1))
+    (return s))
+
+  ;; One more than the highest save number.
+  (method (nextSlot &tmp i n id)
+    (= n 0)
+    (for ((= i 0)) (< i count) ((++ i))
+      (= id (Array ARRAY_AT ids i))
+      (if (>= id n) (= n (+ id 1))))
+    (return n))
+
+  ;; Menu values are save numbers plus one (0 is cancel).
+  (method (listSaves menu &tmp i)
+    (for ((= i 0)) (and (< i count) (< i SAVES_SHOWN)) ((++ i))
+      (menu add: (+ (Array ARRAY_AT ids i) 1) (self description: i))))
+
+  (method (save &tmp menu)
+    (game clearText:)
+    (self load:)
+    (= mode SR_SAVE)
+    (= menu ((Menu new:) y: 12 yourself:))
+    (menu add: (+ (self nextSlot:) 1) "A new saved game")
+    (self listSaves: menu)
+    (menu add: 0 "Cancel" show: self))
+
+  (method (restore &tmp menu)
+    (game clearText:)
+    (self load:)
+    (if (not count)
+      (narrator say: "There are no saved games yet.")
+      (return))
+    (= mode SR_RESTORE)
+    (= menu ((Menu new:) y: 12 yourself:))
+    (self listSaves: menu)
+    (menu add: 0 "Cancel" show: self))
+
+  (method (choose v)
+    (switch mode
+      (SR_MENU
+        (switch v
+          (SR_SAVE (self save:))
+          (SR_RESTORE (self restore:))
+          (SR_RESTART (RestartGame))))
+      (SR_SAVE (if v (self askDescription: (- v 1))))
+      (SR_RESTORE
+        (if v
+          ;; Returns only if it couldn't: the game starts again where the save left it.
+          (RestoreGame "" (- v 1) "")
+          (narrator say: "That saved game couldn't be restored.")))))
+
+  ;; Types the description of save n: the old one, or the room's number to start from.
+  (method (askDescription n &tmp i)
+    (= slot n)
+    (= field (EditField new:))
+    (field text: (String ARRAY_NEW SAVE_DESCRIPTION))
+    (for ((= i 0)) (< i count) ((++ i))
+      (if (== (Array ARRAY_AT ids i) n)
+        (Array ARRAY_COPY (field text?) 0 descriptions (* i SAVE_DESCRIPTION) (- SAVE_DESCRIPTION 1))))
+    (if (not (String STRING_LENGTH (field text?)))
+      (String STRING_FORMAT_INTO (field text?) "Room %d" curRoomNum))
+    (field place: 40 80 240)
+    (EditText field)
+    ;; How it ended (Enter, Escape, a click) is the next event: wait for it.
+    (= mode SR_NAME)
+    (= dialog self))
+
+  (method (handleEvent event)
+    (event claimed: TRUE)
+    (if (== mode SR_NAME)
+      (cond
+        ((and (== (event type?) EV_KEY_DOWN) (== (event message?) KEY_ENTER)) (self finishSave:))
+        ((or (== (event type?) EV_KEY_DOWN) (== (event type?) EV_MOUSE_DOWN)) (self endNaming:))))
+    (return TRUE))
+
+  (method (dismiss)
+    (self endNaming:))
+
+  (method (endNaming)
+    (if (== dialog self) (= dialog 0))
+    (= mode 0)
+    (if field
+      (String ARRAY_FREE (field text?))
+      (field dispose:)
+      (= field 0)))
+
+  (method (finishSave &tmp ok)
+    ;; Nothing of this menu goes into the save.
+    (if (== dialog self) (= dialog 0))
+    (= mode 0)
+    (= ok (SaveGame "" slot (field text?) ""))
+    (self endNaming: release:)
+    (narrator say: (if ok "Saved." else "The game couldn't be saved.")))
+
+  (method (dispose)
+    (self release:)
+    (super dispose:)))

package/lib/993.sc

@@ -47,7 +47,7 @@
     (for ((= node (FirstNode elements))) node ((= node (NextNode node)))
       (= item (NodeValue node))
       ;; The icon keeps its item in `actions`.
-      (= icon ((View new:) view: (item view?) loop: 0 cel: 0 actions: item x: x y: (+ (window y?) (window textTop?) INV_GAP) yourself:))
+      (= icon ((Icon new:) view: (item view?) loop: 0 cel: 0 actions: item x: x y: (+ (window y?) (window textTop?) INV_GAP) yourself:))
       (icon init:)
       (icon plane: uiPlane setPri: (+ (window priority?) 1))
       (icons add: icon)
@@ -79,6 +79,9 @@
       (= icons 0))
     (if window (window dispose:) (= window 0)))
 
+  (method (dismiss)
+    (self hide:))
+
   (method (delete item)
     (if (== theItem item) (user useItem: 0))
     (super delete: item &rest)))
@@ -119,6 +122,9 @@
       (self close:))
     (return TRUE))
 
+  (method (dismiss)
+    (self close:))
+
   (method (close &tmp c)
     (if (== dialog self) (= dialog 0))
     (if picture (picture dispose:) (= picture 0))

package/lib/994.sc

@@ -42,6 +42,19 @@
         (= client 0)
         (if c (c cue:)))))
 
+  ;; After a restore nothing is playing: a sound that loops forever starts again; one that
+  ;; was playing once is over (and whoever was waiting for it hears so).
+  (method (replay &tmp c)
+    (if handle
+      (= handle 0)
+      (= nodePtr 0)
+      (if (== loop -1)
+        (self play: client)
+       else
+        (= c client)
+        (= client 0)
+        (if c (c cue:)))))
+
   (method (dispose)
     (DoSound SND_STOP self)
     (DoSound SND_DISPOSE self)

package/lib/995.sc

@@ -20,6 +20,7 @@
 ;; A game with its own sets them in its init: (user walkCursor: 261 waitCursor: 265 ...).
 ;; I or Tab opens the inventory; an item picked there is used like a verb (V_ITEM), with
 ;; its own cursor, until right-click goes back to walking.
+;; Escape opens the game menu (save, restore, start again); F5 saves and F7 restores.
 (class User of Obj
   (properties
     verb V_WALK
@@ -69,7 +70,11 @@
   (method (doit)
     (self showCursor:)
     (while (GetEvent EV_ALL theEvent)
-      (self handleEvent: theEvent)))
+      (self handleEvent: theEvent))
+    ;; theEvent now says where the pointer is: at the top edge, the icon bar comes down.
+    (cond
+      ((== dialog iconBar) (iconBar pointerAt: (theEvent x?) (theEvent y?)))
+      ((and canInput (not dialog) (not talking) (<= (theEvent y?) ICON_BAR_EDGE)) (iconBar show:))))
 
   ;; The verb right-click goes to: walk, do, look, talk, the item picked (if any), walk.
   (method (nextVerb)
@@ -86,6 +91,11 @@
       (dialog handleEvent: event)
       (return))
     (if (not canInput) (return))
+    (if (== (event type?) EV_KEY_DOWN)
+      (switch (event message?)
+        (KEY_ESCAPE (event claimed: TRUE) (game showMenu:) (return))
+        (KEY_F5 (event claimed: TRUE) (game save:) (return))
+        (KEY_F7 (event claimed: TRUE) (game restore:) (return))))
     (if (and (== (event type?) EV_KEY_DOWN)
           (or (== (event message?) KEY_TAB) (== (event message?) KEY_i) (== (event message?) KEY_I)))
       (event claimed: TRUE)
@@ -95,6 +105,11 @@
     (if (& (event modifiers?) MOD_RIGHT)
       (self setVerb: (self nextVerb:))
       (return))
+    ;; A tap at the top edge (touch has no pointer to hover there) opens the icon bar.
+    (if (<= (event y?) (* 3 ICON_BAR_EDGE))
+      (event claimed: TRUE)
+      (iconBar show:)
+      (return))
     (= ex (event x?))
     (= ey (event y?))
     (if (== verb V_WALK)

package/lib/996.sc

@@ -290,6 +290,10 @@
       (c choose: v))
     (return TRUE))
 
+  ;; Closed without a choice.
+  (method (dismiss)
+    (self dispose:))
+
   (method (dispose)
     (if (== dialog self) (= dialog 0))
     (if items

package/lib/998.sc

@@ -20,7 +20,8 @@
 ;; The game: sets everything up, then runs one cycle after another until `quit`.
 (class Game of Obj
   (properties
-    script 0)
+    script 0
+    saver 0)        ; the SaveRestore behind the game menu
 
   (method (init)
     (= game self)
@@ -32,6 +33,7 @@
     (= narrator (Narrator new:))
     (= textStyle (TextStyle new:))
     (= inventory (Inventory new:))
+    (= iconBar (IconBar new:))
     (= music (Sound new:))
     (= sfx (Sound new:))
     (= uiPlane ((Plane new:) priority: 200 picture: -2 yourself:))
@@ -44,6 +46,38 @@
     (while (not quit)
       (self doit:)))
 
+  ;; After a restore (RestoreGame), the interpreter starts the game here, not at play: the
+  ;; game is as it was saved, but nothing is on screen and nothing is playing. Put the
+  ;; planes and the cast back and start looping sounds again, then carry on.
+  (method (replay)
+    (uiPlane init:)
+    (if curRoom ((curRoom plane?) init:))
+    (cast eachElementDo: #replay)
+    (sounds eachElementDo: #replay)
+    (user cursor: -1)
+    (while (not quit)
+      (self doit:)))
+
+  ;; The game menu (Escape): save, restore, start again.
+  (method (showMenu)
+    (self clearText:)
+    ((self saveRestore:) showMenu:))
+
+  (method (save)
+    ((self saveRestore:) save:))
+
+  (method (restore)
+    ((self saveRestore:) restore:))
+
+  (method (saveRestore)
+    (if (not saver) (= saver (SaveRestore new:)))
+    (return saver))
+
+  ;; Takes down a line being shown and whatever is open (a menu, the inventory, a close-up).
+  (method (clearText)
+    (if talking (talking clear:))
+    (if dialog (dialog dismiss:)))
+
   ;; One cycle: scripts, the room, everything on screen, text, drawing, then input.
   (method (doit)
     (++ gameTime)
@@ -59,8 +93,7 @@
   ;; Leaves the current room for room n (its script's export 0).
   (method (newRoom n &tmp old)
     (= newRoomNum 0)
-    (if talking (talking clear:))
-    (if dialog (dialog dispose:))
+    (self clearText:)
     (if curRoom
       (= old curRoomNum)
       (curRoom dispose:)
@@ -239,6 +272,10 @@
   (method (roomDisposed)
     (self dispose:))
 
+  ;; Back on screen after a restore.
+  (method (replay)
+    (if (not (& signal SIG_HIDDEN)) (AddScreenItem self)))
+
   (method (dispose)
     (if (not (& signal SIG_HIDDEN)) (DeleteScreenItem self))
     (cast delete: self)

package/lib/999.sc

@@ -30,7 +30,8 @@
   [gameFlags 64]  ; story flags, a bit each
   textStyle       ; how text boxes and menus look (a TextStyle)
   inventory       ; what the hero carries (an Inventory)
-  theItem)        ; the item picked to use, or 0
+  theItem         ; the item picked to use, or 0
+  iconBar)        ; the icon bar (an IconBar)
 
 (procedure (SetFlag n)
   (|= [gameFlags (/ n 16)] (<< 1 (mod n 16))))

package/lib/resources.js

@@ -106,9 +106,50 @@ function shade() {
     const cel = { width, height, displaceX: width >> 1, displaceY: height - 1, skipColor: Colour.Transparent, pixels: new Uint8Array(width * height).fill(253) };
     return writeView({ flags: 1, loops: [{ link: -1, mirror: false, cels: [cel] }], palette: undefined });
 }
+/**
+ * The icon bar's icons (ICON_BAR_VIEW): walk, look, do, talk, the inventory and the game
+ * menu, each 24 pixels square and anchored at the top-left corner; loop 0 as they are,
+ * loop 1 picked (inverted). The verbs reuse their cursors' drawings.
+ */
+const ICON_BAR_VIEW = 990;
+const ICON = 24;
+const BAG = [
+    "...XXXXX...",
+    "..X.....X..",
+    "..X.....X..",
+    "XXXXXXXXXXX",
+    "XWWWWWWWWWX",
+    "XWWWWWWWWWX",
+    "XWWWXXXWWWX",
+    "XWWWWWWWWWX",
+    "XWWWWWWWWWX",
+    "XXXXXXXXXXX",
+];
+const MENU = ["XXXXXXXXXXX", "", "", "XXXXXXXXXXX", "", "", "XXXXXXXXXXX"].map((r) => r || "...........");
+function iconBar() {
+    const drawings = [CURSORS[3].art, CURSORS[1].art, CURSORS[4].art, CURSORS[2].art, BAG, MENU];
+    const icon = (art, picked) => {
+        const [ink, paper] = picked ? [Colour.White, Colour.Black] : [Colour.Black, Colour.White];
+        const pixels = new Uint8Array(ICON * ICON);
+        for (let y = 0; y < ICON; y++)
+            for (let x = 0; x < ICON; x++)
+                pixels[y * ICON + x] = x === 0 || y === 0 || x === ICON - 1 || y === ICON - 1 ? Colour.Black : paper;
+        const top = (ICON - art.length) >> 1, left = (ICON - art[0].length) >> 1;
+        art.forEach((row, y) => [...row].forEach((c, x) => {
+            if (c === "X")
+                pixels[(top + y) * ICON + left + x] = ink;
+            else if (c === "W")
+                pixels[(top + y) * ICON + left + x] = paper;
+        }));
+        return { width: ICON, height: ICON, displaceX: ICON >> 1, displaceY: ICON - 1, skipColor: Colour.Transparent, pixels };
+    };
+    const loop = (picked) => ({ link: -1, mirror: false, cels: drawings.map((art) => icon(art, picked)) });
+    return writeView({ flags: 1, loops: [loop(false), loop(true)], palette: undefined });
+}
 export default function resources() {
     return [
         ...Object.entries(CURSORS).map(([verb, c]) => ({ type: ResourceType.View, number: CURSOR_BASE + Number(verb), data: cursor(c.art, c.hotspot) })),
         { type: ResourceType.View, number: CLOSE_UP_SHADE, data: shade() },
+        { type: ResourceType.View, number: ICON_BAR_VIEW, data: iconBar() },
     ];
 }

package/lib/resources.ts

@@ -111,9 +111,47 @@ function shade() {
   return writeView({ flags: 1, loops: [{ link: -1, mirror: false, cels: [cel] }], palette: undefined });
 }
 
+/**
+ * The icon bar's icons (ICON_BAR_VIEW): walk, look, do, talk, the inventory and the game
+ * menu, each 24 pixels square and anchored at the top-left corner; loop 0 as they are,
+ * loop 1 picked (inverted). The verbs reuse their cursors' drawings.
+ */
+const ICON_BAR_VIEW = 990;
+const ICON = 24;
+const BAG = [
+  "...XXXXX...",
+  "..X.....X..",
+  "..X.....X..",
+  "XXXXXXXXXXX",
+  "XWWWWWWWWWX",
+  "XWWWWWWWWWX",
+  "XWWWXXXWWWX",
+  "XWWWWWWWWWX",
+  "XWWWWWWWWWX",
+  "XXXXXXXXXXX",
+];
+const MENU = ["XXXXXXXXXXX", "", "", "XXXXXXXXXXX", "", "", "XXXXXXXXXXX"].map((r) => r || "...........");
+function iconBar() {
+  const drawings = [CURSORS[3]!.art, CURSORS[1]!.art, CURSORS[4]!.art, CURSORS[2]!.art, BAG, MENU];
+  const icon = (art: string[], picked: boolean) => {
+    const [ink, paper] = picked ? [Colour.White, Colour.Black] : [Colour.Black, Colour.White];
+    const pixels = new Uint8Array(ICON * ICON);
+    for (let y = 0; y < ICON; y++) for (let x = 0; x < ICON; x++) pixels[y * ICON + x] = x === 0 || y === 0 || x === ICON - 1 || y === ICON - 1 ? Colour.Black : paper;
+    const top = (ICON - art.length) >> 1, left = (ICON - art[0]!.length) >> 1;
+    art.forEach((row, y) => [...row].forEach((c, x) => {
+      if (c === "X") pixels[(top + y) * ICON + left + x] = ink;
+      else if (c === "W") pixels[(top + y) * ICON + left + x] = paper;
+    }));
+    return { width: ICON, height: ICON, displaceX: ICON >> 1, displaceY: ICON - 1, skipColor: Colour.Transparent, pixels };
+  };
+  const loop = (picked: boolean) => ({ link: -1, mirror: false, cels: drawings.map((art) => icon(art, picked)) });
+  return writeView({ flags: 1, loops: [loop(false), loop(true)], palette: undefined });
+}
+
 export default function resources(): ResourceData[] {
   return [
     ...Object.entries(CURSORS).map(([verb, c]) => ({ type: ResourceType.View, number: CURSOR_BASE + Number(verb), data: cursor(c.art, c.hotspot) })),
     { type: ResourceType.View, number: CLOSE_UP_SHADE, data: shade() },
+    { type: ResourceType.View, number: ICON_BAR_VIEW, data: iconBar() },
   ];
 }

package/lib/system.sh

@@ -24,6 +24,27 @@
 (define REMAP_OFF 0)
 (define REMAP_BY_PERCENT 2)
 
+;; Saved games: a description is up to SAVE_DESCRIPTION - 1 characters; the menus show the
+;; newest SAVES_SHOWN. What SaveRestore's open menu is for:
+;; The icon bar: icons are ICON_SIZE pixels square, ICON_GAP apart; it opens when the
+;; pointer is within ICON_BAR_EDGE pixels of the top and closes ICON_BAR_SLACK below it.
+;; Besides verbs, an icon can stand for the inventory or the game menu.
+(define ICON_SIZE 24)
+(define ICON_GAP 4)
+(define ICON_BAR_VIEW 990)
+(define ICON_BAR_EDGE 3)
+(define ICON_BAR_SLACK 12)
+(define ICON_INVENTORY 100)
+(define ICON_MENU 101)
+
+(define SAVE_DESCRIPTION 36)
+(define SAVES_SHOWN 8)
+(define SR_MENU 1)
+(define SR_SAVE 2)
+(define SR_RESTORE 3)
+(define SR_RESTART 4)
+(define SR_NAME 5)
+
 ;; Event types, as GetEvent reports them.
 (define EV_NULL 0)
 (define EV_MOUSE_DOWN 1)
@@ -32,6 +53,10 @@
 
 ;; Keys (an event's message).
 (define KEY_TAB 9)
+(define KEY_ENTER 13)
+(define KEY_ESCAPE 27)
+(define KEY_F5 $3f00)
+(define KEY_F7 $4100)
 (define KEY_I 73)
 (define KEY_i 105)
 (define EV_ALL $7fff)
@@ -53,6 +78,8 @@
 (define ARRAY_AT_PUT 3)
 (define ARRAY_FREE 4)
 (define STRING_LENGTH 10)
+(define STRING_FORMAT_INTO 12)
+(define ARRAY_COPY 6)
 
 ;; Bitmap subfunctions.
 (define BITMAP_DISPOSE 1)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "sci2-ts",
-  "version": "0.3.0",
+  "version": "0.5.0",
   "description": "An SCI2 adventure game engine in TypeScript, and the tools to make games with it",
   "license": "MIT",
   "type": "module",

package/packages/sci/src/vm/kernels/index.d.ts

@@ -3,6 +3,6 @@ export { graphics, Graphics, type Frame, SCREEN_WIDTH, SCREEN_HEIGHT, ShowStyle,
 export { input, Input, EventType, SciKey, hostFiles, type SciEvent } from "./system.ts";
 export { audio, AudioState, readingTime } from "./audio.ts";
 export { paletteEffects, PaletteEffects } from "./palette.ts";
-export { saves, restoreGame, MemorySaveStore, type SaveStore, type SaveInfo } from "./saves.ts";
+export { saves, restoreGame, scriptsFingerprint, MemorySaveStore, type SaveStore, type SaveInfo } from "./saves.ts";
 export declare const allKernels: Record<string, KernelFn>;
 export { stringHelpers } from "./arrays.ts";

package/packages/sci/src/vm/kernels/index.js

@@ -12,7 +12,7 @@ export { graphics, Graphics, SCREEN_WIDTH, SCREEN_HEIGHT, ShowStyle, frameRgb }
 export { input, Input, EventType, SciKey, hostFiles } from "./system.js";
 export { audio, AudioState, readingTime } from "./audio.js";
 export { paletteEffects, PaletteEffects } from "./palette.js";
-export { saves, restoreGame, MemorySaveStore } from "./saves.js";
+export { saves, restoreGame, scriptsFingerprint, MemorySaveStore } from "./saves.js";
 export const allKernels = {
     ...coreKernels,
     ...mathKernels,

package/packages/sci/src/vm/kernels/index.ts

@@ -14,7 +14,7 @@ export { graphics, Graphics, type Frame, SCREEN_WIDTH, SCREEN_HEIGHT, ShowStyle,
 export { input, Input, EventType, SciKey, hostFiles, type SciEvent } from "./system.ts";
 export { audio, AudioState, readingTime } from "./audio.ts";
 export { paletteEffects, PaletteEffects } from "./palette.ts";
-export { saves, restoreGame, MemorySaveStore, type SaveStore, type SaveInfo } from "./saves.ts";
+export { saves, restoreGame, scriptsFingerprint, MemorySaveStore, type SaveStore, type SaveInfo } from "./saves.ts";
 
 export const allKernels: Record<string, KernelFn> = {
   ...coreKernels,

package/packages/sci/src/vm/kernels/saves.d.ts

@@ -5,6 +5,11 @@ export interface SaveInfo {
     description: string;
     version: string;
     date: number;
+    /**
+     * The scripts it was made with (scriptsFingerprint). A save is a snapshot of running
+     * scripts, so it only restores into the same ones; saves from before this was kept have none.
+     */
+    scripts?: string;
 }
 /** Where saves live. Synchronous because kernels are; hosts preload and write through. */
 export interface SaveStore {
@@ -32,7 +37,10 @@ export declare class MemorySaveStore implements SaveStore {
 declare class SaveState {
     store: SaveStore;
     restarting: number;
+    fingerprint: string | undefined;
 }
+/** A hash (FNV-1a) of every script and heap resource: which scripts a save belongs to. */
+export declare function scriptsFingerprint(vm: Vm): string;
 export declare const saves: (vm: Vm) => SaveState;
 /**
  * Loads a saved game the way SSCI's RestoreGame does: host state (planes, screen items,

package/packages/sci/src/vm/kernels/saves.js

@@ -1,3 +1,4 @@
+import { ResourceType } from "../../resource/types.js";
 import { restore, snapshot } from "../savegame.js";
 import { toSigned } from "../value.js";
 import { stringHelpers } from "./arrays.js";
@@ -26,7 +27,25 @@ const DESCRIPTION_SIZE = 36;
 class SaveState {
     store = new MemorySaveStore();
     restarting = Restarting.None;
+    fingerprint;
 }
+/** A hash (FNV-1a) of every script and heap resource: which scripts a save belongs to. */
+export function scriptsFingerprint(vm) {
+    const s = saves(vm);
+    if (s.fingerprint === undefined) {
+        let h = 0x811c9dc5;
+        const resources = vm.resources.list().filter((r) => r.type === ResourceType.Script || r.type === ResourceType.Heap);
+        resources.sort((a, b) => a.type - b.type || a.number - b.number);
+        for (const r of resources) {
+            for (const b of [r.type, r.number & 0xff, r.number >> 8, ...vm.resources.loadSync(r).data])
+                h = Math.imul(h ^ b, 0x01000193) >>> 0;
+        }
+        s.fingerprint = h.toString(16).padStart(8, "0");
+    }
+    return s.fingerprint;
+}
+/** Whether a save can be restored into the scripts running now. */
+const fits = (vm, info) => info.scripts === undefined || info.scripts === scriptsFingerprint(vm);
 const stateOf = new WeakMap();
 export const saves = (vm) => {
     let s = stateOf.get(vm);
@@ -66,6 +85,7 @@ export const saveKernels = {
             description: stringHelpers.str(vm, description),
             version: stringHelpers.str(vm, version),
             date: Date.now(),
+            scripts: scriptsFingerprint(vm),
         };
         saves(vm).store.put(info, snapshot(vm));
         return 1;
@@ -74,7 +94,7 @@ export const saveKernels = {
     // the saved state via `theGame replay`, as in the original interpreter.
     RestoreGame: (vm, [, id = 0]) => {
         const save = saves(vm).store.get(toSigned(id));
-        if (!save)
+        if (!save || !fits(vm, save.info))
             return 0;
         restoreGame(vm, save.snapshot);
         return 1;
@@ -97,7 +117,8 @@ export const saveKernels = {
     // GetSaveFiles(gameName, descriptions, ids): fixed 36-byte description slots and a
     // 0-terminated id list, newest first.
     GetSaveFiles: (vm, [, descriptions = 0, ids = 0]) => {
-        const list = saves(vm).store.list();
+        // Only saves these scripts can restore.
+        const list = saves(vm).store.list().filter((info) => fits(vm, info));
         const desc = stringHelpers.resolve(vm, descriptions);
         const idArray = stringHelpers.resolve(vm, ids);
         if (desc) {
@@ -115,7 +136,7 @@ export const saveKernels = {
     // CheckSaveGame(gameName, id, version): exists and was made by this game version.
     CheckSaveGame: (vm, [, id = 0, version = 0]) => {
         const save = saves(vm).store.get(toSigned(id));
-        return save && save.info.version === stringHelpers.str(vm, version) ? 1 : 0;
+        return save && fits(vm, save.info) && save.info.version === stringHelpers.str(vm, version) ? 1 : 0;
     },
     GetSaveDir: (vm) => stringHelpers.newString(vm, "SAVES"),
     MakeSaveCatName: (vm, [dst = 0]) => stringHelpers.writeString(vm, dst, "QG4CDSG.CAT"),

package/packages/sci/src/vm/kernels/saves.ts

@@ -1,3 +1,4 @@
+import { ResourceType } from "../../resource/types.ts";
 import { restore, snapshot, type VmSnapshot } from "../savegame.ts";
 import type { KernelFn, Vm } from "../vm.ts";
 import { toSigned } from "../value.ts";
@@ -12,6 +13,11 @@ export interface SaveInfo {
   description: string;
   version: string;
   date: number;
+  /**
+   * The scripts it was made with (scriptsFingerprint). A save is a snapshot of running
+   * scripts, so it only restores into the same ones; saves from before this was kept have none.
+   */
+  scripts?: string;
 }
 
 /** Where saves live. Synchronous because kernels are; hosts preload and write through. */
@@ -47,8 +53,27 @@ const DESCRIPTION_SIZE = 36;
 class SaveState {
   store: SaveStore = new MemorySaveStore();
   restarting: number = Restarting.None;
+  fingerprint: string | undefined;
 }
 
+/** A hash (FNV-1a) of every script and heap resource: which scripts a save belongs to. */
+export function scriptsFingerprint(vm: Vm): string {
+  const s = saves(vm);
+  if (s.fingerprint === undefined) {
+    let h = 0x811c9dc5;
+    const resources = vm.resources.list().filter((r) => r.type === ResourceType.Script || r.type === ResourceType.Heap);
+    resources.sort((a, b) => a.type - b.type || a.number - b.number);
+    for (const r of resources) {
+      for (const b of [r.type, r.number & 0xff, r.number >> 8, ...vm.resources.loadSync(r).data]) h = Math.imul(h ^ b, 0x01000193) >>> 0;
+    }
+    s.fingerprint = h.toString(16).padStart(8, "0");
+  }
+  return s.fingerprint;
+}
+
+/** Whether a save can be restored into the scripts running now. */
+const fits = (vm: Vm, info: SaveInfo) => info.scripts === undefined || info.scripts === scriptsFingerprint(vm);
+
 const stateOf = new WeakMap<Vm, SaveState>();
 export const saves = (vm: Vm): SaveState => {
   let s = stateOf.get(vm);
@@ -90,6 +115,7 @@ export const saveKernels: Record<string, KernelFn> = {
       description: stringHelpers.str(vm, description),
       version: stringHelpers.str(vm, version),
       date: Date.now(),
+      scripts: scriptsFingerprint(vm),
     };
     saves(vm).store.put(info, snapshot(vm));
     return 1;
@@ -99,7 +125,7 @@ export const saveKernels: Record<string, KernelFn> = {
   // the saved state via `theGame replay`, as in the original interpreter.
   RestoreGame: (vm, [, id = 0]) => {
     const save = saves(vm).store.get(toSigned(id));
-    if (!save) return 0;
+    if (!save || !fits(vm, save.info)) return 0;
     restoreGame(vm, save.snapshot);
     return 1;
   },
@@ -123,7 +149,8 @@ export const saveKernels: Record<string, KernelFn> = {
   // GetSaveFiles(gameName, descriptions, ids): fixed 36-byte description slots and a
   // 0-terminated id list, newest first.
   GetSaveFiles: (vm, [, descriptions = 0, ids = 0]) => {
-    const list = saves(vm).store.list();
+    // Only saves these scripts can restore.
+    const list = saves(vm).store.list().filter((info) => fits(vm, info));
     const desc = stringHelpers.resolve(vm, descriptions);
     const idArray = stringHelpers.resolve(vm, ids);
     if (desc) {
@@ -140,7 +167,7 @@ export const saveKernels: Record<string, KernelFn> = {
   // CheckSaveGame(gameName, id, version): exists and was made by this game version.
   CheckSaveGame: (vm, [, id = 0, version = 0]) => {
     const save = saves(vm).store.get(toSigned(id));
-    return save && save.info.version === stringHelpers.str(vm, version) ? 1 : 0;
+    return save && fits(vm, save.info) && save.info.version === stringHelpers.str(vm, version) ? 1 : 0;
   },
 
   GetSaveDir: (vm) => stringHelpers.newString(vm, "SAVES"),