sci2-ts 0.2.2 → 0.4.0

package/CHANGELOG.md

@@ -1,8 +1,29 @@
 # Changelog
 
-All notable changes to this project. The format follows [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
-versions follow [Semantic Versioning](https://semver.org/), and the entries are generated
-from commit messages ([Conventional Commits](https://www.conventionalcommits.org/)).
+All notable changes to this project. Versions follow [Semantic Versioning](https://semver.org/),
+and the entries are generated from commit messages
+([Conventional Commits](https://www.conventionalcommits.org/)) when a release is made.
+
+## [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
+
+* **content:** close-ups from Yarn ([0546752](https://github.com/rlueder/sci-ts/commit/054675216342747bc5565301aff3d39d27a900c2))
+* **lib:** a text style for every box and menu ([0350a4e](https://github.com/rlueder/sci-ts/commit/0350a4e28a57d951277372ff6144bd8e9e534bee))
+* **lib:** an inventory and close-ups ([6d401d8](https://github.com/rlueder/sci-ts/commit/6d401d8f92d33a4b694dcc617adbb1d5878da246))
+* **lib:** cursors a game can replace, and a wait cursor ([aa55d11](https://github.com/rlueder/sci-ts/commit/aa55d1142568aeb4b14681e44881a4223192d5d2))
+* **lib:** portraits at the top left, with blinking eyes ([8fd6aa1](https://github.com/rlueder/sci-ts/commit/8fd6aa16e83f9608666f67fd998ac852be1a5a99))
+* **tools:** fonts from sheets of glyphs drawn in a paint program ([cb13669](https://github.com/rlueder/sci-ts/commit/cb13669363fb419425b0a54f0a5afb9ca1576dcf))
+
+### Maintenance
+
+* release from CI with semantic-release ([1757412](https://github.com/rlueder/sci-ts/commit/17574126c257961dd1058f596c6174445f3d9f16))
 
 ## [0.2.2] - 2026-10-01
 
@@ -74,5 +95,3 @@ from commit messages ([Conventional Commits](https://www.conventionalcommits.org
 
 - Workspace, typecheck, tests and CI
 - Build every game, and publish the site to GitHub Pages by hand
-
-

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/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

@@ -0,0 +1,135 @@
+;;; Things: what the hero carries and the window to choose one from, and close looks at
+;;; things.
+(script 993)
+(include "system.sh")
+
+;; Something the hero can carry. Its view's loop 0 is its icon in the inventory window and
+;; loop 1 the cursor while it's being used (the cel's anchor is the hotspot); both anchored
+;; at the top-left corner. Using it on something sends that thing doVerb: with the item's
+;; own verb, 10 and up, so the room answers with noun and that verb (in Yarn, a node like
+;; filings.lens: the game names its items' verbs in items.yaml).
+(class InvItem of Obj
+  (properties
+    view -1
+    verb 0
+    description 0)  ; what looking at it in the window says
+
+  ;; Looked at in the inventory window.
+  (method (doVerb v)
+    (if (and (== v V_LOOK) description) (narrator say: description))))
+
+;; What the hero carries (the `inventory` global): (inventory add: lens), (inventory
+;; contains: lens). showSelf opens the window: the items in a row, one click picks one to
+;; use (it becomes the cursor), a right-click on one looks at it, a click elsewhere closes.
+(class Inventory of Set
+  (properties
+    window 0
+    icons 0
+    y 24)
+
+  (method (showSelf &tmp node item icon x)
+    (if (not size)
+      (narrator say: "You aren't carrying anything.")
+      (return))
+    (= window
+      ((TextItem new:)
+        text: ""
+        width: (+ (* size (+ INV_ICON INV_GAP)) INV_GAP (* 2 (textStyle margin?)))
+        height: (+ INV_ICON (* 2 INV_GAP) (* 2 (textStyle margin?)))
+        yourself:))
+    (if (!= (textStyle frame?) -1)
+      (window
+        width: (+ (window width?) (CelWide (textStyle frame?) 0 6) (CelWide (textStyle frame?) 0 7))
+        height: (+ (window height?) (CelHigh (textStyle frame?) 0 4) (CelHigh (textStyle frame?) 0 5))))
+    (window x: (/ (- SCREEN_WIDTH (window width?)) 2) y: y init:)
+    (= icons (List new:))
+    (= x (+ (window x?) (window textLeft?) INV_GAP))
+    (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 init:)
+      (icon plane: uiPlane setPri: (+ (window priority?) 1))
+      (icons add: icon)
+      (+= x (+ INV_ICON INV_GAP)))
+    (= dialog self))
+
+  ;; The item whose icon is at (x, y), or 0.
+  (method (itemAt ex ey &tmp icon)
+    (= icon (icons firstTrue: #onMe ex ey))
+    (return (if icon (icon actions?) else 0)))
+
+  (method (handleEvent event &tmp item)
+    (event claimed: TRUE)
+    (if (!= (event type?) EV_MOUSE_DOWN) (return TRUE))
+    (= item (self itemAt: (event x?) (event y?)))
+    (cond
+      ((not item) (self hide:))
+      ((& (event modifiers?) MOD_RIGHT) (item doVerb: V_LOOK))
+      (else
+        (self hide:)
+        (user useItem: item)))
+    (return TRUE))
+
+  (method (hide)
+    (if (== dialog self) (= dialog 0))
+    (if icons
+      (icons eachElementDo: #dispose)
+      (icons dispose:)
+      (= 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)))
+
+;; A close look at something: a view shown in the middle of the screen with the room dimmed
+;; behind it, until a click; then it goes, and whoever asked is cued.
+;;   ((CloseUp new:) show: view [loop [cel [whoCares]]])
+;; Its cels are anchored at their top-left corner. The dimming is the library's view 996,
+;; drawn in remap colour 253 (which the art palette keeps free) at `dim` percent.
+(class CloseUp of Obj
+  (properties
+    shade 0
+    picture 0
+    caller 0
+    dim 50)
+
+  (method (show v l c whoCares &tmp lp cl)
+    (= lp (if (> argc 1) l else 0))
+    (= cl (if (> argc 2) c else 0))
+    (= caller (if (> argc 3) whoCares else 0))
+    (RemapColors REMAP_BY_PERCENT 253 dim)
+    (= shade ((View new:) view: CLOSE_UP_SHADE x: 0 y: 0 yourself:))
+    (shade init:)
+    (shade plane: uiPlane setPri: 10)
+    (= picture
+      ((View new:)
+        view: v loop: lp cel: cl
+        x: (/ (- SCREEN_WIDTH (CelWide v lp cl)) 2)
+        y: (/ (- SCREEN_HEIGHT (CelHigh v lp cl)) 2)
+        yourself:))
+    (picture init:)
+    (picture plane: uiPlane setPri: 20)
+    (= dialog self))
+
+  (method (handleEvent event)
+    (event claimed: TRUE)
+    (if (== (event type?) EV_MOUSE_DOWN)
+      (self close:))
+    (return TRUE))
+
+  (method (dismiss)
+    (self close:))
+
+  (method (close &tmp c)
+    (if (== dialog self) (= dialog 0))
+    (if picture (picture dispose:) (= picture 0))
+    (if shade (shade dispose:) (= shade 0))
+    (RemapColors REMAP_OFF 253)
+    (= c caller)
+    (self dispose:)
+    (if c (c cue:))))

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

@@ -15,22 +15,70 @@
 ;; a click walks the hero there, or does the verb to what's under the cursor: an actor or
 ;; prop, a feature, or else the room. A click while a line is shown dismisses it; while a
 ;; menu is open, it goes to the menu.
+;;
+;; The cursor is a view for each verb, and another while the player can't act (handsOff).
+;; 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
-    canInput TRUE)
+    canInput TRUE
+    lookCursor 991  ; the library's: CURSOR_BASE + verb
+    talkCursor 992
+    walkCursor 993
+    doCursor 994
+    waitCursor 995  ; CURSOR_WAIT
+    cursor -1       ; the view and loop showing now
+    cursorLoop 0)
 
   (method (init)
     (self setVerb: verb))
 
   (method (setVerb v)
     (= verb v)
-    (SetCursor (+ CURSOR_BASE v) 0 0))
+    (self showCursor:))
+
+  ;; Picks an item to use (0: none).
+  (method (useItem item)
+    (= theItem item)
+    (cond
+      (item (self setVerb: V_ITEM))
+      ((== verb V_ITEM) (self setVerb: V_WALK))))
+
+  ;; The cursor for a verb (0: waiting).
+  (method (cursorFor v)
+    (switch v
+      (V_LOOK (return lookCursor))
+      (V_TALK (return talkCursor))
+      (V_WALK (return walkCursor))
+      (V_DO (return doCursor))
+      (else (return waitCursor))))
+
+  (method (showCursor &tmp v l)
+    (= l 0)
+    (cond
+      ((not canInput) (= v waitCursor))
+      ((and (== verb V_ITEM) theItem) (= v (theItem view?)) (= l 1))
+      (else (= v (self cursorFor: verb))))
+    (if (or (!= v cursor) (!= l cursorLoop))
+      (= cursor v)
+      (= cursorLoop l)
+      (SetCursor v l 0)))
 
   (method (doit)
+    (self showCursor:)
     (while (GetEvent EV_ALL theEvent)
       (self handleEvent: theEvent)))
 
+  ;; The verb right-click goes to: walk, do, look, talk, the item picked (if any), walk.
+  (method (nextVerb)
+    (cond
+      ((== verb V_ITEM) (return V_WALK))
+      ((and (== verb V_TALK) theItem) (return V_ITEM))
+      (else (return (+ (mod verb VERB_COUNT) 1)))))
+
   (method (handleEvent event &tmp obj ex ey)
     (event claimed: FALSE)
     ;; A line being shown, then an open menu, get clicks first.
@@ -38,9 +86,20 @@
     (if dialog
       (dialog handleEvent: event)
       (return))
-    (if (or (not canInput) (!= (event type?) EV_MOUSE_DOWN)) (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)
+      (inventory showSelf:)
+      (return))
+    (if (!= (event type?) EV_MOUSE_DOWN) (return))
     (if (& (event modifiers?) MOD_RIGHT)
-      (self setVerb: (+ (mod verb VERB_COUNT) 1))
+      (self setVerb: (self nextVerb:))
       (return))
     (= ex (event x?))
     (= ey (event y?))
@@ -50,4 +109,4 @@
     (= obj (cast firstTrue: #onMe ex ey))
     (if (not obj) (= obj (features firstTrue: #onMe ex ey)))
     (if (not obj) (= obj curRoom))
-    (if obj (obj doVerb: verb))))
+    (if obj (obj doVerb: (if (== verb V_ITEM) (theItem verb?) else verb)))))