Skip to content

Add icon + description to plugin.json for the v3 Pedalboard Plugins page #7

Description

@mogul

Restored from slopsmith/slopsmith-plugin-practice#8 — original issue, opened by @byrongamatos on 2026-06-10.
[restored-from: slopsmith/slopsmith-plugin-practice#8]

The v0.3.0 ("fee[dB]ack") v3 UI redesigns the Plugins page as a set of guitar pedalboards — each plugin renders as a stompbox pedal with a thumbnail, name, and short description, grouped by category.

To make your plugin's pedal look its best, please consider adding these optional, additive fields to your plugin.json. They're fully backward-compatible — omit them and the plugin still loads (it just gets a default pedal graphic and no blurb):

{
  "description": "One short sentence describing the plugin.",
  "category": "audio",
  "icon": "assets/thumb.png"
}
  • description — one short sentence, shown under the pedal name (clamped to ~2 lines).
  • category — which pedalboard the pedal sits on: one of audio | creation | practice | game | tools (free-form; unknown/absent falls back to a sensible default).
  • icon — an assets/-relative thumbnail (roughly square, ~256×256, PNG or SVG), served via the sandboxed /api/plugins/<id>/assets/... route (same containment rule as the styles field).
    • Shortcut: if you ship assets/thumb.png and omit icon, the loader auto-detects it — no manifest change needed.

These fields are surfaced by slopsmith core's /api/plugins (landing in v0.3.0). Full details in core: docs/plugin-v3-ui.md and docs/plugin-manifest.schema.json.

Thanks for keeping your plugin looking sharp on the new pedalboard! 🎸

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions