Extensions
An Amadeus extension is a package containing a plugin.toml manifest and a self-contained JavaScript entry. The manifest identifies what Amadeus may load; the entry registers the package’s public operations and parameters.
Directorycom.example.plugin
- plugin.toml
Directorydist
- plugin.iife.js
Choose a role
Section titled “Choose a role”| Role | Use |
|---|---|
language | Convert lyrics and score context into planned pronunciation and a renderable score. |
hook | Modify a documented extension stage, such as the post-pitch contour. |
importer | Reserved for reading a score format; unavailable in the current release. |
exporter | Reserved for writing a score format; unavailable in the current release. |
A language package is exclusive: only one can be active. Hook packages may coexist and are ordered within their declared stage.
Start here
Section titled “Start here”- Quickstart creates a minimal post-pitch package.
- Package Model explains roots, members, roles, and registration.
- Parameters defines Inspector fields and their render consequences.
- Manifest reference defines package metadata.
- Plugin API documents the public authoring contract.
Use the API reference and distributed declarations for supported behavior. A runtime detail that is not represented by the public contract is not an extension guarantee.