@opengamehq/cli 0.10.0 → 0.11.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 CHANGED
@@ -9,6 +9,7 @@ Deploy the creator's game to a private preview and give them its link. Review st
9
9
 
10
10
  ```bash
11
11
  npm i -g @opengamehq/cli
12
+ opengame setup
12
13
  ```
13
14
 
14
15
  Once `opengame` is installed, confirm it and read the command reference:
@@ -20,7 +21,9 @@ opengame help --json
20
21
 
21
22
  `help --json` lists every command, flag, exit code, environment variable and event, with the finding schema. Read it rather than guessing a flag.
22
23
 
23
- Install the OpenGame skills for the agent you run in, from the game folder:
24
+ `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.
25
+
26
+ To commit the skills with the game instead:
24
27
 
25
28
  ```bash
26
29
  opengame skills add .
@@ -98,7 +101,7 @@ opengame init . --title "My game" --json
98
101
  opengame init . --title "Doom but blue" --kind mod --based-on "Doom" --json
99
102
  ```
100
103
 
101
- 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, leave `init` alone and edit the file.
104
+ 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.
102
105
 
103
106
  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:
104
107
 
@@ -121,7 +124,7 @@ opengame deploy . --json
121
124
  | `data.deploymentUrl` | The deploy's page. Give it to the creator straight away: it shows each check and plays the preview once they pass. |
122
125
  | `data.state` | `uploading`, `queued`, `checking`, `ready`, `failed` or `expired`. |
123
126
  | `data.done` | `true` once the server has finished. |
124
- | `data.releaseId` | The release. Keep it for `submit`. |
127
+ | `data.releaseId` | The release. Keep it: `opengame publish --release` takes it. |
125
128
  | `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. |
126
129
  | `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. |
127
130
 
@@ -165,16 +168,16 @@ Review starts automatically once a deploy is ready, so you submit no release. Re
165
168
 
166
169
  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`.
167
170
 
168
- - **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.
171
+ - **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.
169
172
  - **They did not ask.** Give them `data.review.url`. Signed in, they check the details, enter the jam and publish on that page.
170
173
 
171
174
  To publish in one step, `opengame deploy --publish --json` stays until review passes, then publishes, and takes the same jam flags.
172
175
 
173
176
  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.
174
177
 
175
- `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
+ `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.
176
179
 
177
- 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
+ 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.
178
181
 
179
182
  Follow the release to the end:
180
183
 
@@ -185,10 +188,14 @@ opengame status --watch --json
185
188
  | `data.review.state` | What to do |
186
189
  | --- | --- |
187
190
  | `review`, `playtesting`, `waiting` | Review is running. Watch again. |
191
+ | `approved` | Review passed. When `data.review.next` is `opengame publish`, do as for `awaiting_details`; otherwise watch again. |
188
192
  | `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. |
189
193
  | `needs_certification` | Give the creator `data.review.url`. Watch again once they say they have done it. |
190
- | `publishing`, `published` | The game is going live. `data.submission.gameUrl` is its page. |
191
- | `returned` | Read the findings, fix the game and deploy again. The new deploy is reviewed automatically. |
194
+ | `publishing`, `published` | The game is going live. Once it is, `data.submission.live.url` is the address to share. |
195
+ | `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. |
196
+ | `blocked` | Review refused the game. Give the creator `data.review.message`. |
197
+ | `withdrawn` | The creator withdrew this submission. Nothing more happens to it unless they ask you to enter it again. |
198
+ | `superseded` | Another submission took its place, and `data.submission.replacedBy` names it. Run `opengame status --json` again to follow that one. |
192
199
 
193
200
  ## What a game may do
194
201
 
@@ -246,7 +253,7 @@ Play the private preview before you tell the creator the game works.
246
253
  | `opengame restore [dir] [options]` | Put a game you unpublished back on the gallery, serving the version it was on, as Put it back does on Your games. Refused for a game we took down, one with an open report or a hold, and one under a copyright notice. Needs a token with read or deploy, and submit; opengame login has all three. |
247
254
  | `opengame delete [dir] [options]` | Delete the linked game for good, as Delete for good does on its page: it comes off the gallery, stops being served and cannot be put back. You type its title to confirm. Refused while it is under a legal hold, with a reviewer, or in a jam being scored. Only the opengame login token can do this, not a token made in settings. |
248
255
  | `opengame details [dir] [options]` | Print the linked game's title, tagline and description as the website shows them, or change any of them, as the Details tab on its page does. A field you leave out stays as it is. On a published game players see the change at once. Printing needs a token with read or deploy, and saving needs submit too; opengame login has all three. |
