engine_docs

Behavior#

Read the documentation of a package the platform publishes, which a game loads from its own origin at /_looping/engines/<pkg>@<x.y.z>/src/index.js: sdk (the game SDK for any HTML game: rooms, saves, rounds and scores, the store), or engine-core (the platform runtime behind verified scores: the replay recorder and the replaySim a build's sim.js exports, with the same rooms and store; it has no rendering, UI or game rules).

doc is README.md (the API, the default), ROADMAP.md or CHANGELOG.md; the sdk also carries the platform's guides: SDK.md (the platform contract: rooms, identity, saves, rounds and scores), SAVES.md (the saves guide) and UNITY.md (Unity Web builds). A doc longer than one page (SDK.md is) returns its introduction and sections, its outline; read the part you need with section, a heading such as "Load it", "Private rooms and invite codes" or "Saves".

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": {
    "engine": {
      "type": "string",
      "minLength": 2,
      "maxLength": 40,
      "description": "sdk or engine-core"
    },
    "doc": {
      "type": "string",
      "maxLength": 40
    },
    "section": {
      "description": "a heading of the doc: returns that section only",
      "type": "string",
      "maxLength": 80
    }
  },
  "required": [
    "engine"
  ],
  "additionalProperties": false
}