@moku-labs/game 0.12.0 → 0.13.0

package/README.md

@@ -165,7 +165,7 @@ The engine bin `moku-game` serves, builds and packs a game folder. A game writes
 | `moku-game native build <target> [--simulator]` | Builds the native app: `ios`, `macos`, `android` |
 | `moku-game native dev <target>` | Runs the native shell on the dev server |
 | `moku-game native doctor`, `native clean` | Checks or removes the native project |
-| `moku-game keys [--check]` | Writes `generated/assets.ts`, the strings and `manifest.json` |
+| `moku-game keys [--check]` | Writes `generated/assets.ts`, the strings and `generated/manifest.json` |
 | `moku-game pack [--no-cache]` | Packs the assets into `dist/assets` |
 | `moku-game visual [--update] [--only <name>] [--no-pixels]` | Runs the visual tests of `tests/visual/index.ts` against `tests/visual/baselines/`. The pixel leg runs on a Mac, on a page served for the run. Exit 1 when a checkpoint differs |
 

package/dist/cli.mjs

@@ -355,6 +355,11 @@ const FORWARDED = [
 const STOPPING = ["SIGINT", "SIGTERM"];
 /** How often the dev child checks that its parent still runs. */
 const PARENT_CHECK_MS = 1e3;
+/**
+* The dev manifest `moku-game keys` writes, relative to the game folder, next to
+* `generated/assets.ts`. The dev server answers `/manifest.json` with it.
+*/
+const DEV_MANIFEST = "generated/manifest.json";
 /** The folders a `.dev.ts` module is never looked for in. */
 const NO_DEV_MODULES = /^(?:node_modules|dist|generated|tests|__tests__)$/;
 /** A `.gitignore` line that keeps `.moku/` of its own folder out. */
@@ -663,9 +668,9 @@ function devChildCommand(run, page, deps) {
 async function serveParent(run, deps) {
 	const settings = await loadGame(run.root);
 	const hasPack = isFile(path.join(run.root, "dist", "assets", "manifest.json"));
-	const hasManifest = isFile(path.join(run.root, "manifest.json"));
+	const hasManifest = isFile(path.join(run.root, DEV_MANIFEST));
 	if (run.packed && !hasPack) throw new Error(`[game] dev: no packed build in "${path.join(run.root, "dist", "assets")}".\n  Run "moku-game pack" first.`);
-	if (!run.packed && !hasManifest) deps.ui.warn(`[game] dev: no manifest.json in "${run.root}".\n  Run "moku-game keys" first.`);
+	if (!run.packed && !hasManifest) deps.ui.warn(`[game] dev: no ${DEV_MANIFEST} in "${run.root}".\n  Run "moku-game keys" first.`);
 	const page = writePage(run.root, settings, run, deps.resolve);
 	if (!ignoresMoku(run.root)) deps.ui.warn("[game] dev: add \".moku/\" to .gitignore. moku-game writes its dev page there.");
 	return runChild(devChildCommand(run, page, deps), deps, {
@@ -755,8 +760,10 @@ function fileResponse(file) {
 }
 /**
 * Starts the dev server on `127.0.0.1` only, never on every interface: the page on `/`, the
-* manifest of the served folder on `/manifest.json`, and its files as static files. The dev child
-* and `moku-game visual` serve the page with it.
+* manifest on `/manifest.json`, and the files of the served folder as static files. The manifest
+* is the dev manifest `generated/manifest.json` of the game, or `manifest.json` of `dist/assets`
+* with `--packed`; its paths are relative to the served folder. The dev child and
+* `moku-game visual` serve the page with it.
 *
 * @param run - The flags of the run.
 * @param page - The page bundle the process imported.
@@ -765,6 +772,7 @@ function fileResponse(file) {
 */
 function serveOn(run, page) {
 	const base = run.packed ? path.join(run.root, "dist", "assets") : run.root;
+	const manifest = path.join(base, run.packed ? "manifest.json" : DEV_MANIFEST);
 	try {
 		return Bun.serve({
 			hostname: "127.0.0.1",
@@ -772,7 +780,7 @@ function serveOn(run, page) {
 			development: true,
 			routes: {
 				"/": page,
-				"/manifest.json": () => fileResponse(path.join(base, "manifest.json"))
+				"/manifest.json": () => fileResponse(manifest)
 			},
 			fetch: (request) => fileResponse(staticPath(base, new URL(request.url).pathname))
 		});
@@ -891,7 +899,7 @@ function hasEnglishStrings(root, settings) {
 	return [...featureFolders, ...layerFolders].some((folder) => statSync(path.join(folder, "strings", "en.json"), { throwIfNoEntry: false })?.isFile() === true);
 }
 /**
-* The flags of the asset scan for `moku-game keys`: the dev manifest beside the game, the
+* The flags of the asset scan for `moku-game keys`: the dev manifest in `generated/`, the
 * pseudo-locale when the game has an English string file, and `--check` for a check run.
 *
 * @param root - The game folder.
@@ -900,7 +908,7 @@ function hasEnglishStrings(root, settings) {
 * @returns The flags for the scanner's command line.
 * @example
 * ```ts
-* keysArguments("/g", resolveConfig({ page: { title: "T" } }), true).slice(4); // ["--manifest", "/g/manifest.json", "--check"]: no strings
+* keysArguments("/g", resolveConfig({ page: { title: "T" } }), true).slice(4); // ["--manifest", "/g/generated/manifest.json", "--check"]: no strings
 * keysArguments("/g", resolveConfig({ page: { title: "T" } }), false).at(-1); // "--pseudo" once /g/features/home/strings/en.json exists
 * ```
 */
@@ -908,7 +916,7 @@ function keysArguments(root, settings, check) {
 	return [
 		...scanArguments(root, settings),
 		"--manifest",
-		path.join(root, "manifest.json"),
+		path.join(root, DEV_MANIFEST),
 		...hasEnglishStrings(root, settings) ? ["--pseudo"] : [],
 		...check ? ["--check"] : []
 	];
@@ -1183,12 +1191,12 @@ async function loadSuite(file, cwd) {
 * @param resolve - Bun's resolver, to find the hot plugin.
 * @returns The paths of the HTML and the bunfig.
 * @throws {Error} The errors of `moku-game dev` before its server starts, and a game without
-*   `manifest.json`.
+*   `generated/manifest.json`.
 */
 async function writeVisualPage(page, resolve) {
 	const settings = await loadGame(page.root);
-	const manifest = path.join(page.root, "manifest.json");
-	if (statSync(manifest, { throwIfNoEntry: false })?.isFile() !== true) throw new Error(`[game] visual: no manifest.json in "${page.root}".\n  Run "moku-game keys" first.`);
+	const manifest = path.join(page.root, DEV_MANIFEST);
+	if (statSync(manifest, { throwIfNoEntry: false })?.isFile() !== true) throw new Error(`[game] visual: no ${DEV_MANIFEST} in "${page.root}".\n  Run "moku-game keys" first.`);
 	return writePage(page.root, settings, {
 		preload: page.preload,
 		servePlugins: page.servePlugins
@@ -1391,7 +1399,7 @@ const USAGE = [
 	"  native build <target> [--simulator]   build the native app (ios, macos, android)",
 	"  native dev <target>                   run the native shell on the dev server",
 	"  native doctor | native clean          check or remove the native project",
-	"  keys [--check]                        write generated/assets.ts and manifest.json",
+	"  keys [--check]                        write generated/assets.ts and generated/manifest.json",
 	"  pack [--no-cache]                     pack the assets into dist/assets",
 	"  visual [--update] [--only <name>]     run tests/visual/index.ts: headless, pixels on a Mac",
 	"    [--no-pixels | --pixels] [--webgl] [--dir tests/visual/baselines]",

package/dist/project.d.mts

@@ -21,7 +21,7 @@
  * ```
  */
 type ProjectOptions = {
-  /** The folder of the game. A path that is not a directory rejects `openProject`. */root: string; /** The asset manifest, root-relative. Default `manifest.json`, the scanner's default. */
+  /** The folder of the game. A path that is not a directory rejects `openProject`. */root: string; /** The asset manifest, root-relative. Default `generated/manifest.json`, where `moku-game keys` writes it. */
   manifest?: string;
   /**
    * The tsconfig whose `paths` the index follows, root-relative. Default `tsconfig.json`. A path

package/dist/project.mjs

@@ -2888,8 +2888,8 @@ async function walkRoot(root) {
 * ones, reads the aliases again when a config file moved, and rebuilds the index when bytes or
 * aliases changed. `reindexPath` reads one path now for `changed`.
 */
-/** The manifest the asset scanner writes by default. */
-const MANIFEST_FILE = "manifest.json";
+/** The dev manifest `moku-game keys` writes. */
+const MANIFEST_FILE = "generated/manifest.json";
 /** The tsconfig whose `paths` are read by default. */
 const TSCONFIG_FILE = "tsconfig.json";
 /**

package/llms.txt

@@ -320,7 +320,7 @@ Commands of the bin `moku-game` (bun). Every command takes `--root <dir>` (defau
 - `moku-game dev [--port 3000] [--packed]`: writes `.moku/index.html`, `dev.ts`, `main.ts`, `bunfig.toml` (the hot plugin first, `__MOKU_GAME_DEV__` defined `true`), runs Bun again under that bunfig in the game folder and serves `/`. It prints `› <folder>: dev server, raw assets. Ctrl+C stops it.` and then the bound URL alone on its own line, `http://localhost:3000/`. `--port 0` takes a free port. `--packed` serves `dist/assets`. A new or removed file in `tests/scenarios/` rewrites `main.ts`. A taken port: `[game] dev: port 3000 is in use.` with `Pass --port 0 for a free port.`
 - `moku-game build [--out dist/web]`: packs the assets, bundles the page minified with `__MOKU_GAME_DEV__` defined `false` (no scenario, no agent, no `.dev` module, no `/control`), every link `./`, and copies the pack beside it with `manifest.json` next to `index.html`. Runs from any http sub-path and from Tauri, not from `file://`.
 - `moku-game native build <target> [--simulator]`, `native dev <target>`, `native doctor [<target>]`, `native clean [<target>]`: one verb of `@moku-labs/native` (a dev dependency, `^0.3.2`) over `config.ts`. App name, identifier and icon from `native`, orientation and background colour from `page`; the web build is `moku-game build`, the dev server `moku-game dev --port 5173`; system rows for `back`, `haptics`, `store`; the Tauri project in `.moku/tauri`, the apps in `dist-native`. `[game] config.ts has no native section.` without `native`.
-- `moku-game keys [--check]`: `generated/assets.ts`, the compiled strings and `manifest.json`. `moku-game pack [--no-cache]`: `dist/assets`. Both pass the layers of `config.ts`.
+- `moku-game keys [--check]`: `generated/assets.ts`, the compiled strings and the dev manifest `generated/manifest.json`; `dev` serves it on `/manifest.json` and warns without it, `visual` stops without it. `moku-game pack [--no-cache]`: `dist/assets`. Both pass the layers of `config.ts`.
 - `moku-game visual [--update] [--only <name>] [--no-pixels | --pixels] [--webgl] [--dir <path>] [--tests <file>] [--url <url>]`: runs `runVisualTests` with the default export of `tests/visual/index.ts`, `{ app, tests }` (`app` is a `VisualSetup` `{ app, page? }`: `export default { app: { app: fixtureApp }, tests }`), against `tests/visual/baselines/`. The flags go through `parseVisualArgv`. The pixel leg runs on a Mac only unless `--pixels`/`--no-pixels`; without `--url` the command writes its own page into `.moku/visual/` (the page of `dev` and of the editor in `.moku/` stays), runs Bun again under `.moku/visual/bunfig.toml` as `dev` does (hot plugin, `--serve-plugin`, `--preload`), and the child serves the page on a free port, then stops it. No `manifest.json`: `[game] visual: no manifest.json in "<game>".` Exit 0 when the report is ok, else 1. `[game] visual: <file> must export default { app, tests }.` for a missing module or another shape, a bare app factory too.
 - `preparePage(root, { agents?, preload?, servePlugins? })` of `@moku-labs/game/cli` writes the dev page of `moku-game dev` and resolves `{ html, bunfig }`, both absolute, for a server the caller starts: `bun --config=<bunfig>`. With agents the page also imports the game's `**/*.dev.ts` and hands them to the agents. The editor calls it: `await preparePage("games/timber", { agents: ["@moku-labs/editor/agent/page"] })`.
 
@@ -711,7 +711,7 @@ core/             the kit (the defineGame call) and its types
 shared/           the shared layer
 features/<f>/     one feature: flow/, rules/, views/, styles/, motion/, world/, assets/, strings/
 plugins/          the game's own plugins
-generated/        what moku-game keys writes
+generated/        what moku-game keys writes: assets.ts, the strings, manifest.json
 tests/            the tests; tests/scenarios/<name>.ts are the saves of ?player=<name>
 .moku/            what moku-game writes, ignored by git
 ```

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@moku-labs/game",
-  "version": "0.12.0",
+  "version": "0.13.0",
   "description": "2D puzzle game engine on TypeScript and PixiJS, built on @moku-labs/core.",
   "type": "module",
   "sideEffects": false,