@onceworlds/cli 0.9.2 → 0.9.4

package/README.md

@@ -83,11 +83,14 @@ from the running game and commit them under `store/`. `onceworlds doctor` says w
 
 ## Commands
 
-- `onceworlds new [folder] --kit <name>` starts a game from a kit: a working skeleton on the engine (rules, netcode, Flow,
-  bots and tests), one per kind of game (`--list` shows them); its look and screens are placeholders to replace. It writes the
-  kit with an `onceworlds.json` for your game (`--name`, `--slug`, `--description`; the folder's name by default), the engine
-  guide as `AGENTS.md` and `CLAUDE.md`, the kit's own notes (what each file does, what to change, its tests) as `KIT.md`, and
-  a `DESIGN.md` to fill in first (the hook, the first minute, the art direction, the UI and a pre-build check). `--template party` or `starter` starts a small game on the SDK alone.
+- `onceworlds new [folder]` starts a game: a blank engine project (`--space 3d` for 3D) with nothing that decides the game, only
+  the wiring: a `game.config.js` with a camera and an empty action map, a test that plays it through a reloaded host and a dropped
+  player, an `onceworlds.json` for your game (`--name`, `--slug`, `--description`; the folder's name by default), the engine guide
+  as `AGENTS.md` and `CLAUDE.md`, and a `DESIGN.md` to fill in first (the hook and signature mechanic, an originality pass, the first
+  minute, the art direction, the feel, the UI and a pre-build check). `--kit <name>` starts from a kit instead: a complete game of
+  one kind (`--list` shows them), a reference for its plumbing (rooms, netcode, Flow, bots, tests) whose idea, look and screens are
+  never yours. A kit adds its own notes as `KIT.md` and its fingerprints as `.onceworlds/kit.json`, so `check` can note what is
+  still the kit's. `--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
@@ -102,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`.
@@ -110,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.
@@ -122,8 +130,10 @@ from the running game and commit them under `store/`. `onceworlds doctor` says w
   from the source text (`Input.axis2d`, `Input.button`) and may differ. It checks `onceworlds.json` by every rule a deploy applies
   (lengths, genres, badges, How to play, the pictures it names), in the deploy's words and with the fix, and fails as the deploy
   would; the rest only suggests (`--strict` exits with an error on likely bugs, for CI). `check` does the same. For an engine
-  game on Flow it also says what still looks like a kit (Flow's placeholder screens, the default theme), a 3-2-1 of the game's
-  own beside Flow's, a `DESIGN.md` left empty, and a first round no different from the rest.
+  game it also says when `DESIGN.md` is missing or has parts left empty (the originality pass included), and notes a game still
+  close to the kit it started from (scripts unchanged, the kit's numbers, its screens). For a game on Flow it says what still
+  looks like a kit (Flow's placeholder screens, the default theme), a 3-2-1 of the game's own beside Flow's, and a first round
+  no different from the rest. Taste is the game's: these are warnings and notes, never a failure.
 
 - `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"`;
@@ -140,8 +150,8 @@ from the running game and commit them under `store/`. `onceworlds doctor` says w
   `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.