sci2-ts 0.0.0-stage → 0.2.2

package/lib/system.sh

@@ -0,0 +1,62 @@
+;;; Constants for the sci-ts class library and the games that use it:
+;;; (include "system.sh")
+
+;; Verbs: what a click does. Right-click goes to the next one.
+(enum 1
+  V_LOOK
+  V_TALK
+  V_WALK
+  V_DO)
+(define VERB_COUNT 4)
+
+;; Cursors: one view per verb, CURSOR_BASE + verb.
+(define CURSOR_BASE 990)
+
+;; Event types, as GetEvent reports them.
+(define EV_NULL 0)
+(define EV_MOUSE_DOWN 1)
+(define EV_MOUSE_UP 2)
+(define EV_KEY_DOWN 4)
+(define EV_ALL $7fff)
+;; The right button arrives as a click with shift held.
+(define MOD_RIGHT 3)
+
+;; Polygon types: how a polygon limits walking.
+(define PT_TOTAL_ACCESS 0)          ; can't go in, can walk out
+(define PT_NEAREST 1)               ; a click inside goes to its edge
+(define PT_BARRED 2)                ; never
+(define PT_CONTAINED 3)             ; the walkable area: can't leave it
+
+;; What AvoidPath ends a path with.
+(define PATH_END $7777)
+
+;; Array and String kernel calls.
+(define ARRAY_NEW 0)
+(define ARRAY_AT 2)
+(define ARRAY_AT_PUT 3)
+(define ARRAY_FREE 4)
+(define STRING_LENGTH 10)
+
+;; DoSound kernel calls.
+(define SND_INIT 6)
+(define SND_DISPOSE 7)
+(define SND_PLAY 8)
+(define SND_STOP 9)
+(define SND_UPDATE_CUES 17)
+
+(define SCREEN_WIDTH 320)
+(define SCREEN_HEIGHT 200)
+
+;; Who says a message line (its talker number).
+(define TALKER_HERO 98)             ; the game's heroTalker, if it has one
+(define TALKER_NARRATOR 99)
+(define ROOM_TALKERS 200)           ; and up: the room's own characters (its findTalker:)
+
+;; View signal bits.
+(define SIG_HIDDEN $0008)
+(define SIG_FIXED_LOOP $0800)
+;; scaleSignal: scale the cel by scaleX and scaleY.
+(define SCALE_ON 1)
+
+;; Story flags: SetFlag, ClearFlag and IsFlag (script 999's exports 0 to 2) take 0 to 1023.
+(define FLAG_COUNT 1024)

package/package.json

@@ -1,6 +1,77 @@
 {
   "name": "sci2-ts",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+  "version": "0.2.2",
+  "description": "An SCI2 adventure game engine in TypeScript, and the tools to make games with it",
+  "license": "MIT",
+  "type": "module",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/rlueder/sci-ts.git"
+  },
+  "homepage": "https://github.com/rlueder/sci-ts#readme",
+  "keywords": [
+    "sci",
+    "sierra",
+    "adventure",
+    "game-engine",
+    "point-and-click",
+    "interpreter"
+  ],
+  "engines": {
+    "node": ">=22.18"
+  },
+  "bin": {
+    "sci-ts": "bin/sci-ts.mjs"
+  },
+  "exports": {
+    ".": {
+      "types": "./packages/sci/src/index.d.ts",
+      "default": "./packages/sci/src/index.js"
+    },
+    "./content": {
+      "types": "./packages/content/src/index.d.ts",
+      "default": "./packages/content/src/index.js"
+    },
+    "./kit": {
+      "types": "./tools/game/kit.d.ts",
+      "default": "./tools/game/kit.js"
+    },
+    "./build": {
+      "types": "./tools/game/build.d.ts",
+      "default": "./tools/game/build.js"
+    },
+    "./art": {
+      "types": "./tools/art/build.d.ts",
+      "default": "./tools/art/build.js"
+    },
+    "./png": {
+      "types": "./tools/png.d.ts",
+      "default": "./tools/png.js"
+    },
+    "./viewer": {
+      "types": "./apps/viewer/src/session.d.ts",
+      "default": "./apps/viewer/src/session.ts"
+    },
+    "./vite": {
+      "types": "./apps/viewer/plugin.d.ts",
+      "default": "./apps/viewer/plugin.js"
+    },
+    "./package.json": "./package.json"
+  },
+  "dependencies": {
+    "tsx": "^4.23.15",
+    "vite": "^8.3.1",
+    "yaml": "^2.9.1",
+    "@codemirror/commands": "^6.11.1",
+    "@codemirror/lang-yaml": "^6.1.3",
+    "@codemirror/language": "^6.12.4",
+    "@codemirror/lint": "^6.9.7",
+    "@codemirror/state": "^6.7.6",
+    "@codemirror/theme-one-dark": "^6.1.3",
+    "@codemirror/view": "^6.43.13",
+    "codemirror": "^6.0.2",
+    "cytoscape": "^3.34.3",
+    "spessasynth_lib": "^4.3.14",
+    "sirv": "^3.0.2"
+  }
+}

