@opengamehq/cli 0.7.0 → 0.9.1
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/AGENTS.md +6 -6
- package/CHANGELOG.md +78 -0
- package/README.md +7 -7
- package/dist/cli.mjs +158 -142
- package/dist/opengame-global.js +3 -3
- package/dist/preflight-worker.mjs +17 -17
- package/dist/runtime-builder.mjs +1 -1
- package/dist/safe-fs.py +55 -0
- package/dist/skills/manifest.json +22 -22
- package/dist/skills/opengame-api/SKILL.md +2 -2
- package/dist/skills/opengame-cli/SKILL.md +4 -4
- package/dist/skills/opengame-deploy/SKILL.md +6 -6
- package/dist/skills/opengame-deploy/references/manifest.md +9 -3
- package/dist/skills/opengame-deploy/references/packaging.md +4 -4
- package/dist/skills/opengame-jam/SKILL.md +4 -4
- package/dist/skills/opengame-router/SKILL.md +2 -2
- package/dist/skills/opengame-sdk/SKILL.md +2 -2
- package/dist/skills/opengame-sdk/references/leaderboards.md +11 -1
- package/dist/skills/opengame-sdk/references/radio.md +1 -1
- package/package.json +1 -1
package/AGENTS.md
CHANGED
|
@@ -89,14 +89,14 @@ opengame login --continue --json
|
|
|
89
89
|
|
|
90
90
|
Run these from the game folder.
|
|
91
91
|
|
|
92
|
-
If the folder has no `opengame.json`, create one.
|
|
92
|
+
If the folder has no `opengame.json`, create one. The title is all it needs. A decomp or a mod says so with `--kind` and names the game it is based on:
|
|
93
93
|
|
|
94
94
|
```bash
|
|
95
95
|
opengame init . --title "My game" --json
|
|
96
96
|
opengame init . --title "Doom but blue" --kind mod --based-on "Doom" --json
|
|
97
97
|
```
|
|
98
98
|
|
|
99
|
-
|
|
99
|
+
Do not ask the creator for a description or a genre before deploying. When you know them, pass `--description` (40 characters or more) and `--genre`; when you do not, init writes a placeholder description and a provisional genre, and the deploy prints its page, where the creator writes the description, chooses the genre and enters the jam. After the deploy you can set the description yourself with `opengame details --description "..." --json`. If the file already exists, leave `init` alone and edit the file.
|
|
100
100
|
|
|
101
101
|
For a game that already exists on OpenGame, in a new checkout, link the folder first so the deploy does not create a second game:
|
|
102
102
|
|
|
@@ -112,7 +112,7 @@ opengame check . --build --json
|
|
|
112
112
|
opengame deploy . --json
|
|
113
113
|
```
|
|
114
114
|
|
|
115
|
-
`deploy` runs the manifest's build command, checks the output and uploads it, up to
|
|
115
|
+
`deploy` runs the manifest's build command, checks the output and uploads it, up to 4 GiB zipped. It returns once the upload is in, with exit 0 and `data.done: false`, while the checks run on the server. Keep `.opengame/`: later commands resume and follow the same deploy from it. Use `--no-build` only when the creator says the export is already built and its build cannot run here, never to get past a failing build.
|
|
116
116
|
|
|
117
117
|
| Field | What it holds |
|
|
118
118
|
| --- | --- |
|
|
@@ -166,7 +166,7 @@ opengame jams --json
|
|
|
166
166
|
opengame submit --release <releaseId> --no-wait --json
|
|
167
167
|
```
|
|
168
168
|
|
|
169
|
-
OpenGame decides where submissions go. When that is a jam, the
|
|
169
|
+
OpenGame decides where submissions go, and a ready deploy goes to review by itself. When that is a jam, the creator usually enters it on the deploy's page (`data.deploymentUrl`). To enter it from here instead, read the form with `opengame jams <slug> --json` and pass the track, the models they used and any sponsor evidence as `--track`, `--models`, `--sponsor` and `--evidence-<sponsor>`. A missing answer exits 2 and names the flag. A decomp or a mod cannot enter a jam.
|
|
170
170
|
|
|
171
171
|
When `data.state` is `needs_certification`, give the creator `data.certifyUrl`, which the CLI also prints as a `certify_required` notice. They certify in their own browser that they have the rights to the game. You cannot do it for them. Follow the review with:
|
|
172
172
|
|
|
@@ -202,7 +202,7 @@ Play the private preview before you tell the creator the game works.
|
|
|
202
202
|
<!-- generated:commands -->
|
|
203
203
|
| Command | What it does |
|
|
204
204
|
| --- | --- |
|
|
205
|
-
| `opengame init [dir] [options]` | Create opengame.json for an existing game. |
|
|
205
|
+
| `opengame init [dir] [options]` | Create opengame.json for an existing game. A person at a terminal is asked the game's name and nothing else; the description, genre, jam entry and the rest are filled in on the deploy's page, by you or your agent. When opengame.json is already there, fill in the fields it leaves blank and keep the rest. |
|
|
206
206
|
| `opengame check [dir] [options]` | Find local build and asset problems before uploading. |
|
|
207
207
|
| `opengame dev [dir] [options]` | Serve a local export with game-runtime headers. Under a contract that adds the SDK, pages also get the host runtime and SDK, as they do when hosted. If the contract supports opting out, sdk.inject: false leaves out the SDK. |
|
|
208
208
|
| `opengame login [options]` | Sign in through your browser. |
|
|
@@ -210,7 +210,7 @@ Play the private preview before you tell the creator the game works.
|
|
|
210
210
|
| `opengame status [dir] [options]` | Show the most recent deploy for this folder, with its findings. Finishes saving its declared achievements if the deploy could not. Removing an achievement from opengame.json does not switch it off. To retire one, run opengame achievements retire <id>. Unlocks are never deleted. |
|
|
211
211
|
| `opengame deployments [dir] [options]` | List the linked game's deploys, newest first: status, when, size, who started each one, why any stopped, and each one's page or preview. |
|
|
212
212
|
| `opengame open [dir] [options]` | Open the linked game's private page in your browser. |
|
|
213
|
-
| `opengame submit [dir] [options]` | Send one release to review, and enter it in a jam. |
|
|
213
|
+
| `opengame submit [dir] [options]` | Send one release to review, and enter it in a jam. A deploy goes to review by itself, so this is mostly for agents entering a jam with flags. A person who names no jam answer is given the deploy's page, where the track, models and sponsor tracks are chosen, and nothing is sent. |
|
|
214
214
|
| `opengame jams [slug] [options]` | List open jams, or show one jam's tracks and flags. |
|
|
215
215
|
| `opengame jam <withdraw\|reenter> [options]` | Withdraw the linked game's jam entry, freeing its place, or put a withdrawn one back while the jam is open, as your jam entries page does. Needs a token with submit; opengame login has it. |
|
|
216
216
|
| `opengame releases [dir] [options]` | List the linked game's releases, newest first, as the Releases tab on its page does: which one is live, which were live before, which are drafts and which were cleaned up, and which can be made live again. |
|
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,83 @@
|
|
|
1
1
|
# Changelog
|
|
2
2
|
|
|
3
|
+
## 0.9.1
|
|
4
|
+
|
|
5
|
+
- `opengame deploy --wait` shows the deployment checklist shared with Drop and prints the page where upload, checks, review and publication update live. JSON output keeps its existing event format.
|
|
6
|
+
|
|
7
|
+
## 0.9.0
|
|
8
|
+
|
|
9
|
+
- `opengame login --continue` no longer loses a login you already allowed. Each run
|
|
10
|
+
started from the first polling interval and polled again as its time ran out, so a
|
|
11
|
+
script or agent running it over and over was told to slow down every time, until the
|
|
12
|
+
next poll it was allowed fell after the code expired. It now keeps the pace the server
|
|
13
|
+
sets between runs and never polls early. The server also hands over an allowed login on
|
|
14
|
+
the next poll whatever its pace, so 0.8.0 recovers too.
|
|
15
|
+
- `opengame deploy`, `check --build`, `dev --build` and `vendor --build` install your
|
|
16
|
+
dependencies before the build in a fresh checkout (a lockfile and no `node_modules`), with
|
|
17
|
+
the command the lockfile names (`npm ci`, `pnpm install --frozen-lockfile`, `yarn install`
|
|
18
|
+
or `bun install`). When `node_modules` is there but packages are missing, or the lockfile
|
|
19
|
+
is in a parent workspace, or there is none, they stop and name the missing packages and
|
|
20
|
+
the install to run, so nothing you installed is wiped. `--no-install` skips the step. A
|
|
21
|
+
build that fails with "command not found" now says the tool is probably not installed.
|
|
22
|
+
- `opengame init` on a Vite or other bundler project sets the export folder to the
|
|
23
|
+
bundler's output (`dist`, or `build.outDir` from vite.config) and no longer picks an
|
|
24
|
+
`index.html` inside `src/`. It also reads a project's files in far fewer passes, so it
|
|
25
|
+
no longer sits silent for many seconds after the last question.
|
|
26
|
+
- In a terminal, the CLI shows a spinner with a line saying what it is doing while a
|
|
27
|
+
command works, and the time once it passes five seconds. Scripts, `--json`, `--jsonl`
|
|
28
|
+
and agents get no spinner.
|
|
29
|
+
- Questions and the summary after them line up in one column, with one blank line around
|
|
30
|
+
the form, and long lines wrap inside the terminal.
|
|
31
|
+
- An error that has a next step prints it as `Try: <command>`, and many errors that only
|
|
32
|
+
said what went wrong now also say what to do. A build failure no longer repeats its
|
|
33
|
+
next step.
|
|
34
|
+
- `opengame init` asks a person one thing, the game's name, with what it read from
|
|
35
|
+
index.html, package.json or the folder offered as the answer. It no longer asks what you
|
|
36
|
+
are making, which game a mod is based on, a description or a genre. `--kind`,
|
|
37
|
+
`--based-on`, `--description` and `--genre` still set any of them.
|
|
38
|
+
- With no description of its own, a project gets a placeholder sentence, which a deploy
|
|
39
|
+
marks provisional. The deploy prints its page, where you write the description, choose
|
|
40
|
+
the genre and enter the jam; the game cannot publish with the placeholder.
|
|
41
|
+
- `opengame submit` no longer walks a person through the jam's form. With no jam answer
|
|
42
|
+
named, it prints the deploy's page, where the entry is made, and sends nothing. Agents
|
|
43
|
+
still answer with `--track`, `--models` and `--sponsor`.
|
|
44
|
+
- Needs the website from the same release: an older server refuses `description` in a
|
|
45
|
+
deploy's provisional fields.
|
|
46
|
+
- `opengame check` and deploy no longer refuse a game for the `http://yandex.com/bots` entry
|
|
47
|
+
in PostHog's bot list, which is text the library matches against and never requests.
|
|
48
|
+
PeerJS's default public relays are one note instead of three warnings, and a file a
|
|
49
|
+
loader asks for by bare name (KTX2Loader's `basis_transcoder.wasm`, a Draco decoder) is
|
|
50
|
+
no longer reported missing when it is in the bundle under another folder.
|
|
51
|
+
- A build whose archive would be past 200 MiB goes file by file when your account allows
|
|
52
|
+
it: files OpenGame already has are skipped, and the archive is written to
|
|
53
|
+
disk a slice at a time instead of held in memory. A build can be 25,000 files, 5 GiB
|
|
54
|
+
unpacked and 4 GiB zipped. A build the file-by-file plan cannot take, such as a Kaigen
|
|
55
|
+
export or one whose bulk is code, or a machine without Python 3 (Windows included), still
|
|
56
|
+
sends one archive as before.
|
|
57
|
+
|
|
58
|
+
## 0.8.0
|
|
59
|
+
|
|
60
|
+
- `opengame init` guesses a genre from the title, the description, the page's meta
|
|
61
|
+
description and package.json's keywords, as its help says. When none of those names a
|
|
62
|
+
genre, it asks a person, and an agent or a script gets `puzzle-casual`, with the line to
|
|
63
|
+
change it. It used to leave genre blank, and `opengame check` then refused the file.
|
|
64
|
+
- `opengame init` in a folder whose opengame.json leaves title, description, genre or
|
|
65
|
+
controls blank fills those in and keeps everything the file sets. It used to stop because
|
|
66
|
+
the file existed. A file with nothing blank is still refused, and a flag for a field the
|
|
67
|
+
file already sets is named as unused. If the file is saved while init is asking a
|
|
68
|
+
question, init keeps that edit and writes nothing.
|
|
69
|
+
- `opengame init` sets controls from the keyboard, mouse, touch and gamepad listeners in
|
|
70
|
+
your game's own source. Touch counts as mouse, so a game that only listens for taps or
|
|
71
|
+
clicks gets `mouse`. It used to write keyboard and mouse whatever the game used, and
|
|
72
|
+
still does when it finds no input at all.
|
|
73
|
+
- A genre or controls that init chose without being told are marked provisional when you
|
|
74
|
+
deploy, as Drop and the GitHub tab already do, so the details form after review offers
|
|
75
|
+
what review detected rather than treating the guess as your choice. Change either in
|
|
76
|
+
opengame.json and it is yours.
|
|
77
|
+
- `opengame check` says how to set a blank or unknown genre, naming the genres and the
|
|
78
|
+
init line that fills it, rather than "Correct genre in opengame.json".
|
|
79
|
+
- Ships the skills from `@opengamehq/skills` 1.3.0, as 0.7.0 did.
|
|
80
|
+
|
|
3
81
|
## 0.7.0
|
|
4
82
|
|
|
5
83
|
- `opengame unpublish` takes a game off the gallery and stops serving it, and `opengame
|
package/README.md
CHANGED
|
@@ -39,8 +39,9 @@ opengame check .
|
|
|
39
39
|
opengame deploy .
|
|
40
40
|
```
|
|
41
41
|
|
|
42
|
-
`init` writes `opengame.json`, the manifest with your game's title
|
|
43
|
-
|
|
42
|
+
`init` writes `opengame.json`, the manifest with your game's title and build. It asks
|
|
43
|
+
you one thing, the game's name, and you write the description, choose the genre and
|
|
44
|
+
enter the jam on the deployment page afterwards, or have your agent do it. `check` runs the same checks the upload will, on your machine. `deploy` builds,
|
|
44
45
|
checks and uploads a release, then prints its deployment page:
|
|
45
46
|
|
|
46
47
|
```
|
|
@@ -50,9 +51,8 @@ Watch them, and play the preview once it is ready, at https://opengame.io/settin
|
|
|
50
51
|
Or follow them here with opengame status --watch.
|
|
51
52
|
```
|
|
52
53
|
|
|
53
|
-
The private preview plays on that page once the checks pass
|
|
54
|
-
|
|
55
|
-
release to review.
|
|
54
|
+
The private preview plays on that page once the checks pass, and the release goes to
|
|
55
|
+
review by itself. Add `--wait` to stay in the terminal until the checks finish.
|
|
56
56
|
|
|
57
57
|
## Scripts and agents
|
|
58
58
|
|
|
@@ -83,7 +83,7 @@ OpenCode, so a coding agent can do all of the above for you.
|
|
|
83
83
|
<!-- generated:commands -->
|
|
84
84
|
| Command | What it does |
|
|
85
85
|
| --- | --- |
|
|
86
|
-
| `opengame init [dir] [options]` | Create opengame.json for an existing game. |
|
|
86
|
+
| `opengame init [dir] [options]` | Create opengame.json for an existing game. A person at a terminal is asked the game's name and nothing else; the description, genre, jam entry and the rest are filled in on the deploy's page, by you or your agent. When opengame.json is already there, fill in the fields it leaves blank and keep the rest. |
|
|
87
87
|
| `opengame check [dir] [options]` | Find local build and asset problems before uploading. |
|
|
88
88
|
| `opengame dev [dir] [options]` | Serve a local export with game-runtime headers. Under a contract that adds the SDK, pages also get the host runtime and SDK, as they do when hosted. If the contract supports opting out, sdk.inject: false leaves out the SDK. |
|
|
89
89
|
| `opengame login [options]` | Sign in through your browser. |
|
|
@@ -91,7 +91,7 @@ OpenCode, so a coding agent can do all of the above for you.
|
|
|
91
91
|
| `opengame status [dir] [options]` | Show the most recent deploy for this folder, with its findings. Finishes saving its declared achievements if the deploy could not. Removing an achievement from opengame.json does not switch it off. To retire one, run opengame achievements retire <id>. Unlocks are never deleted. |
|
|
92
92
|
| `opengame deployments [dir] [options]` | List the linked game's deploys, newest first: status, when, size, who started each one, why any stopped, and each one's page or preview. |
|
|
93
93
|
| `opengame open [dir] [options]` | Open the linked game's private page in your browser. |
|
|
94
|
-
| `opengame submit [dir] [options]` | Send one release to review, and enter it in a jam. |
|
|
94
|
+
| `opengame submit [dir] [options]` | Send one release to review, and enter it in a jam. A deploy goes to review by itself, so this is mostly for agents entering a jam with flags. A person who names no jam answer is given the deploy's page, where the track, models and sponsor tracks are chosen, and nothing is sent. |
|
|
95
95
|
| `opengame jams [slug] [options]` | List open jams, or show one jam's tracks and flags. |
|
|
96
96
|
| `opengame jam <withdraw\|reenter> [options]` | Withdraw the linked game's jam entry, freeing its place, or put a withdrawn one back while the jam is open, as your jam entries page does. Needs a token with submit; opengame login has it. |
|
|
97
97
|
| `opengame releases [dir] [options]` | List the linked game's releases, newest first, as the Releases tab on its page does: which one is live, which were live before, which are drafts and which were cleaned up, and which can be made live again. |
|