@craftrpgs/cli 0.1.7 → 0.2.0-alpha.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +34 -0
- package/dist/bin.js +11525 -6012
- package/package.json +3 -3
package/README.md
CHANGED
|
@@ -29,6 +29,7 @@ know how to work with the project the moment you open it.
|
|
|
29
29
|
| Command | What it does |
|
|
30
30
|
|---|---|
|
|
31
31
|
| `craft login` / `logout` | Browser sign-in (credentials stored per server) |
|
|
32
|
+
| `craft env [production\|alpha]` | Show or pin the environment a folder uses (`--clear` unpins) |
|
|
32
33
|
| `craft create <name>` | Create a new project and clone it (`--system <id\|name>` builds on a published system; `--blank` starts from scratch) |
|
|
33
34
|
| `craft clone <idOrUrl>` | Download a project as a local workspace |
|
|
34
35
|
| `craft projects` | List projects your account owns |
|
|
@@ -44,6 +45,7 @@ know how to work with the project the moment you open it.
|
|
|
44
45
|
| `craft type new <Name>` | Author a new file type locally |
|
|
45
46
|
| `craft image generate/upload` | Generate (including local or workspace reference images; opt-in in Settings) or upload images |
|
|
46
47
|
| `craft image expressions/cutouts` | Preflight and persist character expression or cutout assets |
|
|
48
|
+
| `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`) |
|
|
47
49
|
|
|
48
50
|
Every command takes `--json` for machine-readable output. Auth is via
|
|
49
51
|
`craft login` (browser OAuth); credentials are stored locally and refreshed
|
|
@@ -51,6 +53,38 @@ automatically.
|
|
|
51
53
|
|
|
52
54
|
Run `craft help <command>` for details on any of them.
|
|
53
55
|
|
|
56
|
+
## Alpha
|
|
57
|
+
|
|
58
|
+
The CLI talks to production by default. Alpha testers point a folder at
|
|
59
|
+
alpha (alpha.craftrpgs.com) instead:
|
|
60
|
+
|
|
61
|
+
```sh
|
|
62
|
+
craft env alpha # pins this folder and everything under it
|
|
63
|
+
craft login # signs in on alpha
|
|
64
|
+
craft clone https://alpha.craftrpgs.com/projects/<id>
|
|
65
|
+
```
|
|
66
|
+
|
|
67
|
+
A pasted alpha project URL clones from alpha in any folder. Run
|
|
68
|
+
`craft env --clear` in the pinned folder to go back to production.
|
|
69
|
+
|
|
70
|
+
## Visual novels
|
|
71
|
+
|
|
72
|
+
A visual novel is a paged story readers click through: a backdrop, a text
|
|
73
|
+
box, and the speaker's cutout on the stage. Each story is one JSON document,
|
|
74
|
+
so it syncs as a single file rather than with the workspace:
|
|
75
|
+
|
|
76
|
+
```sh
|
|
77
|
+
craft vn create "Lanterns Over Kestrel Bay" # in this workspace's project
|
|
78
|
+
# edit .craft/visual-novels/lanterns-over-kestrel-bay.vn.json, then:
|
|
79
|
+
craft vn check .craft/visual-novels/lanterns-over-kestrel-bay.vn.json
|
|
80
|
+
craft vn push .craft/visual-novels/lanterns-over-kestrel-bay.vn.json
|
|
81
|
+
craft vn publish .craft/visual-novels/lanterns-over-kestrel-bay.vn.json --unlisted
|
|
82
|
+
```
|
|
83
|
+
|
|
84
|
+
`craft vn assets <file>` prints the project's cast and backdrops and your
|
|
85
|
+
studio music as entries ready to paste into the story. Inside a workspace,
|
|
86
|
+
`.craft/instructions/authoring-visual-novels.md` documents the format.
|
|
87
|
+
|
|
54
88
|
## Staying up to date
|
|
55
89
|
|
|
56
90
|
The server only accepts the latest published version of the CLI. When a
|