@craftrpgs/cli 0.1.6 → 0.1.8

package/README.md

@@ -44,7 +44,7 @@ know how to work with the project the moment you open it.
 | `craft type new <Name>` | Author a new file type locally |
 | `craft image generate/upload` | Generate (including local or workspace reference images; opt-in in Settings) or upload images |
 | `craft image expressions/cutouts` | Preflight and persist character expression or cutout assets |
-| `craft env [name]` | Show or pin the environment for a directory |
+| `craft vn create/pull/push/publish` | Write visual novels: pull a story to one JSON file, edit it, push it back, publish it for readers (`craft help vn`) |
 
 Every command takes `--json` for machine-readable output. Auth is via
 `craft login` (browser OAuth); credentials are stored locally and refreshed
@@ -52,16 +52,32 @@ automatically.
 
 Run `craft help <command>` for details on any of them.
 
-## Environments
+## Visual novels
 
-The CLI talks to production (`craftrpgs.com`) by default. `craft env <name-or-url>`
-pins the current directory tree to another server via a one-line
-`.craft-env` file — handy for keeping a testing folder pointed at a dev
-server while the rest of your machine uses production. `--remote` and
-`CRAFT_REMOTE` accept an environment name or any origin URL. A cloned
-workspace always syncs with the server it was cloned from. (Craft
-developers: set `CRAFT_DEV=1` to enable the internal `local` and `staging`
-environment names.)
+A visual novel is a paged story readers click through: a backdrop, a text
+box, and the speaker's cutout on the stage. Each story is one JSON document,
+so it syncs as a single file rather than with the workspace:
+
+```sh
+craft vn create "Lanterns Over Kestrel Bay"   # in this workspace's project
+# edit .craft/visual-novels/lanterns-over-kestrel-bay.vn.json, then:
+craft vn check .craft/visual-novels/lanterns-over-kestrel-bay.vn.json
+craft vn push  .craft/visual-novels/lanterns-over-kestrel-bay.vn.json
+craft vn publish .craft/visual-novels/lanterns-over-kestrel-bay.vn.json --unlisted
+```
+
+`craft vn assets <file>` prints the project's cast and backdrops and your
+studio music as entries ready to paste into the story. Inside a workspace,
+`.craft/instructions/authoring-visual-novels.md` documents the format.
+
+## Staying up to date
+
+The server only accepts the latest published version of the CLI. When a
+command is refused with a `cli_outdated` error, update and retry:
+
+```bash
+npm install -g @craftrpgs/cli@latest
+```
 
 ## Requirements