The repair loop

When a check fails, OpenGame reports the evidence and its location, the result’s certainty, who needs to act, the smallest fix and when to try again. That is enough for you, or an agent working for you, to repair the game without debugging the platform.

Read a finding

{
  "release": null,
  "check": "case-mismatch",
  "checkVersion": "packaging@1",
  "state": "failed",
  "certainty": "certain",
  "fault": "game",
  "evidence": {
    "observed": "index.html line 1 …",
    "file": "index.html:1"
  },
  "fix": "macOS and Windows do not …",
  "verify":
    "opengame check, then opengame deploy",
  "retry": "after-fix"
}

This finding is from a real run, with the long strings cut short. The page asked for assets/Rock.png, and the file was assets/rock.png. The game loaded on the author’s Mac, which ignores case in file names, and players would have been missing a file.

Field	Meaning
`release`	The release the finding is about, or `null` for a local check that ran before any upload.
`check`, `checkVersion`	Which check, and which version of it. A newer version can find what an older one did not.
`state`	The result of the check: `failed`, `inconclusive`, `provider unavailable` or `not run`. `not run` comes with `fault: platform`, because the check never got to your game.
`certainty`	`certain` or `heuristic`. `heuristic` is our reading of signals, so read the evidence before you rewrite code because of it.
`fault`	Who has to change something: `game`, `platform` or `unknown`. `unknown` means no change is due yet: a person decides it at review, or it concerns code we ship, and `fix` says which.
`evidence`	What was seen, in a sentence, as `observed`, plus `file`, `request` or `frame` where there is one.
`fix`	The smallest change that resolves it.
`verify`	The command that shows the fix worked.
`retry`	When running the command again can succeed: `now`, `after-fix`, `later` or `never`. With `later`, `retryAfterSeconds` gives the wait, when the server sends one.
`docs`	A URL. Reserved: no check sends it yet.

Act on a finding

Read the fault

With game, change the game. With platform, don’t change the game: the failure is on our side. With unknown, wait: retry is never, because a person rules on it at review or it concerns code we ship.

Read the certainty

A certain finding is from a deterministic check. A heuristic one is our best reading of signals that can mislead, such as listeners a bundler renamed, so check the evidence yourself before you change code.

Apply the fix, then verify

Make the change in fix, then run the command in verify, usually opengame check, before you deploy again. A local check is free, and each deploy counts against an hourly allowance.

When the failure is ours

When a scanner, a moderation provider, storage or a test machine fails, the finding has fault: platform and the CLI exits with code 5. The check could not finish. Follow the retry guidance, and leave working code as it is: editing a good game to get through a broken check only damages the game. Waiting helps while a service is down. It does not help an upload that can no longer finish:

If the error line has a next command, run that.
A plain opengame deploy that finds its saved upload can no longer finish says so in an upload_restarted notice, and starts a fresh upload from your current files.
A deploy with a pinned key exits 2 instead, with an upload error such as upload_expired. To start again, run the deploy without a key, or with --idempotency-key <a new key>. This command makes the new key from the current time:
opengame deploy . --json \ --idempotency-key "retry-$(date +%s)"
A key you write yourself may use letters, numbers, dots, colons, hyphens and underscores.

Read a receipt

Each server check writes a receipt for the bytes it saw. A receipt is in one of the states below, and only passed clears a gate.

State	What it means
passed	The check ran and found no problem. It counts.
failed	The check found a problem. Read the finding’s fix, then deploy a new release.
inconclusive	The result is uncertain. Usually a person confirms it at review, and you can still submit. An inconclusive archive check or image review blocks the deploy instead: the finding’s `fix` says what to change.
not run	The check has not run yet. Wait for it.
provider unavailable	A service the check depends on is down. Follow the retry guidance. If it keeps happening, tell the OpenGame team member who invited you.

A receipt belongs to one release and the bytes in it. A passed receipt for one release does not count for another, and a check runs again when the check’s version changes.

Read the exit code

Every command ends with an exit code, from 0 when it finished to 6 when the CLI is too old. The exit code table in the CLI reference, generated from the CLI, gives what each code means and what to do next.

Start

Guides

Reference

Read a finding

Act on a finding

When the failure is ours

Read a receipt

Read the exit code

​Read a finding

​Act on a finding

​When the failure is ours

​Read a receipt

​Read the exit code

Read a finding

Act on a finding

When the failure is ours

Read a receipt

Read the exit code