Reference

Guided and generated references for the public Turboism SDK.

The Reference section documents the plugin-facing SDK boundary.

Start here

  • SDK API Guide — lifecycle, PluginContext, object APIs, hooks, configuration, storage, tasks, UI, permissions, and readiness constraints.
  • Generated API Reference — source-generated JDK 17 Javadoc for the public SDK packages, plus its publication status.
  • Open the HTML type index — browse packages, classes, records, interfaces, and methods directly.

Contract status

Turboism publishes one public SDK tier. The reviewed binary API baseline in the Turboism source repository (sdk/api-contracts/baselines/) is the compatibility gate: the current baseline is the live exact gate and earlier baselines remain historical audits.

Availability still depends on separate facts, and passing one does not establish another:

  1. the API exists in the SDK;
  2. the plugin declares the required permission;
  3. Runtime has a matching capability Provider;
  4. the active Cubism Editor version and object generation are supported.

Internal Runtime, Bootstrap, test-framework, mapping, Provider, and first-party plugin implementation packages are intentionally excluded from the public reference.