Stylish Action HUD exposes a public API for companion modules, system adapters, themes, presets, and action-menu extensions.
Use Hooks.once("stylish-action-hud.apiReady", (api) => { ... }) when registering adapters or extensions. That hook guarantees the API object is ready.
| Page | Use it for |
|---|---|
| API Overview | How to access the API, when to use apiReady, and what methods are available. |
| System Adapter API | How to register system adapters and extend BaseSystemAdapter. |
| Action Menu API | How to add categories, submenu providers, submenu item data, and favorite-star behavior. |
| Defaults Registry API | How to register default attributes, layouts, status effects, and trackable attributes. |
| Configuration API | How to update module configuration and client positions from another module. |
| Theme API | How to register companion-module themes and inspect registered themes. |
| Hooks Reference | Lifecycle and action-menu hooks exposed by Stylish Action HUD. |
| API Examples | Longer examples for full adapters and menu modifications. |
| API Troubleshooting | Common API symptoms and what to check. |
| Preset API | How to export, import, download, and load presets. |
| TypeScript Definitions | Reference interface definitions for TypeScript users. |
These API pages document Stylish Action HUD 2.5.8. The module supports Foundry V13 and V14 and requires glitchsmith-lib 0.7.1 or newer.