sci2-ts 0.4.0 → 0.5.0

package/CHANGELOG.md

@@ -4,6 +4,12 @@ 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

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

package/lib/995.sc

@@ -70,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)
@@ -101,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/998.sc

@@ -33,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:))

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

@@ -26,6 +26,17 @@
 
 ;; 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)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "sci2-ts",
-  "version": "0.4.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",