@onceworlds/cli 0.9.3 → 0.9.5

package/README.md

@@ -105,7 +105,7 @@ from the running game and commit them under `store/`. `onceworlds doctor` says w
 - `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
   output folder when `package.json` has a build script, else `.` or the folder with your `index.html`),
-  `.github/workflows/onceworlds.yml`, a `.gitignore` (`node_modules/` and the pictures `shot` saves; to one you have it adds only
+  `.github/workflows/onceworlds.yml`, a `.gitignore` (`node_modules/` and the pictures `shot` and `shot --story` save; to one you have it adds only
   those lines, once), and the guide for AI coding tools as `AGENTS.md` with a `CLAUDE.md` that
   imports it (next to a `AGENTS.md` of your own it writes `ONCEWORLDS.md` and adds a pointer to yours). It never
   overwrites a file you have: `--force` replaces only what init writes, never your own `AGENTS.md`, `CLAUDE.md` or `.gitignore`.
@@ -113,6 +113,11 @@ from the running game and commit them under `store/`. `onceworlds doctor` says w
   Then commit, push, and import the repo at https://onceworlds.com/create?new=github.
 - `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. A game's tests never go up: `*.test.js`, `vitest.config.*` and the `test/` folder at the top of the game.
+- `onceworlds serve [dir]` plays the game in your own browser on this computer, offline and with no login: it serves the folder
+  (onceworlds.json's `dir`) with the import map the platform adds for the engine (the installed package's files, else the hosted
+  copy of the engine this CLI ships with). With no platform around it the engine's stand-in is the platform: you alone in a room
+  of your own, the lobby's Start button (engine 1.3.2 on; older ones start a match with `?autoplay`), saves in memory, and
+  `--bots 3` (the default) bots beside you in a game whose roster gives bots a body. `--port` picks the port (default 8788).
 - `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.
@@ -138,15 +143,17 @@ from the running game and commit them under `store/`. `onceworlds doctor` says w
   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`), the title screen (`--phase title`) or the lobby (`--phase lobby`), 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`). `--story` plays the first minute as a new player lives it
-  (the title, the lobby, the countdown, the round's goal, play at +1, +5 and +12 s, the first result), saves each frame into
-  `store/story/` and lays them out on one contact sheet, `store/story.png`, with the questions to ask of it.
+  `--size 1280x720` by default. A 2D game is drawn with no browser, from the frame the engine draws, with its text in the fonts
+  the game's files name (its own font files, or Google Fonts, downloaded once and kept) and Sora for the rest; the caption says
+  which it couldn't have, and that the HTML overlay (`ui.overlay`) needs `--browser`. 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`). `--story` plays the
+  first minute as a new player lives it (the title, the lobby, the countdown, the round's goal, play at +1, +5 and +12 s, the first
+  result), saves each frame into `store/story/` and lays them out on one contact sheet, `store/story.png`, with the questions to
+  ask of it.
 
 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`.
+asset library), `check`, `screenshot` (the picture comes back to the model), `serve` (an address for the user to play it at),
+`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.