@opengamehq/skills 1.5.0 → 1.7.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/CHANGELOG.md +17 -0
- package/README.md +5 -1
- package/dist/skills/manifest.json +36 -36
- package/dist/skills/opengame-all-in-one/CHANGELOG.md +12 -0
- package/dist/skills/opengame-all-in-one/SKILL.md +4 -4
- package/dist/skills/opengame-all-in-one/references/opengame-api/README.md +4 -3
- package/dist/skills/opengame-all-in-one/references/opengame-cli/README.md +11 -8
- package/dist/skills/opengame-all-in-one/references/opengame-deploy/README.md +25 -12
- package/dist/skills/opengame-all-in-one/references/opengame-deploy/references/json-events.md +11 -10
- package/dist/skills/opengame-all-in-one/references/opengame-deploy/references/manifest.md +17 -11
- package/dist/skills/opengame-all-in-one/references/opengame-deploy/references/packaging.md +3 -2
- package/dist/skills/opengame-all-in-one/references/opengame-jam/README.md +23 -16
- package/dist/skills/opengame-all-in-one/references/opengame-performance/README.md +3 -3
- package/dist/skills/opengame-all-in-one/references/opengame-router/README.md +7 -5
- package/dist/skills/opengame-all-in-one/references/opengame-router/references/process.md +5 -2
- package/dist/skills/opengame-api/CHANGELOG.md +4 -0
- package/dist/skills/opengame-api/SKILL.md +4 -3
- package/dist/skills/opengame-cli/CHANGELOG.md +12 -0
- package/dist/skills/opengame-cli/SKILL.md +11 -8
- package/dist/skills/opengame-deploy/CHANGELOG.md +12 -0
- package/dist/skills/opengame-deploy/SKILL.md +25 -12
- package/dist/skills/opengame-deploy/references/json-events.md +11 -10
- package/dist/skills/opengame-deploy/references/manifest.md +17 -11
- package/dist/skills/opengame-deploy/references/packaging.md +3 -2
- package/dist/skills/opengame-jam/CHANGELOG.md +8 -0
- package/dist/skills/opengame-jam/SKILL.md +24 -17
- package/dist/skills/opengame-performance/CHANGELOG.md +4 -0
- package/dist/skills/opengame-performance/SKILL.md +3 -3
- package/dist/skills/opengame-router/CHANGELOG.md +4 -0
- package/dist/skills/opengame-router/SKILL.md +7 -5
- package/dist/skills/opengame-router/references/process.md +5 -2
- package/package.json +1 -1
|
@@ -103,8 +103,9 @@ No person reviews a game. Once these pass, review plays it and decides by itself
|
|
|
103
103
|
game goes on to be published, or back to the creator with the reason. It goes back when the
|
|
104
104
|
build fails packaging, when its review cost more than any game should need (make it smaller
|
|
105
105
|
or simpler), or when a confident verdict reads it as not a real game, as made for a phone
|
|
106
|
-
held upright, or as not running on a supported web runtime.
|
|
107
|
-
|
|
106
|
+
held upright, or as not running on a supported web runtime. A game's first release then
|
|
107
|
+
waits for its creator to confirm the details, on the deploy's page or with `opengame
|
|
108
|
+
publish`; an update of a live game publishes by itself.
|
|
108
109
|
|
|
109
110
|
Thresholds that warn rather than refuse: an initial download over
|
|
110
111
|
50 MiB before the first playable frame, time to
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
> Carried from `opengame-jam` 1.
|
|
1
|
+
> Carried from `opengame-jam` 1.1.1. Read it when: Enter a game in an OpenGame jam. Finds the open jams, their tracks and rules, checks the game against them, deploys one exact release, and enters it with the person's own answers, with opengame publish or on the deploy's page. Use when the person says enter the jam, submit to the jam, which track should I pick, am I eligible, what are the jam rules, or mentions the OpenGame Global AI Game Jam.
|
|
2
2
|
|
|
3
3
|
|
|
4
4
|
# Enter an OpenGame jam
|
|
@@ -65,8 +65,8 @@ decide. Do not hide a dependency, rewrite history or relabel a library to pass a
|
|
|
65
65
|
|
|
66
66
|
## Pick a track with the person
|
|
67
67
|
|
|
68
|
-
The person
|
|
69
|
-
answer for them.
|
|
68
|
+
The person gives these answers, on the deploy's page or to you for `opengame publish`.
|
|
69
|
+
Help them prepare the answers; do not answer for them.
|
|
70
70
|
|
|
71
71
|
- **Genre track:** one per entry, required. The page starts on the track that matches the
|
|
72
72
|
game's genre; the person keeps it or chooses another.
|
|
@@ -77,28 +77,35 @@ answer for them.
|
|
|
77
77
|
|
|
78
78
|
`opengame jams <slug> --json` lists the whole form.
|
|
79
79
|
|
|
80
|
-
## Deploy, then
|
|
80
|
+
## Deploy, then enter it
|
|
81
81
|
|
|
82
82
|
Follow `opengame-deploy` for installation, sign-in and the deploy. Use the exact release
|
|
83
83
|
the creator played. Once the deploy is ready, review starts by itself; nobody runs a
|
|
84
84
|
command for it. When `opengame status --json` shows `data.review.state` as
|
|
85
|
-
`awaiting_details`,
|
|
86
|
-
their browser, they press Confirm details, choose the track, the models and any sponsor
|
|
87
|
-
tracks, and certify.
|
|
85
|
+
`awaiting_details`, review has passed, and the entry is made one of two ways:
|
|
88
86
|
|
|
89
|
-
|
|
90
|
-
|
|
87
|
+
- **The person asked you to enter it.** Run `opengame publish` with their answers:
|
|
88
|
+
|
|
89
|
+
```bash
|
|
90
|
+
opengame publish --track <track> --models <model>,<model> \
|
|
91
|
+
--sponsor <sponsor> --sponsor-email <sponsor>=<their email> --json
|
|
92
|
+
```
|
|
93
|
+
|
|
94
|
+
It enters the jam, publishes, waits until the game is live, and prints the address to
|
|
95
|
+
share in `data.url`. `opengame deploy --publish` with the same flags does the deploy,
|
|
96
|
+
the wait for review and the entry in one command.
|
|
97
|
+
- **Otherwise,** give the person `data.review.url`, the deploy's page. Signed in there,
|
|
98
|
+
they press Confirm details, choose the track, the models and any sponsor tracks, and
|
|
99
|
+
publish.
|
|
100
|
+
|
|
101
|
+
Do not run `opengame submit` to enter the jam or to publish. It does not confirm a release
|
|
102
|
+
its deploy already sent to review: it answers with that submission and a
|
|
91
103
|
`jam_answers_unused` notice, and the answers go nowhere.
|
|
92
104
|
|
|
93
105
|
## What only the person can do
|
|
94
106
|
|
|
95
|
-
|
|
96
|
-
|
|
97
|
-
them what it is for. Do not open it for them, click through it, or tell them it is
|
|
98
|
-
done. A later revision of the same entry under the same terms skips it.
|
|
99
|
-
|
|
100
|
-
The person also decides whether they are eligible (age, one account), whether they own
|
|
101
|
-
the assets, which track they want, and what their sponsor evidence claims.
|
|
107
|
+
Nobody certifies or attests to anything to enter. The person decides whether they are eligible (age, one account), whether they own
|
|
108
|
+
the assets, which track they want, and which account they used at each sponsor.
|
|
102
109
|
|
|
103
110
|
## After submitting
|
|
104
111
|
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
> Carried from `opengame-performance` 1.1.
|
|
1
|
+
> Carried from `opengame-performance` 1.1.2. Read it when: Keep a browser game smooth on an ordinary laptop and a shared GPU, with three.js and WebGPU specifics. Covers frame-time tails counted from frames the engine ran, bare timing runs, cost over frame rate, frame pacing by what lands, draw calls per pass, a fixed light set and warm-up, uploads that never stall, the world lowered before the gameplay layer, and whole-tab memory. Use when the game stutters, hitches, drops frames, swings between rates, has a slow menu or a mouse that feels slow.
|
|
2
2
|
|
|
3
3
|
|
|
4
4
|
# Performance
|
|
@@ -20,8 +20,8 @@ upload ring) are in [references/webgpu.md](references/webgpu.md).
|
|
|
20
20
|
|
|
21
21
|
## Measure the running game
|
|
22
22
|
|
|
23
|
-
|
|
24
|
-
|
|
23
|
+
`opengame setup` installs `opengame-verification`; to add it to one project, run
|
|
24
|
+
`opengame skills add . --skill opengame-verification`. Use its `opengame-verification/helpers/browser-evidence.mjs` for frame-time samples and input evidence.
|
|
25
25
|
Set a frame-time tolerance from the target hardware's measured baseline. Record the
|
|
26
26
|
CPU throttle and soak duration alongside the result. Compare the same scene and
|
|
27
27
|
player route before and after a change. Inspect memory separately when diagnosing a
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
> Carried from `opengame-router` 1.0.
|
|
1
|
+
> Carried from `opengame-router` 1.0.9. Read it when: Build, test and submit a browser game on OpenGame. Routes game work to the deploy guide, whole-game review and relevant craft skills. Use when someone asks to make a game, improve a game, check it, deploy it or enter an OpenGame jam.
|
|
2
2
|
|
|
3
3
|
|
|
4
4
|
# Work on an OpenGame game
|
|
@@ -11,13 +11,15 @@ That is not a fault in the game.
|
|
|
11
11
|
Read [the working process](references/process.md) before changing the game. Keep the
|
|
12
12
|
user's scope and budget. Read only the specialists that apply to the next change.
|
|
13
13
|
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
`opengame
|
|
14
|
+
`opengame setup` installs every OpenGame skill for the agents on the machine, and the CLI
|
|
15
|
+
keeps them current. `opengame skills add .` installs a starting set into one project: this
|
|
16
|
+
router, `opengame-deploy` and `opengame-quality-bar`. Run `opengame skills list --json` to
|
|
17
|
+
see the installed CLI's catalog, and add a specialist to the project with
|
|
18
|
+
`opengame skills add . --skill <name>`.
|
|
17
19
|
|
|
18
20
|
| Work | Skill |
|
|
19
21
|
| --- | --- |
|
|
20
|
-
| Check, deploy, private preview,
|
|
22
|
+
| Check, deploy, private preview, publish | `opengame-deploy` |
|
|
21
23
|
| A CLI command, its output or its exit code | `opengame-cli` |
|
|
22
24
|
| Calling the API from your own tool or CI | `opengame-api` |
|
|
23
25
|
| Review the whole game | `opengame-quality-bar` |
|
|
@@ -6,8 +6,11 @@ ownership before editing. Use the host's permissions and available tools.
|
|
|
6
6
|
|
|
7
7
|
Choose the smallest change that completes the request. Ask for missing information
|
|
8
8
|
only when it changes what can be done safely or correctly. Keep publication and
|
|
9
|
-
account actions within the user's authorization. A deploy is a private
|
|
10
|
-
|
|
9
|
+
account actions within the user's authorization. A deploy of a new game is a private
|
|
10
|
+
preview, and publishing it needs the user's approval. An update of a game that is already
|
|
11
|
+
live publishes by itself once it passes review when the token can submit, as the
|
|
12
|
+
`opengame login` token can, so deploy one only when the user wants players to get it, or
|
|
13
|
+
follow `opengame-deploy` to deploy it as a preview.
|
|
11
14
|
|
|
12
15
|
Use the user's time, spend and reporting limits. Set a bounded checkpoint before
|
|
13
16
|
starting uncertain research or a paid call. Stop at that checkpoint and report the
|
|
@@ -1,5 +1,9 @@
|
|
|
1
1
|
# opengame-api changelog
|
|
2
2
|
|
|
3
|
+
## 1.0.8
|
|
4
|
+
|
|
5
|
+
A release that passed review is published with `POST /api/v1/submissions/{id}/publish`, as well as on the deploy's page, and an update of a live game publishes by itself (16 Nov 2026).
|
|
6
|
+
|
|
3
7
|
## 1.0.7
|
|
4
8
|
|
|
5
9
|
Deploying without the CLI starts from `GET /api/v1/bootstrap` and its capabilities. An archive over 500 MiB goes in parts (`"multipart": true` and `/api/v1/operations/{id}/upload/parts`) or is refused with 413 `bundle_limit`, and a file-by-file deploy (`/api/v1/deploys/files`) sends only the files OpenGame does not already hold. Names the daily deploy allowance, 5 in any rolling 24 hours (`deploy_day_limited`), beside the hourly one. A ready deploy goes to review by itself.
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
name: opengame-api
|
|
3
3
|
description: Call the OpenGame creator API directly over HTTPS. Covers the base URL, creator tokens and scopes, the OpenAPI document, the error shape and retry fields, deploying without the CLI, and checking whether OpenGame is open. Use when the person wants to deploy from their own tool or CI without the CLI, asks about the OpenGame REST API, api/v1, openapi.json or a creator token, or an API call returned an error code you need to read.
|
|
4
4
|
metadata:
|
|
5
|
-
version: "1.0.
|
|
5
|
+
version: "1.0.8"
|
|
6
6
|
---
|
|
7
7
|
|
|
8
8
|
# Call the OpenGame creator API
|
|
@@ -77,8 +77,9 @@ pack the missing ones, and `POST /api/v1/operations/{id}/files/complete` assembl
|
|
|
77
77
|
build and queues the checks. The request bodies are in `openapi.json`.
|
|
78
78
|
|
|
79
79
|
Reuse one `Idempotency-Key` for every retry of the same deploy; a new key starts a new
|
|
80
|
-
operation. A ready deploy goes to review by itself,
|
|
81
|
-
on the deploy's page
|
|
80
|
+
operation. A ready deploy goes to review by itself. Once it passes, the creator confirms its
|
|
81
|
+
details on the deploy's page, or `POST /api/v1/submissions/{id}/publish` does with a token
|
|
82
|
+
holding `submit`. An update of a game that is already live publishes by itself.
|
|
82
83
|
|
|
83
84
|
An account may begin 5 deploys in any rolling 24
|
|
84
85
|
hours (429 `deploy_day_limited`), and has an hourly allowance too (429
|
|
@@ -1,5 +1,17 @@
|
|
|
1
1
|
# opengame-cli changelog
|
|
2
2
|
|
|
3
|
+
## 1.9.2
|
|
4
|
+
|
|
5
|
+
`opengame jam withdraw` and `reenter` need a token with `submit` alone. The exit table has 7 (`not_launched`). `init` writes Auto for the fields it is not given, and `setup` keeps the skills current until `--no-skills` or `OPENGAME_SKILLS_AUTO=0` stops it. (17 Nov 2026)
|
|
6
|
+
|
|
7
|
+
## 1.9.1
|
|
8
|
+
|
|
9
|
+
The install is two lines: `npm i -g @opengamehq/cli`, then `opengame setup`, which installs every OpenGame skill in each coding agent's home folder. Later commands keep them current with the CLI; `opengame setup --no-skills` stops that. `opengame skills add` is for committing the skills with one project.
|
|
10
|
+
|
|
11
|
+
## 1.9.0
|
|
12
|
+
|
|
13
|
+
`opengame publish` publishes a release that passed review from the terminal, with the jam's answers as flags, and `opengame deploy --publish` waits for review and publishes in one command. An update of a live game publishes by itself (16 Nov 2026).
|
|
14
|
+
|
|
3
15
|
## 1.8.4
|
|
4
16
|
|
|
5
17
|
`opengame submit` is for a release that is not in review yet. A ready deploy goes to review by itself, and the person confirms the details and enters the jam on the deploy's page; jam flags given for a release already in review are not used (`jam_answers_unused`).
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
name: opengame-cli
|
|
3
3
|
description: Drive the OpenGame command line tool from an agent. Covers installing it, signing in with the person, every command, JSON and JSONL output, exit codes, findings and how to retry. Use when the person mentions the opengame command, the OpenGame CLI, installing @opengamehq/cli, opengame login, check, dev, deploy, status, submit, releases, rollback, unpublish, restore, delete, details, achievements, handle, jam or token, or a command exited with an error you need to read.
|
|
4
4
|
metadata:
|
|
5
|
-
version: "1.
|
|
5
|
+
version: "1.9.2"
|
|
6
6
|
---
|
|
7
7
|
|
|
8
8
|
# Use the OpenGame CLI
|
|
@@ -20,6 +20,7 @@ for the tool itself.
|
|
|
20
20
|
|
|
21
21
|
```bash
|
|
22
22
|
npm i -g @opengamehq/cli
|
|
23
|
+
opengame setup
|
|
23
24
|
```
|
|
24
25
|
|
|
25
26
|
Once `opengame` is installed, confirm it and read the command reference:
|
|
@@ -62,15 +63,16 @@ token in a command argument, a file in the project, a log or a reply.
|
|
|
62
63
|
|
|
63
64
|
| Command | What it does |
|
|
64
65
|
| --- | --- |
|
|
65
|
-
| `opengame init [dir]` | Create opengame.json for an existing game.
|
|
66
|
+
| `opengame init [dir]` | Create opengame.json for an existing game. Every field it is not given is `auto`: review writes it from the game, and the creator accepts or changes it on the deploy's page or with `opengame publish`. Asks a person only the game's name. |
|
|
66
67
|
| `opengame check [dir]` | Find local build and asset problems before uploading. |
|
|
67
68
|
| `opengame dev [dir]` | Serve a local export with the game runtime's headers. |
|
|
68
69
|
| `opengame login` | Sign in through the browser. |
|
|
69
|
-
| `opengame deploy [dir]` | Build, check and upload a release to a private preview. |
|
|
70
|
+
| `opengame deploy [dir]` | Build, check and upload a release to a private preview. `--publish` also waits for review and publishes it when it passes. |
|
|
70
71
|
| `opengame status [dir]` | Show the latest deploy for this folder, with its findings. |
|
|
71
72
|
| `opengame deployments [dir]` | List the linked game's deploys, newest first. |
|
|
72
73
|
| `opengame open [dir]` | Open the linked game's private page. |
|
|
73
|
-
| `opengame submit [dir]` | Send a release to review that is not there yet. A ready deploy goes to review by itself
|
|
74
|
+
| `opengame submit [dir]` | Send a release to review that is not there yet. A ready deploy goes to review by itself; for a release already in review, jam flags are not used (`jam_answers_unused`), so pass them to `opengame publish`. |
|
|
75
|
+
| `opengame publish [dir]` | Publish the release that passed review, as Confirm and publish does on the deploy's page: the details review wrote, or the ones given as flags, and the jam's track and models (`--track`, `--models`). Follows it until it is live and prints the address. `--wait` waits for review first. An update of a live game publishes by itself. |
|
|
74
76
|
| `opengame jams [slug]` | List open jams, or show one jam's tracks and flags. |
|
|
75
77
|
| `opengame jam <withdraw\|reenter>` | Withdraw the linked game's jam entry, or put a withdrawn one back. |
|
|
76
78
|
| `opengame releases [dir]` | List the linked game's releases: which is live, which were live before, and which can be made live again. |
|
|
@@ -90,7 +92,8 @@ token in a command argument, a file in the project, a log or a reply.
|
|
|
90
92
|
| `opengame logout` | Revoke this device's token and remove it. |
|
|
91
93
|
| `opengame limits` | Show bundle limits and the account's remaining allowance. |
|
|
92
94
|
| `opengame vendor [dir]` | Make a separate export with dependencies downloaded and pinned. |
|
|
93
|
-
| `opengame
|
|
95
|
+
| `opengame setup` | Install every OpenGame skill for the coding agents on this machine, and keep them current with the CLI. Other commands do the same on first run and after an update; `--no-skills` stops it for good, `OPENGAME_SKILLS_AUTO=0` for one run, and CI never gets it. |
|
|
96
|
+
| `opengame skills add or list` | Install the OpenGame skills into one project, to commit them with the game. |
|
|
94
97
|
| `opengame upgrade` | Install the current CLI, or print the line that does. |
|
|
95
98
|
| `opengame version` | Print the CLI version. |
|
|
96
99
|
|
|
@@ -149,7 +152,7 @@ back on. Retiring needs `deploy` and `submit`, which `opengame login` gives.
|
|
|
149
152
|
`opengame jam withdraw --yes --json` takes the linked game's entry out of the jam and frees
|
|
150
153
|
its place; the entry, its build and its certifications are kept. Run it only when the person
|
|
151
154
|
asks. `opengame jam reenter --json` puts the newest withdrawn entry back while the jam is
|
|
152
|
-
open, with the same reference and build. Both need `
|
|
155
|
+
open, with the same reference and build. Both need `submit`, which `opengame login` gives.
|
|
153
156
|
`at_entry_limit` means every place is taken: ask the person which entry to withdraw first.
|
|
154
157
|
`reenter_closed` means the jam is not taking entries; wait for it to open, and do not
|
|
155
158
|
re-enter after it closes. `jam_entry_taken` means a newer entry of the game is already in.
|
|
@@ -175,9 +178,9 @@ helps, `retry`, `retryAfterSeconds` and `next`, the command to run next.
|
|
|
175
178
|
| 4 | `rateLimited` | An allowance is used. Wait `retryAfterSeconds`, then run the same command. |
|
|
176
179
|
| 5 | `server` | Our side or the network; the game is fine. Follow `retry`. |
|
|
177
180
|
| 6 | `upgrade` | This CLI is too old. Run `opengame upgrade --json`. |
|
|
181
|
+
| 7 | `notLaunched` | OpenGame is not open to creators yet, and the error's code is `not_launched`. Run `opengame login`, then the same command again. |
|
|
178
182
|
|
|
179
|
-
|
|
180
|
-
error's `code` rather than the number wherever you can.
|
|
183
|
+
Branch on the error's `code` rather than the number wherever you can.
|
|
181
184
|
|
|
182
185
|
## Act on findings
|
|
183
186
|
|
|
@@ -1,5 +1,17 @@
|
|
|
1
1
|
# opengame-deploy changelog
|
|
2
2
|
|
|
3
|
+
## 1.1.9
|
|
4
|
+
|
|
5
|
+
`opengame.json` takes `auto` for the title, tagline, description, genre and controls, which review writes. The JSON reference tells `--json` (one object) from `--jsonl` (one event a line), lists the stages the CLI emits, and shows `platform-engine` as a notice. The procedure says what each review state means, `approved`, `blocked`, `withdrawn` and `superseded` included, and keeps `releaseId` for `opengame publish --release`. (17 Nov 2026)
|
|
6
|
+
|
|
7
|
+
## 1.1.8
|
|
8
|
+
|
|
9
|
+
Install runs `opengame setup` after the CLI, which gives every agent on the machine the OpenGame skills and keeps them current. `opengame skills add .` stays for a project that commits its skills.
|
|
10
|
+
|
|
11
|
+
## 1.1.7
|
|
12
|
+
|
|
13
|
+
An agent publishes with `opengame publish` or `opengame deploy --publish` when the creator asks, and otherwise gives them the deploy's page. An update of a live game publishes by itself, keeping its details and jam entry (16 Nov 2026).
|
|
14
|
+
|
|
3
15
|
## 1.1.6
|
|
4
16
|
|
|
5
17
|
The creator no longer certifies anything on the deploy's page: entering the jam is the track and the models, then publish (16 Nov 2026).
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
name: opengame-deploy
|
|
3
3
|
description: Put a browser game online with OpenGame, the marketplace and game jam for browser games. Packages the game, checks it locally, uploads it to a private preview only the owner can play, reads and fixes findings, then hands the creator the page where they confirm the details after review. Use when the person says deploy my game, put it online, host it, share it, upload it, publish it, get me a link, make it playable for friends, or asks where to put a browser game or a Three.js game.
|
|
4
4
|
metadata:
|
|
5
|
-
version: "1.1.
|
|
5
|
+
version: "1.1.9"
|
|
6
6
|
---
|
|
7
7
|
|
|
8
8
|
# Deploy a browser game to OpenGame
|
|
@@ -14,12 +14,13 @@ Nothing is wrong with the game or the install: ask the person to run `opengame l
|
|
|
14
14
|
run the command again. Do not reinstall or work around it.
|
|
15
15
|
|
|
16
16
|
<!-- generated:procedure -->
|
|
17
|
-
Deploy the creator's game to a private preview and give them its link. Review starts automatically,
|
|
17
|
+
Deploy the creator's game to a private preview and give them its link. Review starts automatically. When it passes, publish the game with `opengame publish` if the creator asked you to, or give them the deploy's page to publish it themselves. Read each command's result before you run the next one.
|
|
18
18
|
|
|
19
19
|
## Install
|
|
20
20
|
|
|
21
21
|
```bash
|
|
22
22
|
npm i -g @opengamehq/cli
|
|
23
|
+
opengame setup
|
|
23
24
|
```
|
|
24
25
|
|
|
25
26
|
Once `opengame` is installed, confirm it and read the command reference:
|
|
@@ -31,7 +32,9 @@ opengame help --json
|
|
|
31
32
|
|
|
32
33
|
`help --json` lists every command, flag, exit code, environment variable and event, with the finding schema. Read it rather than guessing a flag.
|
|
33
34
|
|
|
34
|
-
|
|
35
|
+
`opengame setup` installs every OpenGame skill in the home folder of each coding agent it finds (Claude Code, Codex, Cursor and OpenCode), and later commands keep them current. If your session started before that, read `opengame-router/SKILL.md` in the folder it names.
|
|
36
|
+
|
|
37
|
+
To commit the skills with the game instead:
|
|
35
38
|
|
|
36
39
|
```bash
|
|
37
40
|
opengame skills add .
|
|
@@ -109,7 +112,7 @@ opengame init . --title "My game" --json
|
|
|
109
112
|
opengame init . --title "Doom but blue" --kind mod --based-on "Doom" --json
|
|
110
113
|
```
|
|
111
114
|
|
|
112
|
-
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, leave them out. Every field defaults to Auto: review writes the description and the genre from the game, and the creator accepts or changes them on the deploy's page, where they also enter the jam. After the deploy you can set the description yourself with `opengame details --description "..." --json`. If the file already exists,
|
|
115
|
+
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, leave them out. Every field defaults to Auto: review writes the description and the genre from the game, and the creator accepts or changes them on the deploy's page, where they also enter the jam. A title or description you pass is offered back with its casing and grammar tidied, and `opengame publish --keep-words` keeps it as written. After the deploy you can set the description yourself with `opengame details --description "..." --json`. If the file already exists, `init` fills in only the fields it leaves blank; edit the file to change the rest.
|
|
113
116
|
|
|
114
117
|
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:
|
|
115
118
|
|
|
@@ -132,7 +135,7 @@ opengame deploy . --json
|
|
|
132
135
|
| `data.deploymentUrl` | The deploy's page. Give it to the creator straight away: it shows each check and plays the preview once they pass. |
|
|
133
136
|
| `data.state` | `uploading`, `queued`, `checking`, `ready`, `failed` or `expired`. |
|
|
134
137
|
| `data.done` | `true` once the server has finished. |
|
|
135
|
-
| `data.releaseId` | The release. Keep it
|
|
138
|
+
| `data.releaseId` | The release. Keep it: `opengame publish --release` takes it. |
|
|
136
139
|
| `data.previewUrl` | The private preview link, once `state` is `ready`. It can be `null` on a ready release the server will not play; the deploy's page says why. |
|
|
137
140
|
| `data.gameOrigin` | The origin the published game runs at, such as `https://k3v9q2m7x4ab.opengame.gg`. Give it to the creator when the game talks to their own servers. `null` when the server sent none, or sent one this CLI cannot read. |
|
|
138
141
|
|
|
@@ -174,13 +177,18 @@ An account can begin 5 deploys in a rolling day, so fix what `opengame check` fi
|
|
|
174
177
|
|
|
175
178
|
Review starts automatically once a deploy is ready, so you submit no release. Review is automatic: it plays the game, then passes it or returns it with findings.
|
|
176
179
|
|
|
177
|
-
When review passes,
|
|
180
|
+
When review passes, a game's first release waits to be published. `opengame status --json` shows `data.review.state: "awaiting_details"`, `data.review.next: "opengame publish"` and the deploy's page in `data.review.url`.
|
|
181
|
+
|
|
182
|
+
- **The creator asked you to publish it.** Run `opengame publish --json`. It confirms the title, description and genre review wrote, publishes, waits until the game is live and prints the address to share in `data.url`. Change what review wrote with `--description`, `--genre` and the other flags in `opengame publish --help`. While a new game or an update goes on OpenGame only as a jam entry, pass the jam's track and the models used with `--track` and `--models`; `opengame jams <slug> --json` lists them.
|
|
183
|
+
- **They did not ask.** Give them `data.review.url`. Signed in, they check the details, enter the jam and publish on that page.
|
|
184
|
+
|
|
185
|
+
To publish in one step, `opengame deploy --publish --json` stays until review passes, then publishes, and takes the same jam flags.
|
|
178
186
|
|
|
179
|
-
An update to a game that is already live
|
|
187
|
+
An update to a game that is already live publishes by itself once it passes review. It keeps the live game's details, including the genre when the deploy left it to Auto, and its jam entry. The token that deployed it has to hold `submit`, as the `opengame login` token does. When the creator asked only for a preview of an update to a live game, deploy with a token made in their settings with `deploy` alone, set as `OPENGAME_TOKEN`, so the release waits for them.
|
|
180
188
|
|
|
181
|
-
`opengame submit`
|
|
189
|
+
`opengame submit` does not confirm a release that is already in review. The server keeps that submission, and the CLI prints a `jam_answers_unused` notice: the jam answers you passed were not used. Pass them to `opengame publish` once review passes.
|
|
182
190
|
|
|
183
|
-
While Game Jam #1 runs, a new game goes on OpenGame only as a jam entry, up to 2 for each account. Mods and decomps publish outside the jam at any time and never enter it. When the jam cannot take a build, for example because the account already has 2 entries, the build is not sent to review, and the deploy's page explains why. [Enter a jam](https://docs.opengame.io/guides/jams) has the rules.
|
|
191
|
+
While Game Jam #1 runs, a new game or an update goes on OpenGame only as a jam entry, up to 2 for each account. Mods and decomps publish outside the jam at any time and never enter it. When the jam cannot take a build, for example because the account already has 2 entries, the build is not sent to review, and the deploy's page explains why. [Enter a jam](https://docs.opengame.io/guides/jams) has the rules.
|
|
184
192
|
|
|
185
193
|
Follow the release to the end:
|
|
186
194
|
|
|
@@ -191,9 +199,14 @@ opengame status --watch --json
|
|
|
191
199
|
| `data.review.state` | What to do |
|
|
192
200
|
| --- | --- |
|
|
193
201
|
| `review`, `playtesting`, `waiting` | Review is running. Watch again. |
|
|
194
|
-
| `
|
|
195
|
-
| `
|
|
196
|
-
| `
|
|
202
|
+
| `approved` | Review passed. When `data.review.next` is `opengame publish`, do as for `awaiting_details`; otherwise watch again. |
|
|
203
|
+
| `awaiting_details` | Run `opengame publish --json` when the creator asked you to publish. Otherwise give them `data.review.url`, and watch again once they say they have published. |
|
|
204
|
+
| `needs_certification` | Give the creator `data.review.url`. Watch again once they say they have done it. |
|
|
205
|
+
| `publishing`, `published` | The game is going live. Once it is, `data.submission.live.url` is the address to share. |
|
|
206
|
+
| `returned` | Read the findings and run `data.review.next`. Usually that means fix the game and deploy again, and the new deploy is reviewed automatically. A jam entry returned for a fault on our side gets `opengame submit --release <id>` instead: the game needs no change, and the command names any jam answer it still needs. |
|
|
207
|
+
| `blocked` | Review refused the game. Give the creator `data.review.message`. |
|
|
208
|
+
| `withdrawn` | The creator withdrew this submission. Nothing more happens to it unless they ask you to enter it again. |
|
|
209
|
+
| `superseded` | Another submission took its place, and `data.submission.replacedBy` names it. Run `opengame status --json` again to follow that one. |
|
|
197
210
|
|
|
198
211
|
## What a game may do
|
|
199
212
|
|
|
@@ -1,11 +1,13 @@
|
|
|
1
1
|
# Reading the CLI's JSON
|
|
2
2
|
|
|
3
|
-
With `--
|
|
4
|
-
last line, and the last line is always a `result` or an `error`.
|
|
3
|
+
With `--jsonl` every line of output is one JSON object. Four kinds can appear before the
|
|
4
|
+
last line, and the last line is always a `result` or an `error`. With `--json`, the default
|
|
5
|
+
in an agent, the command prints only that last object, carrying the same findings and
|
|
6
|
+
notices in its `findings` and `notices` arrays.
|
|
5
7
|
|
|
6
8
|
| `type` | Meaning | What to do |
|
|
7
9
|
| --- | --- | --- |
|
|
8
|
-
| `progress` | A stage started or moved on: `build`, `check`, `upload`, then the server's own stages for the deploy, `
|
|
10
|
+
| `progress` | A stage started or moved on: `install`, `build`, `package`, `check`, `upload`, then the server's own stages for the deploy, `review:<state>` while publish or submit follows review, `approval` for a login | Nothing; it is a heartbeat |
|
|
9
11
|
| `notice` | Something the person should know: excluded files, kept website metadata, a resumed upload, a sign-in URL | Read `code` and `message`; pass sign-in and kept-metadata notices on |
|
|
10
12
|
| `finding` | One problem in the game or one check that could not decide | Fix or report it, by its `fault`, `certainty` and `retry` |
|
|
11
13
|
| `result` | The command finished; `data` holds its answer | Read `data` |
|
|
@@ -28,22 +30,21 @@ last line, and the last line is always a `result` or an `error`.
|
|
|
28
30
|
|
|
29
31
|
A game whose `index.html` loads `./Game.js` while the file on disk is `game.js`. It runs
|
|
30
32
|
on the creator's Mac, because the Mac's file system ignores case, and is a missing file for every
|
|
31
|
-
player. `opengame check . --
|
|
33
|
+
player. `opengame check . --jsonl` prints:
|
|
32
34
|
|
|
33
35
|
```json
|
|
34
36
|
{"type":"finding","finding":{"release":null,"check":"case-mismatch","checkVersion":"packaging@1","state":"failed","certainty":"certain","fault":"game","evidence":{"observed":"index.html line 1 asks for Game.js, but the file is game.js.","file":"index.html:1"},"fix":"macOS and Windows do not care about capitalisation. The servers that hand your game to a player do. So this loads on your machine and the file is missing for everybody else. Fix the reference or rename the file so the two match exactly.","verify":"opengame check, then opengame deploy","retry":"after-fix"}}
|
|
35
|
-
{"type":"
|
|
37
|
+
{"type":"notice","code":"platform-engine","message":"Browser compatibility needs a playtest. Custom browser export: custom code. Static browser exports from any engine, or none, go to review, where a playtest checks that this one runs. Every game must pass the same runtime and safety checks before publication."}
|
|
36
38
|
{"type":"error","code":"check_failed","message":"This build has blockers. Fix them, then run opengame check again.","exitCode":1,"retry":"after-fix"}
|
|
37
39
|
```
|
|
38
40
|
|
|
39
41
|
Reading it:
|
|
40
42
|
|
|
41
|
-
1. The
|
|
43
|
+
1. The finding is `failed`, `certain` and `fault: "game"`, so it is the game's to
|
|
42
44
|
fix. `evidence.file` says `index.html:1`. Change `./Game.js` to `./game.js` there
|
|
43
45
|
(or rename the file), then run what `verify` says.
|
|
44
|
-
2. The
|
|
45
|
-
|
|
46
|
-
it go away; the playtest in review checks that the game runs.
|
|
46
|
+
2. The `platform-engine` line is a notice, not a finding. It blocks nothing. Do not add a
|
|
47
|
+
fake engine import to change it; the playtest in review checks that the game runs.
|
|
47
48
|
3. After the fix, `opengame check . --json` ends in a `result` and exits 0.
|
|
48
49
|
|
|
49
50
|
## Findings that are ours
|
|
@@ -58,6 +59,6 @@ exists to prevent.
|
|
|
58
59
|
|
|
59
60
|
- `deploy`: `operationId`, `state` (`uploading`, `queued`, `checking`, `ready`,
|
|
60
61
|
`failed`, `expired`), `gameId`, `releaseId`, `url`, and `timingsMs` when it finished.
|
|
61
|
-
Keep `releaseId`:
|
|
62
|
+
Keep `releaseId`: `opengame publish --release` and `opengame submit --release` name it.
|
|
62
63
|
- `check`: `files`, `bytes`, `excluded` and `findings`.
|
|
63
64
|
- `whoami`: the signed-in handle and the token's scopes.
|
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
The game's manifest, committed with its code. `opengame init` writes it; the website
|
|
4
4
|
edits the same fields. The game's id is never in this file: it lives in
|
|
5
5
|
`.opengame/project.json`, which is git-ignored, so a fork never deploys over somebody
|
|
6
|
-
else's game. Jam answers (track,
|
|
6
|
+
else's game. Jam answers (track, models, sponsors) are never stored here either, because
|
|
7
7
|
they belong to one entry, not to the game.
|
|
8
8
|
|
|
9
9
|
```json
|
|
@@ -21,16 +21,16 @@ they belong to one entry, not to the game.
|
|
|
21
21
|
|
|
22
22
|
| Field | Rule |
|
|
23
23
|
| --- | --- |
|
|
24
|
-
| `title` | 3 to 40 characters |
|
|
25
|
-
| `tagline` | Optional, up to 140 characters |
|
|
26
|
-
| `description` | 40 to 500 characters
|
|
27
|
-
| `genre` | Exactly one slug from the table below |
|
|
24
|
+
| `title` | 3 to 40 characters, or `auto` |
|
|
25
|
+
| `tagline` | Optional, up to 140 characters, or `auto` |
|
|
26
|
+
| `description` | 40 to 500 characters, or `auto`. Say what the player does |
|
|
27
|
+
| `genre` | Exactly one slug from the table below, or `auto` |
|
|
28
28
|
| `kind` | Optional. One of the four kinds below; leaving it out means `game`. `opengame init` always writes it |
|
|
29
29
|
| `basedOn` | The name of the game a `decomp` or a `mod` is made from, up to 60 characters, shown as "Mod of Doom". Required for a `decomp` or a `mod`, and not allowed for a `game` or a `world` |
|
|
30
30
|
| `build.command` | Optional, up to 1,000 characters. Run before checking; may read environment variables but must not contain a secret |
|
|
31
31
|
| `build.output` | The folder holding `index.html` after the build, or `.` |
|
|
32
32
|
| `cover` | Not used. OpenGame makes the cover after approval. A file that still names one passes `check`, and the CLI does not upload it; leave the field out |
|
|
33
|
-
| `controls` | One or more of `keyboard`, `mouse`, `gamepad`, each once |
|
|
33
|
+
| `controls` | One or more of `keyboard`, `mouse`, `gamepad`, each once, or `auto` |
|
|
34
34
|
| `requires` | Optional. `threads: true` for a build that cannot start without them, `renderer` (`webgl`, `webgl2` or `webgpu`), `desktopOnly`, `gamepad`. The game page lists them, and a browser that cannot run threads is told so instead of getting a black frame |
|
|
35
35
|
| `leaderboards` | Up to 25 boards: `key` (lowercase, starts with a letter, up to 48 characters), `order` (`asc` or `desc`), `label` (up to 60 characters), optional `min` and `max` |
|
|
36
36
|
| `achievements` | Up to 100: `id` (lowercase letters, digits, `-` and `_`, up to 48 characters), `title`, optional `description`. A deploy saves them when its preview is ready |
|
|
@@ -72,11 +72,17 @@ it plays.
|
|
|
72
72
|
`opengame init --kind mod --based-on "Doom"` writes both. Without `--kind`, init makes a
|
|
73
73
|
game; it asks a person nothing but the game's name.
|
|
74
74
|
|
|
75
|
-
|
|
76
|
-
|
|
77
|
-
|
|
78
|
-
|
|
79
|
-
|
|
75
|
+
## Auto
|
|
76
|
+
|
|
77
|
+
`title`, `tagline`, `description`, `genre` and `controls` take `"auto"`, and a field that is
|
|
78
|
+
blank or left out means the same. `opengame init` writes `"auto"` for every one of them it is
|
|
79
|
+
not given. Review writes an Auto field from the game itself, and the creator accepts or
|
|
80
|
+
changes what it wrote on the deploy's page before anything publishes; the subgenre is always
|
|
81
|
+
review's. Do not ask the creator for a description or a genre before deploying. Once review
|
|
82
|
+
passes, `opengame publish --description` and `--genre` answer from here instead, and
|
|
83
|
+
`opengame details --description` changes the words once the game exists. A title or
|
|
84
|
+
description the creator typed is theirs: review offers a tidied copy on a first publish, and
|
|
85
|
+
`opengame publish --keep-words` keeps theirs.
|
|
80
86
|
|
|
81
87
|
## Who owns which value
|
|
82
88
|
|
|
@@ -103,8 +103,9 @@ No person reviews a game. Once these pass, review plays it and decides by itself
|
|
|
103
103
|
game goes on to be published, or back to the creator with the reason. It goes back when the
|
|
104
104
|
build fails packaging, when its review cost more than any game should need (make it smaller
|
|
105
105
|
or simpler), or when a confident verdict reads it as not a real game, as made for a phone
|
|
106
|
-
held upright, or as not running on a supported web runtime.
|
|
107
|
-
|
|
106
|
+
held upright, or as not running on a supported web runtime. A game's first release then
|
|
107
|
+
waits for its creator to confirm the details, on the deploy's page or with `opengame
|
|
108
|
+
publish`; an update of a live game publishes by itself.
|
|
108
109
|
|
|
109
110
|
Thresholds that warn rather than refuse: an initial download over
|
|
110
111
|
50 MiB before the first playable frame, time to
|
|
@@ -1,5 +1,13 @@
|
|
|
1
1
|
# opengame-jam changelog
|
|
2
2
|
|
|
3
|
+
## 1.1.1
|
|
4
|
+
|
|
5
|
+
Ask for the account email the person used at each sponsor, which `--sponsor-email` takes, not sponsor evidence. (17 Nov 2026)
|
|
6
|
+
|
|
7
|
+
## 1.1.0
|
|
8
|
+
|
|
9
|
+
The entry is made with `opengame publish --track ... --models ...` when the person asks, or on the deploy's page. Nobody certifies anything to enter (16 Nov 2026).
|
|
10
|
+
|
|
3
11
|
## 1.0.9
|
|
4
12
|
|
|
5
13
|
No person reviews a game: review starts by itself once a deploy is ready, then either lets it through or returns it with the reason. The person enters the jam on the deploy's page (Confirm details: the track, the models, any sponsor track, then certify), and `opengame submit` is no longer the way in, since it cannot confirm a release its deploy already sent to review. While the jam runs, a new original game goes on OpenGame only as a jam entry, up to the account's allowance, unless the account is an admin or an approved publisher; mods and decomps go on under Just for fun at any time; after the close anyone can publish to the gallery. A sponsor track asks for the email of the account used there, not an evidence note. After the close an entered game keeps the version that was live then.
|
|
@@ -1,8 +1,8 @@
|
|
|
1
1
|
---
|
|
2
2
|
name: opengame-jam
|
|
3
|
-
description: Enter a game in an OpenGame jam. Finds the open jams, their tracks and rules, checks the game against them, deploys one exact release, and
|
|
3
|
+
description: Enter a game in an OpenGame jam. Finds the open jams, their tracks and rules, checks the game against them, deploys one exact release, and enters it with the person's own answers, with opengame publish or on the deploy's page. Use when the person says enter the jam, submit to the jam, which track should I pick, am I eligible, what are the jam rules, or mentions the OpenGame Global AI Game Jam.
|
|
4
4
|
metadata:
|
|
5
|
-
version: "1.
|
|
5
|
+
version: "1.1.1"
|
|
6
6
|
---
|
|
7
7
|
|
|
8
8
|
# Enter an OpenGame jam
|
|
@@ -69,8 +69,8 @@ decide. Do not hide a dependency, rewrite history or relabel a library to pass a
|
|
|
69
69
|
|
|
70
70
|
## Pick a track with the person
|
|
71
71
|
|
|
72
|
-
The person
|
|
73
|
-
answer for them.
|
|
72
|
+
The person gives these answers, on the deploy's page or to you for `opengame publish`.
|
|
73
|
+
Help them prepare the answers; do not answer for them.
|
|
74
74
|
|
|
75
75
|
- **Genre track:** one per entry, required. The page starts on the track that matches the
|
|
76
76
|
game's genre; the person keeps it or chooses another.
|
|
@@ -81,28 +81,35 @@ answer for them.
|
|
|
81
81
|
|
|
82
82
|
`opengame jams <slug> --json` lists the whole form.
|
|
83
83
|
|
|
84
|
-
## Deploy, then
|
|
84
|
+
## Deploy, then enter it
|
|
85
85
|
|
|
86
86
|
Follow `opengame-deploy` for installation, sign-in and the deploy. Use the exact release
|
|
87
87
|
the creator played. Once the deploy is ready, review starts by itself; nobody runs a
|
|
88
88
|
command for it. When `opengame status --json` shows `data.review.state` as
|
|
89
|
-
`awaiting_details`,
|
|
90
|
-
their browser, they press Confirm details, choose the track, the models and any sponsor
|
|
91
|
-
tracks, and certify.
|
|
89
|
+
`awaiting_details`, review has passed, and the entry is made one of two ways:
|
|
92
90
|
|
|
93
|
-
|
|
94
|
-
|
|
91
|
+
- **The person asked you to enter it.** Run `opengame publish` with their answers:
|
|
92
|
+
|
|
93
|
+
```bash
|
|
94
|
+
opengame publish --track <track> --models <model>,<model> \
|
|
95
|
+
--sponsor <sponsor> --sponsor-email <sponsor>=<their email> --json
|
|
96
|
+
```
|
|
97
|
+
|
|
98
|
+
It enters the jam, publishes, waits until the game is live, and prints the address to
|
|
99
|
+
share in `data.url`. `opengame deploy --publish` with the same flags does the deploy,
|
|
100
|
+
the wait for review and the entry in one command.
|
|
101
|
+
- **Otherwise,** give the person `data.review.url`, the deploy's page. Signed in there,
|
|
102
|
+
they press Confirm details, choose the track, the models and any sponsor tracks, and
|
|
103
|
+
publish.
|
|
104
|
+
|
|
105
|
+
Do not run `opengame submit` to enter the jam or to publish. It does not confirm a release
|
|
106
|
+
its deploy already sent to review: it answers with that submission and a
|
|
95
107
|
`jam_answers_unused` notice, and the answers go nowhere.
|
|
96
108
|
|
|
97
109
|
## What only the person can do
|
|
98
110
|
|
|
99
|
-
|
|
100
|
-
|
|
101
|
-
them what it is for. Do not open it for them, click through it, or tell them it is
|
|
102
|
-
done. A later revision of the same entry under the same terms skips it.
|
|
103
|
-
|
|
104
|
-
The person also decides whether they are eligible (age, one account), whether they own
|
|
105
|
-
the assets, which track they want, and what their sponsor evidence claims.
|
|
111
|
+
Nobody certifies or attests to anything to enter. The person decides whether they are eligible (age, one account), whether they own
|
|
112
|
+
the assets, which track they want, and which account they used at each sponsor.
|
|
106
113
|
|
|
107
114
|
## After submitting
|
|
108
115
|
|
|
@@ -1,5 +1,9 @@
|
|
|
1
1
|
# opengame-performance changelog
|
|
2
2
|
|
|
3
|
+
## 1.1.2
|
|
4
|
+
|
|
5
|
+
`opengame setup` already installs `opengame-verification`; `opengame skills add . --skill opengame-verification` adds it to one project. (17 Nov 2026)
|
|
6
|
+
|
|
3
7
|
## 1.1.1
|
|
4
8
|
|
|
5
9
|
`landing-pacer.mjs` lets a frame whose promise rejects leave the queue, so two failed submits no longer hold every later frame; `stats()` counts them as `failed`.
|