package/packages/content/room.schema.json

@@ -0,0 +1,267 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "room.schema.json",
+  "title": "Room",
+  "description": "A room for @sci-ts/content: what's in it. What's said in it lives in the matching .yarn file (nodes named <thing>.<verb>).",
+  "type": "object",
+  "required": [
+    "room"
+  ],
+  "additionalProperties": false,
+  "$defs": {
+    "point": {
+      "type": "array",
+      "items": {
+        "type": "integer"
+      },
+      "minItems": 2,
+      "maxItems": 2,
+      "description": "[x, y] in room coordinates"
+    },
+    "rect": {
+      "type": "array",
+      "items": {
+        "type": "integer"
+      },
+      "minItems": 4,
+      "maxItems": 4,
+      "description": "[left, top, right, bottom] in room coordinates"
+    },
+    "polygon": {
+      "type": "array",
+      "items": {
+        "$ref": "#/$defs/point"
+      },
+      "minItems": 3
+    },
+    "name": {
+      "type": "string",
+      "pattern": "^[A-Za-z][A-Za-z0-9]*$"
+    },
+    "feature": {
+      "type": "object",
+      "required": [
+        "rect"
+      ],
+      "properties": {
+        "rect": {
+          "$ref": "#/$defs/rect"
+        },
+        "at": {
+          "$ref": "#/$defs/point",
+          "description": "Where the hero looks at (default: the middle of rect)"
+        },
+        "approach": {
+          "$ref": "#/$defs/point",
+          "description": "Where the hero walks to before interacting"
+        },
+        "sightAngle": {
+          "type": "integer",
+          "minimum": 0,
+          "maximum": 360,
+          "default": 180
+        }
+      }
+    }
+  },
+  "properties": {
+    "room": {
+      "type": "integer",
+      "minimum": 0,
+      "maximum": 65535,
+      "description": "Room (script and message) number"
+    },
+    "picture": {
+      "type": "integer",
+      "minimum": 0,
+      "maximum": 65535,
+      "description": "Picture number (default: the room number)"
+    },
+    "music": {
+      "type": "integer",
+      "minimum": 0,
+      "maximum": 65535,
+      "description": "Music played (looping) here; left alone if it's already playing"
+    },
+    "hero": {
+      "type": "object",
+      "additionalProperties": false,
+      "properties": {
+        "at": {
+          "$ref": "#/$defs/point",
+          "description": "Where the hero appears"
+        },
+        "enterTo": {
+          "$ref": "#/$defs/point",
+          "description": "Walk here on arrival; room.enter is narrated after"
+        },
+        "scale": {
+          "type": "object",
+          "additionalProperties": false,
+          "required": [
+            "front",
+            "back",
+            "frontY",
+            "backY"
+          ],
+          "description": "Perspective: front% at y frontY, back% at y backY",
+          "properties": {
+            "front": {
+              "type": "integer"
+            },
+            "back": {
+              "type": "integer"
+            },
+            "frontY": {
+              "type": "integer"
+            },
+            "backY": {
+              "type": "integer"
+            }
+          }
+        }
+      }
+    },
+    "walkable": {
+      "$ref": "#/$defs/polygon",
+      "description": "The floor: the hero stays inside"
+    },
+    "obstacles": {
+      "type": "array",
+      "items": {
+        "$ref": "#/$defs/polygon"
+      },
+      "description": "Polygons the hero walks around"
+    },
+    "features": {
+      "type": "object",
+      "description": "Things to look at and use, drawn in the picture",
+      "propertyNames": {
+        "$ref": "#/$defs/name"
+      },
+      "additionalProperties": {
+        "allOf": [
+          {
+            "$ref": "#/$defs/feature"
+          }
+        ],
+        "unevaluatedProperties": false
+      }
+    },
+    "exits": {
+      "type": "object",
+      "description": "Features that lead to another room when used (Do)",
+      "propertyNames": {
+        "$ref": "#/$defs/name"
+      },
+      "additionalProperties": {
+        "allOf": [
+          {
+            "$ref": "#/$defs/feature"
+          }
+        ],
+        "required": [
+          "to"
+        ],
+        "properties": {
+          "to": {
+            "type": "integer",
+            "description": "The room to go to"
+          },
+          "walkTo": {
+            "$ref": "#/$defs/point",
+            "description": "Walk here before leaving"
+          }
+        },
+        "unevaluatedProperties": false
+      }
+    },
+    "props": {
+      "type": "object",
+      "description": "Things drawn with a view (sprite), optionally animated",
+      "propertyNames": {
+        "$ref": "#/$defs/name"
+      },
+      "additionalProperties": {
+        "type": "object",
+        "required": [
+          "view",
+          "at"
+        ],
+        "additionalProperties": false,
+        "properties": {
+          "view": {
+            "type": "integer",
+            "description": "View number (e.g. from a .view.json)"
+          },
+          "at": {
+            "$ref": "#/$defs/point"
+          },
+          "loop": {
+            "type": "integer",
+            "minimum": 0,
+            "default": 0
+          },
+          "cel": {
+            "type": "integer",
+            "minimum": 0,
+            "default": 0
+          },
+          "cycle": {
+            "enum": [
+              "forward"
+            ],
+            "description": "forward: loop the animation forever"
+          },
+          "sightAngle": {
+            "type": "integer",
+            "minimum": 0,
+            "maximum": 360,
+            "default": 180
+          },
+          "moves": {
+            "type": "boolean",
+            "description": "It walks or floats about in cutscenes (<<walk name x y>>): an Actor instead of a Prop"
+          }
+        }
+      }
+    },
+    "characters": {
+      "type": "object",
+      "description": "Who speaks in this room's Yarn besides Narrator and Hero (`Wisp: ...`)",
+      "propertyNames": {
+        "$ref": "#/$defs/name"
+      },
+      "additionalProperties": {
+        "type": [
+          "object",
+          "null"
+        ],
+        "additionalProperties": false,
+        "properties": {
+          "name": {
+            "type": "string",
+            "maxLength": 40,
+            "description": "Another name they go by in Yarn (besides the key)"
+          },
+          "portrait": {
+            "type": "integer",
+            "minimum": 0,
+            "maximum": 65535,
+            "description": "Portrait view: loop 0 bust, loop 1 mouth shapes, loop 2 eyes; same-size cels anchored at [0, 0]. Without one: a plain text box"
+          }
+        }
+      }
+    },
+    "properties": {
+      "type": "object",
+      "description": "Raw property values per object (the room is \"room\"), for anything not covered above",
+      "additionalProperties": {
+        "type": "object",
+        "additionalProperties": {
+          "type": "integer"
+        }
+      }
+    }
+  }
+}

