AI Disclosure: This page was generated by an LLM and may contain inaccuracies. Hand-crafted documentation will be implemented over time on the road to 1.0
Plugin contract and compatibility
Use this hub for the exact boundaries Phials applies to plugin code. These references define what the public SDK supports, when a plugin is active, how runtime compatibility is decided, and what the community plugin trust model does and does not protect.
| Reference | Canonical subject |
|---|---|
| Public SDK support contract | Supported declarations and behaviors, SDK ownership, stability, and change policy |
| Plugin lifecycle reference | Installed, enabled, loaded, and activated states; hook order; cleanup; reload; failure behavior |
| Version and compatibility reference | Plugin version, minimum Phials version, Plugin API version, SemVer comparison, and the combined runtime check |
| Community plugin trust model | Trusted renderer execution, permission gating, permission review, safe mode, and author disclosure |
These contracts work together. A plugin can activate only when it is enabled, runtime-compatible, allowed by community plugin safe mode, approved for its current permission set, successfully loaded, and successfully activated.
The manifest and permissions reference owns the exact field and permission catalogs. The SDK type reference owns generated TypeScript signatures. Task guides elsewhere in the plugin documentation show how to use the contracts without redefining them.