@moood/render 0.0.0 → 0.1.2

package/index.js

@@ -1,70 +1,70 @@
-// A moood scene rendered here, with moood's own engine (engine/: the site's web/scene, its version in
-// engine/engine.json) in a Chromium already installed (playwright-core: nothing is downloaded) — no
-// network, no site. Time is a virtual clock, stepped from the scene's start: a frame at a moment is
-// the same every time, with the same state.
-//   render({spec, modules, device, at, state, bare, chromium, date}) → [{at, png, errors}]
-//     spec — the scene (readScene(folder) from a world's repository, or any spec);
-//     modules — the modules it lists, themselves: {name: {code, data}} (readModules(world, spec));
-//     device — the frame: 16:9 (1600×900), 4:3, 21:9 (the same height), tile (640×360), big (1920×1080);
-//     at — the moments, seconds from the scene's start (default [0]): a frame each;
-//     state — values over the spec's starting state ({"dawn": 1, "girl": "gone"});
-//     bare — without the title and the captions over it;
-//     chromium — the browser's executable (else MOOOD_CHROMIUM, else Playwright's own);
-//     date — what the clock says at the start (default 2026-01-01T12:00:00Z).
-import { readFileSync } from 'node:fs';
-import { fileURLToPath, pathToFileURL } from 'node:url';
-import { chromium as browserType } from 'playwright-core';
-
-export { readModules, readScene } from './scene.js';
-
-const PAGE = pathToFileURL(fileURLToPath(new URL('./engine/render.html', import.meta.url))).href;
-export const ENGINE = JSON.parse(readFileSync(new URL('./engine/engine.json', import.meta.url), 'utf8')).engine;
-export const DEVICES = { '16:9': [1600, 900], '4:3': [1200, 900], '21:9': [2100, 900], tile: [640, 360], big: [1920, 1080] };
-const STEP = 100;  // ms: timers fire as they come due, not all at the end of one jump
-
-export async function render({ spec, modules = {}, device = '16:9', at = [0], state = {}, bare = false, chromium, date } = {}) {
-  const size = DEVICES[device];
-  if (!size) throw new Error(`device: one of ${Object.keys(DEVICES).join(', ')}`);
-  if (!spec || typeof spec !== 'object') throw new Error('spec: a scene expected');
-  const shown = { ...spec, state: { ...(spec.state && typeof spec.state === 'object' ? spec.state : {}), ...state } };
-  const browser = await browserType.launch({
-    executablePath: chromium || process.env.MOOOD_CHROMIUM || undefined,
-    // WebGL on SwiftShader; 2D canvases on the CPU's Skia (SwiftShader takes minutes for many blended fills)
-    args: ['--use-angle=swiftshader', '--enable-unsafe-swiftshader', '--ignore-gpu-blocklist', '--disable-accelerated-2d-canvas',
-           '--allow-file-access-from-files'],
-  });
-  try {
-    const page = await (await browser.newContext({ viewport: { width: size[0], height: size[1] } })).newPage();
-    const errors = [];
-    page.on('pageerror', e => errors.push(String(e.message)));
-    // the clock stands still: only the frames' moments move it (install alone lets it run as time does)
-    const start = new Date(date || '2026-01-01T12:00:00Z').getTime();
-    await page.clock.install({ time: start });
-    await page.clock.pauseAt(start + 1);
-    await page.addInitScript(([s, m]) => {
-      window.__mooodSpec = s; window.__mooodModules = m;
-      // chance, the same every time (the engine's grain, rain, sparks): the same moment, the same frame
-      let seed = 1;
-      Math.random = () => { seed = (seed + 0x6d2b79f5) | 0; let t = Math.imul(seed ^ (seed >>> 15), 1 | seed); t = (t + Math.imul(t ^ (t >>> 7), 61 | t)) ^ t; return ((t ^ (t >>> 14)) >>> 0) / 4294967296; };
-    }, [shown, modules]);
-    await page.goto(bare ? `${PAGE}?bare` : PAGE);
-    // what loads by itself (fonts, the scene's modules) has loaded before the clock moves at all
-    await page.evaluate(() => document.fonts.ready);
-    await page.waitForTimeout(1000);
-    const frames = [];
-    let now = 0;
-    for (const t of [...at].map(Number).sort((a, b) => a - b)) {
-      while (now < t * 1000) {
-        const step = Math.min(STEP, t * 1000 - now);
-        await page.clock.runFor(step);
-        now += step;
-      }
-      await page.clock.runFor(0);
-      const said = await page.evaluate(() => window.__mooodErrors || []);
-      frames.push({ at: t, png: await page.screenshot({ type: 'png' }), errors: [...new Set([...errors, ...said])].slice(0, 100) });
-    }
-    return frames;
-  } finally {
-    await browser.close();
-  }
-}
+// A moood scene rendered here, with moood's own engine (engine/: the site's web/scene, its version in
+// engine/engine.json) in a Chromium already installed (playwright-core: nothing is downloaded) — no
+// network, no site. Time is a virtual clock, stepped from the scene's start: a frame at a moment is
+// the same every time, with the same state.
+//   render({spec, modules, device, at, state, bare, chromium, date}) → [{at, png, errors}]
+//     spec — the scene (readScene(folder) from a world's repository, or any spec);
+//     modules — the modules it lists, themselves: {name: {code, data}} (readModules(world, spec));
+//     device — the frame: 16:9 (1600×900), 4:3, 21:9 (the same height), tile (640×360), big (1920×1080);
+//     at — the moments, seconds from the scene's start (default [0]): a frame each;
+//     state — values over the spec's starting state ({"dawn": 1, "girl": "gone"});
+//     bare — without the title and the captions over it;
+//     chromium — the browser's executable (else MOOOD_CHROMIUM, else Playwright's own);
+//     date — what the clock says at the start (default 2026-01-01T12:00:00Z).
+import { readFileSync } from 'node:fs';
+import { fileURLToPath, pathToFileURL } from 'node:url';
+import { chromium as browserType } from 'playwright-core';
+
+export { readModules, readScene } from './scene.js';
+
+const PAGE = pathToFileURL(fileURLToPath(new URL('./engine/render.html', import.meta.url))).href;
+export const ENGINE = JSON.parse(readFileSync(new URL('./engine/engine.json', import.meta.url), 'utf8')).engine;
+export const DEVICES = { '16:9': [1600, 900], '4:3': [1200, 900], '21:9': [2100, 900], tile: [640, 360], big: [1920, 1080] };
+const STEP = 100;  // ms: timers fire as they come due, not all at the end of one jump
+
+export async function render({ spec, modules = {}, device = '16:9', at = [0], state = {}, bare = false, chromium, date } = {}) {
+  const size = DEVICES[device];
+  if (!size) throw new Error(`device: one of ${Object.keys(DEVICES).join(', ')}`);
+  if (!spec || typeof spec !== 'object') throw new Error('spec: a scene expected');
+  const shown = { ...spec, state: { ...(spec.state && typeof spec.state === 'object' ? spec.state : {}), ...state } };
+  const browser = await browserType.launch({
+    executablePath: chromium || process.env.MOOOD_CHROMIUM || undefined,
+    // WebGL on SwiftShader; 2D canvases on the CPU's Skia (SwiftShader takes minutes for many blended fills)
+    args: ['--use-angle=swiftshader', '--enable-unsafe-swiftshader', '--ignore-gpu-blocklist', '--disable-accelerated-2d-canvas',
+           '--allow-file-access-from-files'],
+  });
+  try {
+    const page = await (await browser.newContext({ viewport: { width: size[0], height: size[1] } })).newPage();
+    const errors = [];
+    page.on('pageerror', e => errors.push(String(e.message)));
+    // the clock stands still: only the frames' moments move it (install alone lets it run as time does)
+    const start = new Date(date || '2026-01-01T12:00:00Z').getTime();
+    await page.clock.install({ time: start });
+    await page.clock.pauseAt(start + 1);
+    await page.addInitScript(([s, m]) => {
+      window.__mooodSpec = s; window.__mooodModules = m;
+      // chance, the same every time (the engine's grain, rain, sparks): the same moment, the same frame
+      let seed = 1;
+      Math.random = () => { seed = (seed + 0x6d2b79f5) | 0; let t = Math.imul(seed ^ (seed >>> 15), 1 | seed); t = (t + Math.imul(t ^ (t >>> 7), 61 | t)) ^ t; return ((t ^ (t >>> 14)) >>> 0) / 4294967296; };
+    }, [shown, modules]);
+    await page.goto(bare ? `${PAGE}?bare` : PAGE);
+    // what loads by itself (fonts, the scene's modules) has loaded before the clock moves at all
+    await page.evaluate(() => document.fonts.ready);
+    await page.waitForTimeout(1000);
+    const frames = [];
+    let now = 0;
+    for (const t of [...at].map(Number).sort((a, b) => a - b)) {
+      while (now < t * 1000) {
+        const step = Math.min(STEP, t * 1000 - now);
+        await page.clock.runFor(step);
+        now += step;
+      }
+      await page.clock.runFor(0);
+      const said = await page.evaluate(() => window.__mooodErrors || []);
+      frames.push({ at: t, png: await page.screenshot({ type: 'png' }), errors: [...new Set([...errors, ...said])].slice(0, 100) });
+    }
+    return frames;
+  } finally {
+    await browser.close();
+  }
+}