package/packages/content/src/index.d.ts

@@ -0,0 +1,3 @@
+export * from "./target.ts";
+export * from "./yarn.ts";
+export * from "./room.ts";

package/packages/content/src/index.js

@@ -0,0 +1,3 @@
+export * from "./target.js";
+export * from "./yarn.js";
+export * from "./room.js";

package/packages/content/src/index.ts

@@ -0,0 +1,3 @@
+export * from "./target.ts";
+export * from "./yarn.ts";
+export * from "./room.ts";

package/packages/content/src/room.d.ts

@@ -0,0 +1,111 @@
+import type { Target } from "./target.ts";
+/**
+ * A room described as data (YAML) plus what's said in it (Yarn), compiled to SCI assembly
+ * (.sca) and message text (.msg), the formats tools/mod-build.ts already builds from.
+ *
+ *   room: 701
+ *   hero: { at: [36, 152], enterTo: [110, 160], scale: { front: 100, back: 70, frontY: 186, backY: 122 } }
+ *   walkable: [[28, 152], [60, 135], ...]
+ *   features:
+ *     pods: { rect: [236, 14, 310, 94] }
+ *   exits:
+ *     passage: { rect: [12, 84, 64, 156], approach: [40, 152], walkTo: [30, 152], to: 770 }
+ *   props:
+ *     wisp: { view: 701, at: [200, 96], cycle: forward }
+ *
+ * Yarn nodes named `<thing>.<verb>` are what the hero gets for that verb on that thing
+ * (`pods.look`, `wisp.do`, `room.look`); `room.enter` is narration on arrival. Lines can
+ * name a speaker (`Wisp: ...`, `Hero: ...`): characters are declared under `characters:`.
+ * A node with choices (`-> Who are you?`) is a conversation: the game's topic menu, each
+ * choice answered by the lines indented under it.
+ */
+export interface RoomSpec {
+    room: number;
+    picture?: number;
+    /** Music played (looping) here; left alone if it's already playing. */
+    music?: number;
+    hero?: {
+        at?: Point;
+        /** Walk here on arrival (hands off until there). */
+        enterTo?: Point;
+        /** Perspective: `front`% at y `frontY`, `back`% at y `backY`. */
+        scale?: {
+            front: number;
+            back: number;
+            frontY: number;
+            backY: number;
+        };
+    };
+    /** The floor: a polygon the hero stays inside. */
+    walkable?: Point[];
+    /** Polygons the hero walks around. */
+    obstacles?: Point[][];
+    features?: Record<string, FeatureSpec>;
+    exits?: Record<string, ExitSpec>;
+    props?: Record<string, PropSpec>;
+    /** Who speaks in this room's Yarn (besides the narrator and the hero). */
+    characters?: Record<string, CharacterSpec>;
+    /** Raw property values per object (the room is `room`), for anything not covered above. */
+    properties?: Record<string, Record<string, number>>;
+}
+interface CharacterSpec {
+    /** Their name in Yarn (`Old Crow: ...`), besides the key. */
+    name?: string;
+    /**
+     * Portrait view: loop 0 the bust, loop 1 mouth shapes (cel 0 closed), loop 2 eyes
+     * (cel 0 open, then blinking); every cel the same size. Without one, a plain text box.
+     */
+    portrait?: number;
+}
+type Point = [number, number];
+type Rect = [number, number, number, number];
+interface FeatureSpec {
+    /** left, top, right, bottom (room coordinates). */
+    rect: Rect;
+    /** Where the hero looks at; the middle of rect unless given. */
+    at?: Point;
+    approach?: Point;
+    sightAngle?: number;
+}
+interface ExitSpec extends FeatureSpec {
+    to: number;
+    /** Walk here before leaving. */
+    walkTo?: Point;
+}
+interface PropSpec {
+    view: number;
+    at: Point;
+    /** It walks or floats about in cutscenes (<<walk wisp x y>>): an Actor, not a Prop. */
+    moves?: boolean;
+    loop?: number;
+    cel?: number;
+    /** forward: loop the animation forever. */
+    cycle?: "forward";
+    sightAngle?: number;
+}
+export interface CompiledRoom {
+    number: number;
+    /** SCI assembly for tools/asm.ts. */
+    sca: string;
+    /** Message text for tools/msg.ts. */
+    msg: string;
+    /** The room defines characters: the game needs the target's support for room talkers. */
+    roomTalkers: boolean;
+    /** Yarn variables ($name) used: each is a flag, numbered by `options.flag`. */
+    flags: string[];
+}
+export interface CompileOptions {
+    /**
+     * The flag number for a Yarn variable. Variables are flags shared by a whole mod (and
+     * its saved games), so the caller keeps the numbering (tools/mod-build.ts: flags.yaml).
+     */
+    flag?: (name: string) => number;
+}
+export declare class ContentError extends Error {
+}
+/** Compiles `<n>.room.yaml` (+ `<n>.yarn`) source text. File names only label errors. */
+export declare function compileRoom(yamlSource: string, yarnSource: string | undefined, target: Target, files?: {
+    yaml?: string;
+    yarn?: string;
+}, options?: CompileOptions): CompiledRoom;
+export {};