@onceworlds/cli 0.8.0 → 0.9.1

package/README.md

@@ -7,7 +7,7 @@ players) with no server code.
 ## Deploy from GitHub Actions
 
 Deploys run from GitHub Actions: GitHub vouches for the repo, so there are no API
-keys. The easiest setup is to import the repo at https://onceworlds.com/dashboard/new,
+keys. The easiest setup is to import the repo at https://onceworlds.com/create?new=github,
 which adds `onceworlds.json` and `.github/workflows/onceworlds.yml` for you (that
 workflow also builds with npm, pnpm, yarn or bun when there's a build script). To write
 the same files into a folder before it is on GitHub, run `npx @onceworlds/cli init` there.
@@ -101,10 +101,12 @@ 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`, and the guide for AI coding tools as `AGENTS.md` with a `CLAUDE.md` that
+  `.github/workflows/onceworlds.yml`, a `.gitignore` (`node_modules/` and the pictures `shot` saves; 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` or `CLAUDE.md`.
-  Then commit, push, and import the repo at https://onceworlds.com/dashboard/new.
+  overwrites a file you have: `--force` replaces only what init writes, never your own `AGENTS.md`, `CLAUDE.md` or `.gitignore`.
+  `onceworlds new` writes the same workflow and `.gitignore` into every game it makes.
+  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 dev [dir]` deploys to a local Onceworlds platform (for platform development)
@@ -116,7 +118,25 @@ from the running game and commit them under `store/`. `onceworlds doctor` says w
   shared time and no use of the platform's lobby. For an engine game it also reads the action map
   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).
+  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.
+
+- `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`), 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`).
+
+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.