@opengamehq/cli 0.9.9 → 0.10.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/AGENTS.md +13 -6
- package/CHANGELOG.md +18 -0
- package/README.md +2 -1
- package/dist/cli.mjs +157 -156
- package/dist/preflight-worker.mjs +1 -1
- package/dist/runtime-builder.mjs +1 -1
- package/dist/skills/manifest.json +24 -24
- package/dist/skills/opengame-all-in-one/SKILL.md +1 -1
- 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 +4 -3
- package/dist/skills/opengame-all-in-one/references/opengame-deploy/README.md +12 -6
- package/dist/skills/opengame-all-in-one/references/opengame-deploy/references/manifest.md +3 -2
- 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 +22 -15
- package/dist/skills/opengame-api/SKILL.md +4 -3
- package/dist/skills/opengame-cli/SKILL.md +4 -3
- package/dist/skills/opengame-deploy/SKILL.md +12 -6
- package/dist/skills/opengame-deploy/references/manifest.md +3 -2
- package/dist/skills/opengame-deploy/references/packaging.md +3 -2
- package/dist/skills/opengame-jam/SKILL.md +23 -16
- package/package.json +1 -1
|
@@ -21,14 +21,14 @@
|
|
|
21
21
|
"family": "platform",
|
|
22
22
|
"default": false,
|
|
23
23
|
"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.",
|
|
24
|
-
"version": "1.0.
|
|
24
|
+
"version": "1.0.8",
|
|
25
25
|
"files": [
|
|
26
26
|
{
|
|
27
27
|
"path": "SKILL.md",
|
|
28
|
-
"sha256": "
|
|
28
|
+
"sha256": "381a55728f10d6473b35da2dc3e09042219af1152db88252e99d796951ec06b3"
|
|
29
29
|
}
|
|
30
30
|
],
|
|
31
|
-
"digest": "
|
|
31
|
+
"digest": "30b820ac15eeae2e703b1bf6d402fdb92bb358b693fbf82cbf086302c6b2b0c5"
|
|
32
32
|
},
|
|
33
33
|
{
|
|
34
34
|
"name": "opengame-assets",
|
|
@@ -127,25 +127,25 @@
|
|
|
127
127
|
"family": "platform",
|
|
128
128
|
"default": false,
|
|
129
129
|
"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.",
|
|
130
|
-
"version": "1.
|
|
130
|
+
"version": "1.9.0",
|
|
131
131
|
"files": [
|
|
132
132
|
{
|
|
133
133
|
"path": "SKILL.md",
|
|
134
|
-
"sha256": "
|
|
134
|
+
"sha256": "5f20dd7788bf40a29b6fe10bc229ce4182d26af1c8eb5ccad6a498528c088dca"
|
|
135
135
|
}
|
|
136
136
|
],
|
|
137
|
-
"digest": "
|
|
137
|
+
"digest": "cd4a9ba6eca74420c85e1606e6e8b0e3bc58105ac8655898febae066a7ec6ebc"
|
|
138
138
|
},
|
|
139
139
|
{
|
|
140
140
|
"name": "opengame-deploy",
|
|
141
141
|
"family": "platform",
|
|
142
142
|
"default": true,
|
|
143
143
|
"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.",
|
|
144
|
-
"version": "1.1.
|
|
144
|
+
"version": "1.1.7",
|
|
145
145
|
"files": [
|
|
146
146
|
{
|
|
147
147
|
"path": "SKILL.md",
|
|
148
|
-
"sha256": "
|
|
148
|
+
"sha256": "0ade71f1875ef3cb07356fb9a0af5c0e41d44ca21115db29f4b6fb9a66bd0cb2"
|
|
149
149
|
},
|
|
150
150
|
{
|
|
151
151
|
"path": "references/json-events.md",
|
|
@@ -153,14 +153,14 @@
|
|
|
153
153
|
},
|
|
154
154
|
{
|
|
155
155
|
"path": "references/manifest.md",
|
|
156
|
-
"sha256": "
|
|
156
|
+
"sha256": "be0db9a6060eb5d87faadb38050ee4f45f4acdca0610276510bddd5ab536ccb1"
|
|
157
157
|
},
|
|
158
158
|
{
|
|
159
159
|
"path": "references/packaging.md",
|
|
160
|
-
"sha256": "
|
|
160
|
+
"sha256": "20fb37b9a8d1bb2ae72e96c233d3df8cd4338e3d32c8ba8d923caf1280738431"
|
|
161
161
|
}
|
|
162
162
|
],
|
|
163
|
-
"digest": "
|
|
163
|
+
"digest": "1c5e008f199dd73c66c9b0649f7cfe61acaa215827f1379fcf0e12cfe597ebf4"
|
|
164
164
|
},
|
|
165
165
|
{
|
|
166
166
|
"name": "opengame-depth",
|
|
@@ -250,15 +250,15 @@
|
|
|
250
250
|
"name": "opengame-jam",
|
|
251
251
|
"family": "platform",
|
|
252
252
|
"default": false,
|
|
253
|
-
"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
|
|
254
|
-
"version": "1.0
|
|
253
|
+
"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.",
|
|
254
|
+
"version": "1.1.0",
|
|
255
255
|
"files": [
|
|
256
256
|
{
|
|
257
257
|
"path": "SKILL.md",
|
|
258
|
-
"sha256": "
|
|
258
|
+
"sha256": "6ad097549016d3fb9304ca420767513eab7f2e66cb38de50ff33ae274a5b972c"
|
|
259
259
|
}
|
|
260
260
|
],
|
|
261
|
-
"digest": "
|
|
261
|
+
"digest": "608fd525cb7730718af19c0953455565243019f11749d38b9cd5fb9e5442c861"
|
|
262
262
|
},
|
|
263
263
|
{
|
|
264
264
|
"name": "opengame-lighting",
|
|
@@ -1067,11 +1067,11 @@
|
|
|
1067
1067
|
"family": "bundle",
|
|
1068
1068
|
"default": false,
|
|
1069
1069
|
"description": "Every OpenGame skill in one install, with the order to use them in, for taking a browser game from an idea to a AAA-feeling release, a trailer and a montage. Carries the platform, craft and video skills whole. Use when someone wants one skill that covers everything, says make it AAA or make it game of the year, starts a big game with agents, or does not know which OpenGame skill to load.",
|
|
1070
|
-
"version": "1.0.
|
|
1070
|
+
"version": "1.0.5",
|
|
1071
1071
|
"files": [
|
|
1072
1072
|
{
|
|
1073
1073
|
"path": "SKILL.md",
|
|
1074
|
-
"sha256": "
|
|
1074
|
+
"sha256": "5b968b882fc254975c98714d04b89bd595dd50ac3723a57e7ab3148d4c204900"
|
|
1075
1075
|
},
|
|
1076
1076
|
{
|
|
1077
1077
|
"path": "references/opengame-accessibility/README.md",
|
|
@@ -1079,7 +1079,7 @@
|
|
|
1079
1079
|
},
|
|
1080
1080
|
{
|
|
1081
1081
|
"path": "references/opengame-api/README.md",
|
|
1082
|
-
"sha256": "
|
|
1082
|
+
"sha256": "876f1cd1126a521472c6ea02bd7370de1a8f8efa7d56e35fe2a28be899c2bef1"
|
|
1083
1083
|
},
|
|
1084
1084
|
{
|
|
1085
1085
|
"path": "references/opengame-assets/README.md",
|
|
@@ -1135,11 +1135,11 @@
|
|
|
1135
1135
|
},
|
|
1136
1136
|
{
|
|
1137
1137
|
"path": "references/opengame-cli/README.md",
|
|
1138
|
-
"sha256": "
|
|
1138
|
+
"sha256": "17e628b9d557212f3652f82bac331a3e586c47a62c363c17e6ff8ba171ac8ae7"
|
|
1139
1139
|
},
|
|
1140
1140
|
{
|
|
1141
1141
|
"path": "references/opengame-deploy/README.md",
|
|
1142
|
-
"sha256": "
|
|
1142
|
+
"sha256": "586a392450665fdcd4583e3bf4899e19f552cbb0789801c8a6de10ab53343ded"
|
|
1143
1143
|
},
|
|
1144
1144
|
{
|
|
1145
1145
|
"path": "references/opengame-deploy/references/json-events.md",
|
|
@@ -1147,11 +1147,11 @@
|
|
|
1147
1147
|
},
|
|
1148
1148
|
{
|
|
1149
1149
|
"path": "references/opengame-deploy/references/manifest.md",
|
|
1150
|
-
"sha256": "
|
|
1150
|
+
"sha256": "be0db9a6060eb5d87faadb38050ee4f45f4acdca0610276510bddd5ab536ccb1"
|
|
1151
1151
|
},
|
|
1152
1152
|
{
|
|
1153
1153
|
"path": "references/opengame-deploy/references/packaging.md",
|
|
1154
|
-
"sha256": "
|
|
1154
|
+
"sha256": "20fb37b9a8d1bb2ae72e96c233d3df8cd4338e3d32c8ba8d923caf1280738431"
|
|
1155
1155
|
},
|
|
1156
1156
|
{
|
|
1157
1157
|
"path": "references/opengame-depth/README.md",
|
|
@@ -1199,7 +1199,7 @@
|
|
|
1199
1199
|
},
|
|
1200
1200
|
{
|
|
1201
1201
|
"path": "references/opengame-jam/README.md",
|
|
1202
|
-
"sha256": "
|
|
1202
|
+
"sha256": "261f313e0fe6dff71d2b889e3ef9d509dfd818539c566169fae31f3bf4c809af"
|
|
1203
1203
|
},
|
|
1204
1204
|
{
|
|
1205
1205
|
"path": "references/opengame-lighting/README.md",
|
|
@@ -1774,7 +1774,7 @@
|
|
|
1774
1774
|
"sha256": "e3cbba13f31a92ae73bc33ccef413276b4c2d98039285d67e393223dc7d2b8e5"
|
|
1775
1775
|
}
|
|
1776
1776
|
],
|
|
1777
|
-
"digest": "
|
|
1777
|
+
"digest": "6b571e68a5727c1758dbcb92a41a6308832a5ca681b47fe169f87a2f87dda822"
|
|
1778
1778
|
}
|
|
1779
1779
|
]
|
|
1780
1780
|
}
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
name: opengame-all-in-one
|
|
3
3
|
description: Every OpenGame skill in one install, with the order to use them in, for taking a browser game from an idea to a AAA-feeling release, a trailer and a montage. Carries the platform, craft and video skills whole. Use when someone wants one skill that covers everything, says make it AAA or make it game of the year, starts a big game with agents, or does not know which OpenGame skill to load.
|
|
4
4
|
metadata:
|
|
5
|
-
version: "1.0.
|
|
5
|
+
version: "1.0.5"
|
|
6
6
|
---
|
|
7
7
|
|
|
8
8
|
# Make a browser game that feels AAA
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
> Carried from `opengame-api` 1.0.
|
|
1
|
+
> Carried from `opengame-api` 1.0.8. Read it when: 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.
|
|
2
2
|
|
|
3
3
|
|
|
4
4
|
# Call the OpenGame creator API
|
|
@@ -73,8 +73,9 @@ pack the missing ones, and `POST /api/v1/operations/{id}/files/complete` assembl
|
|
|
73
73
|
build and queues the checks. The request bodies are in `openapi.json`.
|
|
74
74
|
|
|
75
75
|
Reuse one `Idempotency-Key` for every retry of the same deploy; a new key starts a new
|
|
76
|
-
operation. A ready deploy goes to review by itself,
|
|
77
|
-
on the deploy's page
|
|
76
|
+
operation. A ready deploy goes to review by itself. Once it passes, the creator confirms its
|
|
77
|
+
details on the deploy's page, or `POST /api/v1/submissions/{id}/publish` does with a token
|
|
78
|
+
holding `submit`. An update of a game that is already live publishes by itself.
|
|
78
79
|
|
|
79
80
|
An account may begin 5 deploys in any rolling 24
|
|
80
81
|
hours (429 `deploy_day_limited`), and has an hourly allowance too (429
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
> Carried from `opengame-cli` 1.
|
|
1
|
+
> Carried from `opengame-cli` 1.9.0. Read it when: 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.
|
|
2
2
|
|
|
3
3
|
|
|
4
4
|
# Use the OpenGame CLI
|
|
@@ -62,11 +62,12 @@ token in a command argument, a file in the project, a log or a reply.
|
|
|
62
62
|
| `opengame check [dir]` | Find local build and asset problems before uploading. |
|
|
63
63
|
| `opengame dev [dir]` | Serve a local export with the game runtime's headers. |
|
|
64
64
|
| `opengame login` | Sign in through the browser. |
|
|
65
|
-
| `opengame deploy [dir]` | Build, check and upload a release to a private preview. |
|
|
65
|
+
| `opengame deploy [dir]` | Build, check and upload a release to a private preview. `--publish` also waits for review and publishes it when it passes. |
|
|
66
66
|
| `opengame status [dir]` | Show the latest deploy for this folder, with its findings. |
|
|
67
67
|
| `opengame deployments [dir]` | List the linked game's deploys, newest first. |
|
|
68
68
|
| `opengame open [dir]` | Open the linked game's private page. |
|
|
69
|
-
| `opengame submit [dir]` | Send a release to review that is not there yet. A ready deploy goes to review by itself
|
|
69
|
+
| `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`. |
|
|
70
|
+
| `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. |
|
|
70
71
|
| `opengame jams [slug]` | List open jams, or show one jam's tracks and flags. |
|
|
71
72
|
| `opengame jam <withdraw\|reenter>` | Withdraw the linked game's jam entry, or put a withdrawn one back. |
|
|
72
73
|
| `opengame releases [dir]` | List the linked game's releases: which is live, which were live before, and which can be made live again. |
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
> Carried from `opengame-deploy` 1.1.
|
|
1
|
+
> Carried from `opengame-deploy` 1.1.7. Read it when: 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.
|
|
2
2
|
|
|
3
3
|
|
|
4
4
|
# Deploy a browser game to OpenGame
|
|
@@ -10,7 +10,7 @@ Nothing is wrong with the game or the install: ask the person to run `opengame l
|
|
|
10
10
|
run the command again. Do not reinstall or work around it.
|
|
11
11
|
|
|
12
12
|
<!-- generated:procedure -->
|
|
13
|
-
Deploy the creator's game to a private preview and give them its link. Review starts automatically,
|
|
13
|
+
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.
|
|
14
14
|
|
|
15
15
|
## Install
|
|
16
16
|
|
|
@@ -170,11 +170,16 @@ An account can begin 5 deploys in a rolling day, so fix what `opengame check` fi
|
|
|
170
170
|
|
|
171
171
|
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.
|
|
172
172
|
|
|
173
|
-
When review passes,
|
|
173
|
+
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`.
|
|
174
174
|
|
|
175
|
-
|
|
175
|
+
- **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 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.
|
|
176
|
+
- **They did not ask.** Give them `data.review.url`. Signed in, they check the details, enter the jam and publish on that page.
|
|
176
177
|
|
|
177
|
-
|
|
178
|
+
To publish in one step, `opengame deploy --publish --json` stays until review passes, then publishes, and takes the same jam flags.
|
|
179
|
+
|
|
180
|
+
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.
|
|
181
|
+
|
|
182
|
+
`opengame submit` does not confirm a release that is already in review. The server keeps that submission and prints a `jam_answers_unused` notice: the jam answers you passed were not used. Pass them to `opengame publish` once review passes.
|
|
178
183
|
|
|
179
184
|
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.
|
|
180
185
|
|
|
@@ -187,7 +192,8 @@ opengame status --watch --json
|
|
|
187
192
|
| `data.review.state` | What to do |
|
|
188
193
|
| --- | --- |
|
|
189
194
|
| `review`, `playtesting`, `waiting` | Review is running. Watch again. |
|
|
190
|
-
| `awaiting_details
|
|
195
|
+
| `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. |
|
|
196
|
+
| `needs_certification` | Give the creator `data.review.url`. Watch again once they say they have done it. |
|
|
191
197
|
| `publishing`, `published` | The game is going live. `data.submission.gameUrl` is its page. |
|
|
192
198
|
| `returned` | Read the findings, fix the game and deploy again. The new deploy is reviewed automatically. |
|
|
193
199
|
|
|
@@ -74,8 +74,9 @@ game; it asks a person nothing but the game's name.
|
|
|
74
74
|
|
|
75
75
|
A folder with no description of its own gets a placeholder sentence, which the deploy marks
|
|
76
76
|
provisional, and so does a genre init could not read from the game's words. Do not ask the
|
|
77
|
-
creator for either before deploying: the deploy's page asks them,
|
|
78
|
-
--description`
|
|
77
|
+
creator for either before deploying: the deploy's page asks them, `opengame publish
|
|
78
|
+
--description` answers it from here once review passes, and `opengame details
|
|
79
|
+
--description` sets the description once the game exists. A game cannot publish
|
|
79
80
|
with the placeholder.
|
|
80
81
|
|
|
81
82
|
## Who owns which value
|
|
@@ -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.0.
|
|
1
|
+
> Carried from `opengame-jam` 1.1.0. 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,27 +77,34 @@ 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
|
-
versioned set of terms. When the result asks for it, give the person the link and tell
|
|
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
|
|
107
|
+
Nobody certifies or attests to anything to enter. The person decides whether they are eligible (age, one account), whether they own
|
|
101
108
|
the assets, which track they want, and what their sponsor evidence claims.
|
|
102
109
|
|
|
103
110
|
## After submitting
|
|
@@ -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
|
|
@@ -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.0"
|
|
6
6
|
---
|
|
7
7
|
|
|
8
8
|
# Use the OpenGame CLI
|
|
@@ -66,11 +66,12 @@ token in a command argument, a file in the project, a log or a reply.
|
|
|
66
66
|
| `opengame check [dir]` | Find local build and asset problems before uploading. |
|
|
67
67
|
| `opengame dev [dir]` | Serve a local export with the game runtime's headers. |
|
|
68
68
|
| `opengame login` | Sign in through the browser. |
|
|
69
|
-
| `opengame deploy [dir]` | Build, check and upload a release to a private preview. |
|
|
69
|
+
| `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
70
|
| `opengame status [dir]` | Show the latest deploy for this folder, with its findings. |
|
|
71
71
|
| `opengame deployments [dir]` | List the linked game's deploys, newest first. |
|
|
72
72
|
| `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
|
|
73
|
+
| `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`. |
|
|
74
|
+
| `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
75
|
| `opengame jams [slug]` | List open jams, or show one jam's tracks and flags. |
|
|
75
76
|
| `opengame jam <withdraw\|reenter>` | Withdraw the linked game's jam entry, or put a withdrawn one back. |
|
|
76
77
|
| `opengame releases [dir]` | List the linked game's releases: which is live, which were live before, and which can be made live again. |
|
|
@@ -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.7"
|
|
6
6
|
---
|
|
7
7
|
|
|
8
8
|
# Deploy a browser game to OpenGame
|
|
@@ -14,7 +14,7 @@ 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
|
|
|
@@ -174,11 +174,16 @@ An account can begin 5 deploys in a rolling day, so fix what `opengame check` fi
|
|
|
174
174
|
|
|
175
175
|
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
176
|
|
|
177
|
-
When review passes,
|
|
177
|
+
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`.
|
|
178
178
|
|
|
179
|
-
|
|
179
|
+
- **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 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.
|
|
180
|
+
- **They did not ask.** Give them `data.review.url`. Signed in, they check the details, enter the jam and publish on that page.
|
|
180
181
|
|
|
181
|
-
|
|
182
|
+
To publish in one step, `opengame deploy --publish --json` stays until review passes, then publishes, and takes the same jam flags.
|
|
183
|
+
|
|
184
|
+
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.
|
|
185
|
+
|
|
186
|
+
`opengame submit` does not confirm a release that is already in review. The server keeps that submission and prints a `jam_answers_unused` notice: the jam answers you passed were not used. Pass them to `opengame publish` once review passes.
|
|
182
187
|
|
|
183
188
|
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.
|
|
184
189
|
|
|
@@ -191,7 +196,8 @@ opengame status --watch --json
|
|
|
191
196
|
| `data.review.state` | What to do |
|
|
192
197
|
| --- | --- |
|
|
193
198
|
| `review`, `playtesting`, `waiting` | Review is running. Watch again. |
|
|
194
|
-
| `awaiting_details
|
|
199
|
+
| `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. |
|
|
200
|
+
| `needs_certification` | Give the creator `data.review.url`. Watch again once they say they have done it. |
|
|
195
201
|
| `publishing`, `published` | The game is going live. `data.submission.gameUrl` is its page. |
|
|
196
202
|
| `returned` | Read the findings, fix the game and deploy again. The new deploy is reviewed automatically. |
|
|
197
203
|
|
|
@@ -74,8 +74,9 @@ game; it asks a person nothing but the game's name.
|
|
|
74
74
|
|
|
75
75
|
A folder with no description of its own gets a placeholder sentence, which the deploy marks
|
|
76
76
|
provisional, and so does a genre init could not read from the game's words. Do not ask the
|
|
77
|
-
creator for either before deploying: the deploy's page asks them,
|
|
78
|
-
--description`
|
|
77
|
+
creator for either before deploying: the deploy's page asks them, `opengame publish
|
|
78
|
+
--description` answers it from here once review passes, and `opengame details
|
|
79
|
+
--description` sets the description once the game exists. A game cannot publish
|
|
79
80
|
with the placeholder.
|
|
80
81
|
|
|
81
82
|
## Who owns which value
|
|
@@ -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,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.0
|
|
5
|
+
version: "1.1.0"
|
|
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,27 +81,34 @@ 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
|
-
versioned set of terms. When the result asks for it, give the person the link and tell
|
|
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
|
|
111
|
+
Nobody certifies or attests to anything to enter. The person decides whether they are eligible (age, one account), whether they own
|
|
105
112
|
the assets, which track they want, and what their sponsor evidence claims.
|
|
106
113
|
|
|
107
114
|
## After submitting
|