@onceworlds/cli 0.7.0 → 0.9.0

package/README.md

@@ -85,15 +85,18 @@ from the running game and commit them under `store/`. `onceworlds doctor` says w
 
 - `onceworlds new [folder] --kit <name>` starts a game from a kit: a complete game on the engine, one per kind of game
   (`--list` shows them). It writes the kit with an `onceworlds.json` for your game (`--name`, `--slug`, `--description`;
-  the folder's name by default) and the engine guide as `AGENTS.md` and `CLAUDE.md`. `--template party` or `starter` starts a
-  small game on the SDK alone.
+  the folder's name by default), the engine guide as `AGENTS.md` and `CLAUDE.md`, and the kit's own notes (what each file
+  does, what to change, its tests) as `KIT.md`. `--template party` or `starter` starts a small game on the SDK alone.
 - `onceworlds check [dir]` is what to run before a deploy: doctor's findings and, for an engine game, the game's own tests
   (`npm test`) and simulated matches played with no browser, with a reloaded host, a dropped player, the host changing (also while
   paused), a late joiner and garbage messages. A failing test or a match with errors exits with an error. The game's config is
   read from `game.config.js` (or `src/game.config.js`, or `--config <file>`): `export const config = {...}`, and `export const actions`
-  lets check compare "How to play" with the action map exactly. Needs `npm install` in the game folder.
+  lets check compare "How to play" with the action map exactly. Needs `npm install` in the game folder. Simulated players only ready
+  up, so a game with long rounds or turn timers may not reach its results in the time check has: `export const quick = ...` from
+  the same file (the game with one short round and short timers) and check plays that. A process that outlives its time limit
+  is killed with everything it started.
 - `onceworlds posters [dir]` draws each `game.poster()` scene of your latest draft (`?poster=<name>`) in a browser on this
-  computer and saves the pictures into `store/`, naming them in `onceworlds.json` when it has no icon or thumbnails.
+  computer and saves the pictures into `store/` (a poster name is letters, digits, dashes, underscores and dots, as in the engine), naming them in `onceworlds.json` when it has no icon or thumbnails.
   `--only cover,icon` picks some.
 - `onceworlds init [dir]` sets a game folder up, with the files the dashboard's import commits. It writes
   `onceworlds.json` (the link and name come from `package.json`'s name or the folder's; `dir` is your build's
@@ -103,7 +106,7 @@ from the running game and commit them under `store/`. `onceworlds doctor` says w
   overwrites a file you have: `--force` replaces only what init writes, never your own `AGENTS.md` or `CLAUDE.md`.
   Then commit, push, and import the repo at https://onceworlds.com/dashboard/new.
 - `onceworlds deploy [dir]` uploads only the files that changed and publishes the game
-  (the workflow runs it). It lists every file it skipped because Onceworlds can't serve it.
+  (the workflow runs it). It lists every file it skipped because Onceworlds can't serve it. A game's tests never go up: `*.test.js`, `vitest.config.*` and the `test/` folder at the top of the game.
 - `onceworlds dev [dir]` deploys to a local Onceworlds platform (for platform development)
   and redeploys on every save. `--players 3` also prints links for players 2 and 3 (`?player=N`): on a
   local platform each is another player, so one person can fill a lobby.
@@ -111,8 +114,24 @@ from the running game and commit them under `store/`. `onceworlds doctor` says w
   tag, text fields under 16px (Safari zooms the page when one is focused), `confirm()` and other dialogs
   (blocked in the game frame), localStorage (gone on reload), and, for games with rooms, `Date.now()` for
   shared time and no use of the platform's lobby. For an engine game it also reads the action map
-  (`Input.axis2d`, `Input.button`) and offers the `controls` it implies: `--fix` writes them into `onceworlds.json` when it has
-  none. It only suggests: nothing in it stops a deploy (`--strict` exits with an error on likely bugs, for CI).
+  and offers the `controls` it implies: `--fix` writes them into `onceworlds.json` when it has none. For an installed engine
+  game the list is the engine's own (`controlsFromActions` on the `actions` that `game.config.js` exports); otherwise it is read
+  from the source text (`Input.axis2d`, `Input.button`) and may differ. It only suggests: nothing in it stops a deploy (`--strict` exits with an error on likely bugs, for CI).
+
+- `onceworlds api <name or words>` looks the engine up in a few lines instead of the whole reference: a signature, what it
+  does, a component's fields or an options object's keys, and an example (`api Shape2D`, `api feel.shake`, `api "camera follow"`;
+  `--full` for every field with its doc). `onceworlds recipe [name]` prints short, tested code for a kind of game or a feature
+  (tycoon, survival, racing, platformer, shooter, party, rpg, idle, sandbox, chase-ai, inventory, shop, dialogue, day-night), and
+  `onceworlds guide [topic]` the engine guide's topics or any heading of the guide or the reference. They read the index of the
+  engine installed in the game's `node_modules` (its own version), else the platform's.
+- `onceworlds shot [dir]` saves a picture of the game to look at: the first player's screen a few seconds into a simulated match
+  with bots (`--at 20`), or a poster (`--poster cover`), at `--size 1280x720` by default. A 2D game is drawn with no browser, from
+  the frame the engine draws, in the engine's font; a 3D game (or `--browser`) is drawn by Chrome, Chromium or Edge from a local
+  copy of the game. `--out` picks the file (default `store/shot.png`).
+
+Running `onceworlds mcp` gives an AI tool the same as tools: `api_lookup`, `recipe`, `read_guide`, `search_assets` (the engine's
+asset library), `check`, `screenshot` (the picture comes back to the model), `new_game`, `deploy_preview`, `playtest` and
+`game_status`.
 
 Games talk to the platform through the injected `window.onceworlds` SDK. The
 starter template's `AGENTS.md` documents it for AI coding tools.