249
- | `opengame achievements [retire <id>] [options]` | List the linked game's achievements, active and retired, or retire one, as the achievements step on the website does. Players keep what they unlocked, and the game can no longer award a retired one. Retiring needs a token with deploy and submit; opengame login has them. |
256
+ | `opengame achievements [retire <id>] [options]` | List the linked game's achievements, active and retired, or retire one. Players keep what they unlocked, and the game can no longer award a retired one. Retiring needs a token with deploy and submit; opengame login has them. |
250
257
  | `opengame games [options]` | List your games and their latest deploy. |
251
258
  | `opengame link [dir] [options]` | Connect this folder to an existing game. |
252
259
  | `opengame pull [dir] [options]` | Bring website metadata into this folder. |
@@ -257,7 +264,8 @@ Play the private preview before you tell the creator the game works.
257
264
  | `opengame logout [options]` | Revoke this device's token and remove it locally. |
258
265
  | `opengame limits [options]` | Show bundle limits and your remaining account allowance. |
259
266
  | `opengame vendor [dir] [options]` | Create a separate export with dependencies downloaded at their exact versions, rewritten and hashed. |
260
- | `opengame skills add\|list [dir] [options]` | Install the OpenGame skills for your coding agent. |
267
+ | `opengame setup [options]` | Install the OpenGame skills for your coding agents and keep them updated with the CLI. Other commands also do it on first run and after an update. |
268
+ | `opengame skills add\|list [dir] [options]` | Install the OpenGame skills into one project, to commit them with it. |
261
269
  | `opengame upgrade [options]` | Install the current CLI, or print the line that does. |
262
270
  | `opengame version [options]` | Print the CLI version. |
263
271
 
package/CHANGELOG.md CHANGED
@@ -1,5 +1,33 @@
1
1
  # Changelog
2
2
 
3
+ ## 0.11.0
4
+
5
+ - `opengame setup` gives your coding agents the OpenGame skills: every skill this CLI carries,
6
+ in each agent's own folder in your home directory (`~/.claude/skills`, or under
7
+ `$CLAUDE_CONFIG_DIR`; `~/.agents/skills` for Codex; `~/.cursor/skills`;
8
+ `~/.config/opencode/skills`), for the agents installed on the machine or the ones `--agent`
9
+ names. Run it once after installing.
10
+ - Any other command does the same the first time it runs, and again after the CLI is updated,
11
+ so the skills stay as current as the CLI. A notice says when it happens. Skills you edited,
12
+ folders the CLI did not write, and skills you removed are left as they are.
13
+ - `opengame check`, `dev` and `deploy` bring older copies from `opengame skills add` in the
14
+ project's agent folders up to this CLI's, one agent's folder at a time.
15
+ - `opengame setup --no-skills` stops the install and the updates for good, and
16
+ `OPENGAME_SKILLS_AUTO=0` for one run. In CI they never run.
17
+ - The staging folder an install uses beside an agent's folder must be a real folder, never a
18
+ link, and is tidied only where an install writes.
19
+ - Carries the skills from `@opengamehq/skills` 1.7.0, which install the CLI with `opengame setup`.
20
+ - `~/.config/opengame/skills.json` records each agent's own CLI version and skills, so
21
+ `opengame setup --agent codex` after an update leaves Claude Code to be refreshed by the next
22
+ command rather than marking it current. A file from before is read as each agent's own.
23
+ - An `opengame setup --no-skills` saved while another command was installing skills stands:
24
+ every change to that file is read and written under a lock, from the file as it is then.
25
+ - `opengame` with no command lists `publish` among the first five, in place of `submit`, which
26
+ is now only for a release that was not sent to review by itself. `achievements` no longer
27
+ says the website has a retire control; `opengame achievements retire` is the way.
28
+ - `opengame dev`'s SDK names the radio by its real module in its error hints, and says what a
29
+ `cancelled` means: the call was stopped, as when the player chose Keep playing on a link.
30
+
3
31
  ## 0.10.0
4
32
 
5
33
  - `opengame publish` publishes a release that passed review, as Confirm and publish does on
package/README.md CHANGED
@@ -8,6 +8,7 @@ command checks a game folder, uploads it and gives you a private preview to play
8
8
  <!-- install:cli -->
9
9
  ```bash
10
10
  npm i -g @opengamehq/cli
11
+ opengame setup
11
12
  ```
12
13
  <!-- /install -->
13
14
 
@@ -40,10 +41,11 @@ opengame deploy .
40
41
  ```
41
42
 
42
43
  `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. Your agent can write the description
45
- and genre with `opengame details`; entering the jam and publishing are yours. `check` runs the same checks the upload will, on your machine. `deploy` builds,
46
- checks and uploads a release, then prints its deployment page:
44
+ you one thing, the game's name, and leaves every other field on Auto: review writes the
45
+ description and chooses the genre from the game, and you accept or change them on the
46
+ deployment page. Your agent can set the title, tagline and description with
47
+ `opengame details`. `check` runs the same checks the upload will, on your machine.
48
+ `deploy` builds, checks and uploads a release, then prints its deployment page:
47
49
 
48
50
  ```
49
51
  Uploaded. The checks run on our side, so you can close this terminal.
@@ -55,6 +57,11 @@ Or follow them here with opengame status --watch.
55
57
  The private preview plays on that page once the checks pass, and the release goes to
56
58
  review by itself. Add `--wait` to stay in the terminal until the checks finish.
57
59
 
60
+ When review passes, publish the game on that page, where you also enter the jam, or with
61
+ `opengame publish`. `opengame deploy --publish` deploys, waits for review and publishes in
62
+ one command. An update of a game that is already live publishes by itself once it passes
63
+ review.
64
+
58
65
  ## Scripts and agents
59
66
 
60
67
  Every command takes `--json` and prints one result object. For `deploy`:
@@ -76,8 +83,10 @@ A failure prints `"type": "error"` with `ok: false`, a `code` such as `not_launc
76
83
  `message` and the process exits with a non-zero code. `opengame help --json`
77
84
  lists every command, flag and exit code. `--jsonl` streams progress events.
78
85
 
79
- `opengame skills add .` installs the OpenGame skills for Claude Code, Codex, Cursor or
80
- OpenCode, so a coding agent can do all of the above for you.
86
+ `opengame setup` installs the OpenGame skills for Claude Code, Codex, Cursor and OpenCode
87
+ in your home folder, so a coding agent can do all of the above for you, and the CLI keeps
88
+ them current as it updates. `opengame setup --no-skills` turns that off.
89
+ `opengame skills add .` installs them into one project instead, to commit with it.
81
90
 
82
91
  ## Commands
83
92
 
@@ -102,7 +111,7 @@ OpenCode, so a coding agent can do all of the above for you.
102
111
  | `opengame restore [dir] [options]` | Put a game you unpublished back on the gallery, serving the version it was on, as Put it back does on Your games. Refused for a game we took down, one with an open report or a hold, and one under a copyright notice. Needs a token with read or deploy, and submit; opengame login has all three. |
103
112
  | `opengame delete [dir] [options]` | Delete the linked game for good, as Delete for good does on its page: it comes off the gallery, stops being served and cannot be put back. You type its title to confirm. Refused while it is under a legal hold, with a reviewer, or in a jam being scored. Only the opengame login token can do this, not a token made in settings. |
104
113
  | `opengame details [dir] [options]` | Print the linked game's title, tagline and description as the website shows them, or change any of them, as the Details tab on its page does. A field you leave out stays as it is. On a published game players see the change at once. Printing needs a token with read or deploy, and saving needs submit too; opengame login has all three. |
105
- | `opengame achievements [retire <id>] [options]` | List the linked game's achievements, active and retired, or retire one, as the achievements step on the website does. Players keep what they unlocked, and the game can no longer award a retired one. Retiring needs a token with deploy and submit; opengame login has them. |
114
+ | `opengame achievements [retire <id>] [options]` | List the linked game's achievements, active and retired, or retire one. Players keep what they unlocked, and the game can no longer award a retired one. Retiring needs a token with deploy and submit; opengame login has them. |
106
115
  | `opengame games [options]` | List your games and their latest deploy. |
107
116
  | `opengame link [dir] [options]` | Connect this folder to an existing game. |
108
117
  | `opengame pull [dir] [options]` | Bring website metadata into this folder. |
@@ -113,7 +122,8 @@ OpenCode, so a coding agent can do all of the above for you.
113
122
  | `opengame logout [options]` | Revoke this device's token and remove it locally. |
114
123
  | `opengame limits [options]` | Show bundle limits and your remaining account allowance. |
115
124
  | `opengame vendor [dir] [options]` | Create a separate export with dependencies downloaded at their exact versions, rewritten and hashed. |
116
- | `opengame skills add\|list [dir] [options]` | Install the OpenGame skills for your coding agent. |
125
+ | `opengame setup [options]` | Install the OpenGame skills for your coding agents and keep them updated with the CLI. Other commands also do it on first run and after an update. |
126
+ | `opengame skills add\|list [dir] [options]` | Install the OpenGame skills into one project, to commit them with it. |
117
127
  | `opengame upgrade [options]` | Install the current CLI, or print the line that does. |
118
128
  | `opengame version [options]` | Print the CLI version. |
119
129