package/package.json

@@ -1,13 +1,27 @@
-{
-  "name": "@moood/render",
-  "version": "0.0.0",
-  "description": "A moood scene rendered locally — the site's own engine, in a browser already installed — at a moment, with a state: a PNG and the errors its code threw.",
-  "license": "UNLICENSED",
-  "type": "module",
-  "main": "index.js",
-  "bin": { "moood-render": "cli.js" },
-  "files": ["index.js", "cli.js", "scene.js", "engine/", "README.md"],
-  "engines": { "node": ">=20" },
-  "dependencies": { "playwright-core": "^1.56.0" },
-  "scripts": { "build": "node build.js" }
-}
+{
+  "name": "@moood/render",
+  "version": "0.1.2",
+  "description": "A moood scene rendered locally — the site's own engine, in a browser already installed — at a moment, with a state: a PNG and the errors its code threw.",
+  "license": "UNLICENSED",
+  "type": "module",
+  "main": "index.js",
+  "bin": {
+    "moood-render": "cli.js"
+  },
+  "files": [
+    "index.js",
+    "cli.js",
+    "scene.js",
+    "engine/",
+    "README.md"
+  ],
+  "engines": {
+    "node": ">=20"
+  },
+  "dependencies": {
+    "playwright-core": "^1.56.0"
+  },
+  "scripts": {
+    "build": "node build.js"
+  }
+}

