Plugins
BokeBox splits replaceable capabilities into four plugin kinds that share plugin-kit (enable/disable, config, manifest loading). Business APIs differ by capability.
Four kinds
| Kind | Role | Directory | Docs |
|---|---|---|---|
| Source | Ingest → unified SourceArtifact | storage/plugins/source/ | Guide · Dev |
| ASR | Speech-to-text | storage/plugins/asr/ | Guide · Dev |
| TTS | Text-to-speech | storage/plugins/tts/ | Guide · Dev |
| Schedule | Timed candidate URLs | storage/plugins/schedule/ | Guide · Dev |
Principles
- Core consumes contracts only — high-risk fetch / third-party charts stay optional plugins
- Least privilege by default —
riskLevel: highforces default off - Hot plug — drop into directory or zip upload, then Settings rescan
- Runnable examples — repo
examples/*-plugin-*
Management
- Web: Settings → Plugins
- API:
/api/{source|asr|tts|schedule}-plugins(list / rescan / toggle / config / install)
Install
Next
Read the product guide for architecture, then the dev guide to implement.
