mirror of
https://github.com/got-feedBack/feedBack.git
synced 2026-09-13 08:29:28 +00:00
Miguel_LZPFandBret Mogilefsky
1214a6c0a0
CLAUDE.md had grown to 545 lines / 50 KB — most of it plugin-author
content that other AI tools (Cursor, Copilot, Codex, Aider) and humans
without AI never reach. Extract the plugin surface into 10 focused
docs and a JSON Schema for plugin.json, then slim CLAUDE.md to a
156-line navigable index.
New docs (~999 lines total, all self-contained):
docs/PLUGIN_AUTHORING.md — entry point and quickstart
docs/plugin-manifest.md — plugin.json field reference
docs/plugin-visualization-contracts.md — setRenderer / overlay / note-state
docs/plugin-audio-mixer.md — fader registration
docs/plugin-logging.md — context["log"] + env vars
docs/plugin-diagnostics.md — server_files / callable
docs/plugin-keyboard-shortcuts.md — registerShortcut + scopes
docs/plugin-sibling-imports.md — load_sibling pattern
docs/websocket-protocol.md — /ws/highway message reference
docs/testing-plugins.md — pytest fixtures + Playwright
schema/plugin.schema.json — Draft 2020-12 schema for
plugin.json; license enum
mirrors CONTRIBUTING's curated
allowlist. Backs CI validation
and the plugin-validate skill.
CLAUDE.md slim (581 lines changed, -485):
- Removed ~300 lines of plugin-author prose (now in docs/).
- Kept architecture quick reference, running the app, testing,
git workflow, versioning, song formats, frontend/backend
conventions, plugin authoring INDEX (table → docs/), first-hour
pitfalls, "For AI agents" footer.
- Anchor stubs preserved next to the new index entries so deep
links from specs/001-slopsmith-platform/analyze.md still resolve.
Verification:
python -c "import json,glob,jsonschema; s=json.load(open('schema/plugin.schema.json')); [jsonschema.validate(json.load(open(p)), s) for p in sorted(glob.glob('plugins/*/plugin.json'))]"
# ok — validates highway_3d, app_tour_library, app_tour_settings
Signed-off-by: Miguel_LZPF <mgcdreamer@gmail.com>
46 lines
2.0 KiB
Markdown
46 lines
2.0 KiB
Markdown
# Audio mixer fader registration
|
|
|
|
Plugins that produce audio outside the song's `<audio>` element (NAM amp output, synth voices, etc.) can register a labeled fader so users can balance them against the song from one mixer popover in the player controls.
|
|
|
|
This is the slopsmith#87 contract.
|
|
|
|
## Registration
|
|
|
|
```js
|
|
function _registerFader() {
|
|
const api = window.slopsmith && window.slopsmith.audio;
|
|
if (!api) return;
|
|
api.registerFader({
|
|
id: 'my_plugin', // unique key
|
|
label: 'My Plugin', // shown above the fader
|
|
unit: 'dB', // optional suffix shown next to the value (e.g. '%', 'dB')
|
|
min: 0, max: 2, step: 0.05,
|
|
defaultValue: 1.0,
|
|
getValue: () => _myCurrentVolume, // read current value
|
|
setValue: (v) => _setMyVolume(v), // write + persist + apply
|
|
});
|
|
}
|
|
|
|
if (window.slopsmith && window.slopsmith.audio) {
|
|
_registerFader();
|
|
} else {
|
|
window.addEventListener('slopsmith:audio:ready', _registerFader, { once: true });
|
|
}
|
|
```
|
|
|
|
## Contract
|
|
|
|
- **Persistence is the plugin's responsibility.** The registry calls `getValue()` when the popover opens and after each `setValue()` during slider drags to re-sync the displayed value.
|
|
- **`getValue()` must be cheap and side-effect-free.**
|
|
- **`setValue()` must update whatever backing state `getValue()` reads synchronously** — pair it with whatever your plugin already does internally (write the GainNode, persist to `localStorage`, update any in-plugin label).
|
|
- **Use `unregisterFader(id)`** when your plugin is teardown-able and you want the strip to disappear; otherwise keep it registered so the user's setting persists across toggle states.
|
|
|
|
## Lifecycle event
|
|
|
|
`slopsmith:audio:ready` fires once on `window` when the audio mixer registry is ready. Guard registration against this event for plugins that load before the mixer.
|
|
|
|
## Related
|
|
|
|
- [PLUGIN_AUTHORING.md](PLUGIN_AUTHORING.md) — guide index
|
|
- [plugin-visualization-contracts.md](plugin-visualization-contracts.md) — visualization counterpart
|