package/scene.js

@@ -1,43 +1,43 @@
-// A scene as it lies in its world's repository, put together as moood does it (the scenes service's
-// layout.py): scenes/<folder>/scene.json and its code beside it — elements/<id>.js (objects[].code),
-// elements/<id>.script.js (objects[].script), script.js, lib.js, notes.md, widgets/<id>.html — and
-// the modules it lists (modules/<name>.js, .data.json, in the world's repository).
-import { existsSync, readFileSync, readdirSync, statSync } from 'node:fs';
-import { join, relative, sep } from 'node:path';
-
-const TOP = { script: 'script.js', lib: 'lib.js', notes: 'notes.md' };
-const IN = { objects: { code: 'elements/{id}.js', script: 'elements/{id}.script.js' }, widgets: { html: 'widgets/{id}.html' } };
-
-const walk = dir => readdirSync(dir).flatMap(f => (statSync(join(dir, f)).isDirectory() ? walk(join(dir, f)) : [join(dir, f)]));
-
-// the spec a scene's folder makes (an error says what is wrong with it)
-export function readScene(folder) {
-  const files = Object.fromEntries(walk(folder).map(p => [relative(folder, p).split(sep).join('/'), readFileSync(p, 'utf8')]));
-  if (!('scene.json' in files)) throw new Error(`${folder}: no scene.json`);
-  const spec = JSON.parse(files['scene.json']);
-  const used = new Set(['scene.json']);
-  for (const [key, name] of Object.entries(TOP)) if (name in files) { spec[key] = files[name].replace(/\n+$/, ''); used.add(name); }
-  for (const [key, fields] of Object.entries(IN)) {
-    for (const item of spec[key] || []) {
-      if (!item || typeof item !== 'object' || !item.id) continue;
-      for (const [field, path] of Object.entries(fields)) {
-        const name = path.replace('{id}', item.id);
-        if (name in files) { item[field] = files[name].replace(/\n+$/, ''); used.add(name); }
-      }
-    }
-  }
-  const extra = Object.keys(files).filter(f => !used.has(f));
-  if (extra.length) throw new Error(`files no element or widget of scene.json names: ${extra.join(', ')}`);
-  return spec;
-}
-
-// the modules a scene lists, from its world's repository: {name: {code, data}}
-export function readModules(world, spec) {
-  const out = {};
-  for (const name of [...new Set((spec.modules || []).filter(n => typeof n === 'string'))].sort()) {
-    const code = join(world, 'modules', `${name}.js`), data = join(world, 'modules', `${name}.data.json`);
-    if (!existsSync(code)) throw new Error(`the scene lists modules/${name}.js, and there is none`);
-    out[name] = { code: readFileSync(code, 'utf8'), data: existsSync(data) ? JSON.parse(readFileSync(data, 'utf8')) : null };
-  }
-  return out;
-}
+// A scene as it lies in its world's repository, put together as moood does it (the scenes service's
+// layout.py): scenes/<folder>/scene.json and its code beside it — elements/<id>.js (objects[].code),
+// elements/<id>.script.js (objects[].script), script.js, lib.js, notes.md, widgets/<id>.html — and
+// the modules it lists (modules/<name>.js, .data.json, in the world's repository).
+import { existsSync, readFileSync, readdirSync, statSync } from 'node:fs';
+import { join, relative, sep } from 'node:path';
+
+const TOP = { script: 'script.js', lib: 'lib.js', notes: 'notes.md' };
+const IN = { objects: { code: 'elements/{id}.js', script: 'elements/{id}.script.js' }, widgets: { html: 'widgets/{id}.html' } };
+
+const walk = dir => readdirSync(dir).flatMap(f => (statSync(join(dir, f)).isDirectory() ? walk(join(dir, f)) : [join(dir, f)]));
+
+// the spec a scene's folder makes (an error says what is wrong with it)
+export function readScene(folder) {
+  const files = Object.fromEntries(walk(folder).map(p => [relative(folder, p).split(sep).join('/'), readFileSync(p, 'utf8')]));
+  if (!('scene.json' in files)) throw new Error(`${folder}: no scene.json`);
+  const spec = JSON.parse(files['scene.json']);
+  const used = new Set(['scene.json']);
+  for (const [key, name] of Object.entries(TOP)) if (name in files) { spec[key] = files[name].replace(/\n+$/, ''); used.add(name); }
+  for (const [key, fields] of Object.entries(IN)) {
+    for (const item of spec[key] || []) {
+      if (!item || typeof item !== 'object' || !item.id) continue;
+      for (const [field, path] of Object.entries(fields)) {
+        const name = path.replace('{id}', item.id);
+        if (name in files) { item[field] = files[name].replace(/\n+$/, ''); used.add(name); }
+      }
+    }
+  }
+  const extra = Object.keys(files).filter(f => !used.has(f));
+  if (extra.length) throw new Error(`files no element or widget of scene.json names: ${extra.join(', ')}`);
+  return spec;
+}
+
+// the modules a scene lists, from its world's repository: {name: {code, data}}
+export function readModules(world, spec) {
+  const out = {};
+  for (const name of [...new Set((spec.modules || []).filter(n => typeof n === 'string'))].sort()) {
+    const code = join(world, 'modules', `${name}.js`), data = join(world, 'modules', `${name}.data.json`);
+    if (!existsSync(code)) throw new Error(`the scene lists modules/${name}.js, and there is none`);
+    out[name] = { code: readFileSync(code, 'utf8'), data: existsSync(data) ? JSON.parse(readFileSync(data, 'utf8')) : null };
+  }
+  return out;
+}