site_check

Behavior#

Run the platform's checks again on one of the game's builds (version from site_status; the newest by default). A headless browser opens it on its preview host, framed as the project page frames it: the boot check records uncaught errors, the build's own files that fail to load, Content Security Policy violations, when the game called looping.ready() and a screenshot, and passes when the game calls looping.ready() within 30 s (90 s for Unity) with no error before it, or, without the SDK, when its screen is not blank at 12 s.

For a build that uses rooms, the multiplayer check opens a second, independent player and records whether both opened room connections, landed in the same room and heard each other; for one that uses the store, the store check serves the catalog in test mode, records the skus the game asks for, and when the game implements the check hook (looping.onCheck) makes a test purchase and confirms the game read it back. check.smoke has each: status passed, failed, not_exercised (the game needs a player's input to get there: implement looping.onCheck, docs/SDK.md "The check hook") or inconclusive, a reason with the fix, blocking, and seen.

A blocking failure (a room refused for the project's configuration or its rules.js, a sku the store doesn't sell) keeps the build from being released or listed until it is fixed; not exercised never does. Every publish is checked once on its own; check again after fixing the project or the game. wait: true runs the check in this call and returns its result (about a minute, up to two and a half); without it the result lands in site_status and project_status within a minute or two.

Up to 20 checks per game a day.

Input parameters#

The descriptions above include conditional requirements. The full schema below shows structural validation; runtime checks also apply.

JSON Schema#

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "type": "object",
  "properties": {
    "version": {
      "type": "string",
      "minLength": 3,
      "maxLength": 40
    },
    "wait": {
      "description": "run the check in this call and return its result",
      "type": "boolean"
    }
  },
  "additionalProperties": false
}