sci2-ts 0.0.0-stage → 0.2.2

package/tools/site/markdown.ts

@@ -0,0 +1,84 @@
+/**
+ * Markdown to HTML, for the docs pages of a built site: the parts the docs use (headings,
+ * paragraphs, lists, tables, fenced code, quotes; code, links, images, bold and italic
+ * inline). Links to .md files become links to the .html pages made from them.
+ */
+
+const escape = (s: string) => s.replace(/&/g, "&amp;").replace(/</g, "&lt;").replace(/>/g, "&gt;").replace(/"/g, "&quot;");
+
+export const slug = (text: string) =>
+  text.toLowerCase().replace(/<[^>]+>/g, "").replace(/[^\w\s-]/g, "").trim().replace(/\s+/g, "-");
+
+const pageLink = (href: string) =>
+  /^[a-z]+:/i.test(href) || href.startsWith("#") ? href : href.replace(/(^|\/)README\.md(?=#|$)/, "$1index.md").replace(/\.md(?=#|$)/, ".html");
+
+export function inline(text: string): string {
+  const code: string[] = [];
+  let s = text.replace(/`([^`]+)`/g, (_, c: string) => `\u0000${code.push(`<code>${escape(c)}</code>`) - 1}\u0000`);
+  s = escape(s);
+  s = s.replace(/!\[([^\]]*)\]\(([^)\s]+)\)/g, (_, alt: string, src: string) => `<img src="${src}" alt="${alt}">`);
+  s = s.replace(/\[([^\]]+)\]\(([^)\s]+)\)/g, (_, label: string, href: string) => `<a href="${pageLink(href)}">${label}</a>`);
+  s = s.replace(/\*\*([^*]+)\*\*/g, "<strong>$1</strong>");
+  s = s.replace(/(^|[\s(])\*([^*\s][^*]*)\*/g, "$1<em>$2</em>");
+  return s.replace(/\u0000(\d+)\u0000/g, (_, i: string) => code[Number(i)]!);
+}
+
+export function markdown(source: string): { html: string; title: string } {
+  const lines = source.replace(/\r\n/g, "\n").split("\n");
+  const out: string[] = [];
+  let title = "";
+  let i = 0;
+  const cells = (row: string) => row.trim().replace(/^\||\|$/g, "").split(/(?<!\\)\|/).map((c) => inline(c.trim().replace(/\\\|/g, "|")));
+  while (i < lines.length) {
+    const line = lines[i]!;
+    if (!line.trim()) { i++; continue; }
+    const fence = /^```(\w*)/.exec(line);
+    if (fence) {
+      const body: string[] = [];
+      for (i++; i < lines.length && !lines[i]!.startsWith("```"); i++) body.push(lines[i]!);
+      i++;
+      out.push(`<pre><code${fence[1] ? ` class="language-${fence[1]}"` : ""}>${escape(body.join("\n"))}</code></pre>`);
+      continue;
+    }
+    const heading = /^(#{1,6})\s+(.*)$/.exec(line);
+    if (heading) {
+      const text = inline(heading[2]!);
+      if (!title && heading[1]!.length === 1) title = heading[2]!.replace(/[*`]/g, "");
+      out.push(`<h${heading[1]!.length} id="${slug(text)}">${text}</h${heading[1]!.length}>`);
+      i++;
+      continue;
+    }
+    if (line.startsWith("|") && /^\|?\s*:?-+/.test(lines[i + 1] ?? "")) {
+      const head = cells(line);
+      const rows: string[][] = [];
+      for (i += 2; i < lines.length && lines[i]!.startsWith("|"); i++) rows.push(cells(lines[i]!));
+      out.push(`<table><thead><tr>${head.map((c) => `<th>${c}</th>`).join("")}</tr></thead><tbody>${rows.map((r) => `<tr>${r.map((c) => `<td>${c}</td>`).join("")}</tr>`).join("")}</tbody></table>`);
+      continue;
+    }
+    if (line.startsWith(">")) {
+      const body: string[] = [];
+      for (; i < lines.length && lines[i]!.startsWith(">"); i++) body.push(lines[i]!.replace(/^>\s?/, ""));
+      out.push(`<blockquote>${markdown(body.join("\n")).html}</blockquote>`);
+      continue;
+    }
+    const item = /^(\s*)([-*]|\d+\.)\s+/;
+    if (item.test(line)) {
+      const ordered = /^\s*\d+\./.test(line);
+      const items: string[] = [];
+      for (; i < lines.length; i++) {
+        const l = lines[i]!;
+        if (item.test(l)) items.push(l.replace(item, ""));
+        else if (l.trim() && /^\s{2,}/.test(l) && items.length) items[items.length - 1] += ` ${l.trim()}`;
+        else break;
+      }
+      const tag = ordered ? "ol" : "ul";
+      out.push(`<${tag}>${items.map((t) => `<li>${inline(t)}</li>`).join("")}</${tag}>`);
+      continue;
+    }
+    // A paragraph: lines up to a blank one or the start of another block (always at least one).
+    const para: string[] = [lines[i++]!.trim()];
+    for (; i < lines.length && lines[i]!.trim() && !/^(#{1,6}\s|```|\||>|\s*([-*]|\d+\.)\s)/.test(lines[i]!); i++) para.push(lines[i]!.trim());
+    out.push(`<p>${inline(para.join(" "))}</p>`);
+  }
+  return { html: out.join("\n"), title };
+}

package/tools/view-build.d.ts

@@ -0,0 +1,34 @@
+import { type ResourceManager, type ViewFile } from "../packages/sci/src/index.ts";
+/**
+ * A view described by a JSON manifest next to its PNGs:
+ *
+ *   { "view": 701, "palette": "shared" | { "pic": 701 }, "dither": false,
+ *     "loops": [
+ *       { "cels": [{ "png": "wisp-0.png", "anchor": [8, 15] }, ...] },   // own cels
+ *       { "link": 0, "mirror": true }                                  // loop 0, flipped
+ *     ] }
+ *
+ * `anchor` is the pixel placed at the object's x,y (default: bottom centre). "shared" uses
+ * only the colours every room shares (characters, items); { "pic": n } may also use room
+ * n's own colours (its props). Alpha 64-191 becomes a shadow pixel.
+ */
+export interface ViewManifest {
+    view: number;
+    palette: "shared" | {
+        pic: number;
+    };
+    dither?: boolean;
+    loops: ({
+        cels: {
+            png: string;
+            anchor?: [number, number];
+        }[];
+    } | {
+        link: number;
+        mirror?: boolean;
+    })[];
+}
+export declare function viewFromManifest(path: string, rm: ResourceManager): Promise<{
+    number: number;
+    view: ViewFile;
+}>;

package/tools/view-build.js

@@ -0,0 +1,47 @@
+import { readFileSync } from "node:fs";
+import { dirname, join } from "node:path";
+import { ROOM_COLORS, ResourceType, SHARED_COLORS, hunkToPalette, mapToPalette, mergePalette, parsePicFile, } from "../packages/sci/src/index.js";
+import { basePalette } from "./pic-build.js";
+import { decodePng } from "./png.js";
+const SKIP = 255;
+export async function viewFromManifest(path, rm) {
+    const m = JSON.parse(readFileSync(path, "utf8"));
+    const base = await basePalette(rm);
+    let palette = base, indices = SHARED_COLORS;
+    if (m.palette !== "shared") {
+        const pic = parsePicFile((await rm.load({ type: ResourceType.Pic, number: m.palette.pic })).data);
+        palette = mergePalette(base, hunkToPalette(pic.palette));
+        indices = ROOM_COLORS;
+    }
+    const loops = m.loops.map((l) => {
+        if ("link" in l)
+            return { link: l.link, mirror: !!l.mirror, cels: [] };
+        return {
+            link: -1,
+            mirror: false,
+            cels: l.cels.map((c) => {
+                const img = decodePng(readFileSync(join(dirname(path), c.png)));
+                const [ax, ay] = c.anchor ?? [img.width >> 1, img.height - 1];
+                return {
+                    width: img.width, height: img.height,
+                    displaceX: (img.width >> 1) - ax, displaceY: img.height - 1 - ay,
+                    skipColor: SKIP,
+                    pixels: mapToPalette(img.data, img.width, img.height, palette, indices, SKIP, !!m.dither),
+                };
+            }),
+        };
+    });
+    // The view carries the entries it may use, with the same colours as the rooms have them.
+    const used = [...indices, 253, 254].sort((a, b) => a - b);
+    const first = used[0], last = used.at(-1);
+    const hunk = {
+        header: Uint8Array.from([14, 0, 0, 0, 0, 0, 0, 0, 0, 0, 1, 0, 0]),
+        entryPrefix: Uint8Array.from([0, 255, 255, 255, 255, 255, 255, 255, 0, 0]),
+        first,
+        used: Array.from({ length: last - first + 1 }, (_, i) => (used.includes(first + i) ? 1 : 0)),
+        rgb: Array.from({ length: last - first + 1 }, (_, i) => [palette.rgb[(first + i) * 3], palette.rgb[(first + i) * 3 + 1], palette.rgb[(first + i) * 3 + 2]]),
+        shared: false,
+        defaultUsed: 1,
+    };
+    return { number: m.view, view: { flags: 1, loops, palette: hunk } };
+}

package/tools/view-build.ts

@@ -0,0 +1,71 @@
+import { readFileSync } from "node:fs";
+import { dirname, join } from "node:path";
+import {
+  ROOM_COLORS, ResourceType, SHARED_COLORS, hunkToPalette, mapToPalette, mergePalette, parsePicFile, type HunkPaletteFile,
+  type ResourceManager, type ViewFile, type ViewLoop,
+} from "../packages/sci/src/index.ts";
+import { basePalette } from "./pic-build.ts";
+import { decodePng } from "./png.ts";
+
+/**
+ * A view described by a JSON manifest next to its PNGs:
+ *
+ *   { "view": 701, "palette": "shared" | { "pic": 701 }, "dither": false,
+ *     "loops": [
+ *       { "cels": [{ "png": "wisp-0.png", "anchor": [8, 15] }, ...] },   // own cels
+ *       { "link": 0, "mirror": true }                                  // loop 0, flipped
+ *     ] }
+ *
+ * `anchor` is the pixel placed at the object's x,y (default: bottom centre). "shared" uses
+ * only the colours every room shares (characters, items); { "pic": n } may also use room
+ * n's own colours (its props). Alpha 64-191 becomes a shadow pixel.
+ */
+export interface ViewManifest {
+  view: number;
+  palette: "shared" | { pic: number };
+  dither?: boolean;
+  loops: ({ cels: { png: string; anchor?: [number, number] }[] } | { link: number; mirror?: boolean })[];
+}
+
+const SKIP = 255;
+
+export async function viewFromManifest(path: string, rm: ResourceManager): Promise<{ number: number; view: ViewFile }> {
+  const m = JSON.parse(readFileSync(path, "utf8")) as ViewManifest;
+  const base = await basePalette(rm);
+  let palette = base, indices = SHARED_COLORS;
+  if (m.palette !== "shared") {
+    const pic = parsePicFile((await rm.load({ type: ResourceType.Pic, number: m.palette.pic })).data);
+    palette = mergePalette(base, hunkToPalette(pic.palette));
+    indices = ROOM_COLORS;
+  }
+  const loops: ViewLoop[] = m.loops.map((l) => {
+    if ("link" in l) return { link: l.link, mirror: !!l.mirror, cels: [] };
+    return {
+      link: -1,
+      mirror: false,
+      cels: l.cels.map((c) => {
+        const img = decodePng(readFileSync(join(dirname(path), c.png)));
+        const [ax, ay] = c.anchor ?? [img.width >> 1, img.height - 1];
+        return {
+          width: img.width, height: img.height,
+          displaceX: (img.width >> 1) - ax, displaceY: img.height - 1 - ay,
+          skipColor: SKIP,
+          pixels: mapToPalette(img.data, img.width, img.height, palette, indices, SKIP, !!m.dither),
+        };
+      }),
+    };
+  });
+  // The view carries the entries it may use, with the same colours as the rooms have them.
+  const used = [...indices, 253, 254].sort((a, b) => a - b);
+  const first = used[0]!, last = used.at(-1)!;
+  const hunk: HunkPaletteFile = {
+    header: Uint8Array.from([14, 0, 0, 0, 0, 0, 0, 0, 0, 0, 1, 0, 0]),
+    entryPrefix: Uint8Array.from([0, 255, 255, 255, 255, 255, 255, 255, 0, 0]),
+    first,
+    used: Array.from({ length: last - first + 1 }, (_, i) => (used.includes(first + i) ? 1 : 0)),
+    rgb: Array.from({ length: last - first + 1 }, (_, i) => [palette.rgb[(first + i) * 3]!, palette.rgb[(first + i) * 3 + 1]!, palette.rgb[(first + i) * 3 + 2]!]),
+    shared: false,
+    defaultUsed: 1,
+  };
+  return { number: m.view, view: { flags: 1, loops, palette: hunk } };
+}

package/tools/view.d.ts

@@ -0,0 +1 @@
+export {};

package/tools/view.js

@@ -0,0 +1,54 @@
+/**
+ * Views (sprites and animations).
+ *   pnpm view export <n> [dir]          loop<L>-cel<C>.png + view.json (a manifest you can edit)
+ *   pnpm view import <view.json> [dir]  build the view → <n>.V56
+ *   pnpm view roundtrip                 parse + write every view, compare bytes
+ */
+import { mkdirSync, writeFileSync } from "node:fs";
+import { join } from "node:path";
+import { ResourceManager, ResourceType, celToRgba, hunkToPalette, mergePalette, parseViewFile, writeView } from "../packages/sci/src/index.js";
+import { nodeFiles } from "./node-files.js";
+import { writePatch } from "./patches.js";
+import { basePalette } from "./pic-build.js";
+import { rgbaPng } from "./png.js";
+import { viewFromManifest } from "./view-build.js";
+const [command = "roundtrip", ...args] = process.argv.slice(2);
+const rm = await ResourceManager.open(nodeFiles(process.env.SCI_GAME ?? "original"));
+if (command === "export") {
+    const n = Number(args[0]);
+    const dir = args[1] ?? `out/views/${n}`;
+    mkdirSync(dir, { recursive: true });
+    const view = parseViewFile((await rm.load({ type: ResourceType.View, number: n })).data);
+    const palette = mergePalette(await basePalette(rm), view.palette ? hunkToPalette(view.palette) : undefined);
+    const manifest = { view: n, palette: "shared", loops: [] };
+    view.loops.forEach((loop, l) => {
+        if (loop.link !== -1)
+            return manifest.loops.push({ link: loop.link, mirror: loop.mirror });
+        manifest.loops.push({
+            cels: loop.cels.map((cel, c) => {
+                const png = `loop${l}-cel${c}.png`;
+                // Shadows (remap 254) come out half-transparent black, the way import reads them.
+                const rgba = new Uint8Array(celToRgba(cel, palette, { remap: new Map([[253, 128], [254, 128]]) }).buffer);
+                writeFileSync(join(dir, png), rgbaPng({ width: cel.width, height: cel.height, data: rgba }));
+                return { png, anchor: [(cel.width >> 1) - cel.displaceX, cel.height - 1 - cel.displaceY] };
+            }),
+        });
+    });
+    writeFileSync(join(dir, "view.json"), `${JSON.stringify(manifest, null, 1)}\n`);
+    console.log(`view ${n}: ${view.loops.length} loops → ${dir}`);
+}
+else if (command === "import") {
+    const { number, view } = await viewFromManifest(args[0], rm);
+    writePatch(args[1] ?? "out/views", ResourceType.View, number, writeView(view));
+}
+else {
+    const list = rm.list(ResourceType.View);
+    const bad = [];
+    for (const info of list) {
+        const d = Buffer.from((await rm.load(info)).data);
+        if (d.compare(Buffer.from(writeView(parseViewFile(d)))))
+            bad.push(info.number);
+    }
+    console.log(`${list.length - bad.length}/${list.length} views round-trip byte-exact${bad.length ? `; differ: ${bad.join(" ")}` : ""}`);
+    process.exitCode = bad.length ? 1 : 0;
+}

package/tools/view.ts

@@ -0,0 +1,52 @@
+/**
+ * Views (sprites and animations).
+ *   pnpm view export <n> [dir]          loop<L>-cel<C>.png + view.json (a manifest you can edit)
+ *   pnpm view import <view.json> [dir]  build the view → <n>.V56
+ *   pnpm view roundtrip                 parse + write every view, compare bytes
+ */
+import { mkdirSync, writeFileSync } from "node:fs";
+import { join } from "node:path";
+import { ResourceManager, ResourceType, celToRgba, hunkToPalette, mergePalette, parseViewFile, writeView } from "../packages/sci/src/index.ts";
+import { nodeFiles } from "./node-files.ts";
+import { writePatch } from "./patches.ts";
+import { basePalette } from "./pic-build.ts";
+import { rgbaPng } from "./png.ts";
+import { viewFromManifest, type ViewManifest } from "./view-build.ts";
+
+const [command = "roundtrip", ...args] = process.argv.slice(2);
+const rm = await ResourceManager.open(nodeFiles(process.env.SCI_GAME ?? "original"));
+
+if (command === "export") {
+  const n = Number(args[0]);
+  const dir = args[1] ?? `out/views/${n}`;
+  mkdirSync(dir, { recursive: true });
+  const view = parseViewFile((await rm.load({ type: ResourceType.View, number: n })).data);
+  const palette = mergePalette(await basePalette(rm), view.palette ? hunkToPalette(view.palette) : undefined);
+  const manifest: ViewManifest = { view: n, palette: "shared", loops: [] };
+  view.loops.forEach((loop, l) => {
+    if (loop.link !== -1) return manifest.loops.push({ link: loop.link, mirror: loop.mirror });
+    manifest.loops.push({
+      cels: loop.cels.map((cel, c) => {
+        const png = `loop${l}-cel${c}.png`;
+        // Shadows (remap 254) come out half-transparent black, the way import reads them.
+        const rgba = new Uint8Array(celToRgba(cel, palette, { remap: new Map([[253, 128], [254, 128]]) }).buffer);
+        writeFileSync(join(dir, png), rgbaPng({ width: cel.width, height: cel.height, data: rgba }));
+        return { png, anchor: [(cel.width >> 1) - cel.displaceX, cel.height - 1 - cel.displaceY] as [number, number] };
+      }),
+    });
+  });
+  writeFileSync(join(dir, "view.json"), `${JSON.stringify(manifest, null, 1)}\n`);
+  console.log(`view ${n}: ${view.loops.length} loops → ${dir}`);
+} else if (command === "import") {
+  const { number, view } = await viewFromManifest(args[0]!, rm);
+  writePatch(args[1] ?? "out/views", ResourceType.View, number, writeView(view));
+} else {
+  const list = rm.list(ResourceType.View);
+  const bad: number[] = [];
+  for (const info of list) {
+    const d = Buffer.from((await rm.load(info)).data);
+    if (d.compare(Buffer.from(writeView(parseViewFile(d))))) bad.push(info.number);
+  }
+  console.log(`${list.length - bad.length}/${list.length} views round-trip byte-exact${bad.length ? `; differ: ${bad.join(" ")}` : ""}`);
+  process.exitCode = bad.length ? 1 : 0;
+}