Skip to content

README.md

Latest commit

 

History

History
55 lines (40 loc) · 2.18 KB

README.md

File metadata and controls

55 lines (40 loc) · 2.18 KB
Raw

Plugin System

This folder is the source-side plugin SDK and host integration code.

Current host API: v3; accepted plugin API range: v2-v3.

Last verified: 2026-09-10.

Structure

  • PluginInterface.h: host plugin interface contract
  • PluginManager.h/.cpp: plugin lifecycle and dispatch
  • ExternalProcessPlugin.h/.cpp: process-plugin adapter (multi-language)
  • docs/: protocol and capability documentation

Supported plugin types

  • Native plugin (.dll/.so/.dylib)
  • Process plugin (*.plugin.json + stdin/stdout JSON line protocol)

UI extension points

Plugin tool actions can be mounted to:

  • tools_menu
  • top_toolbar
  • left_sidebar

All discovered tool actions are also grouped by plugin in the host-rendered, dockable Plugin Tools panel. Actions declaring scope_selector: note_range receive a persistent selected/range/all scope GUI with LongRangeSelector inputs. Native floating panels remain supported and join the same vertically split tool column by default. Tool blocks detach into floating windows and return as simultaneously visible split sections instead of switching tabs.

References

The former builtin.note_chain_assist process plugin is not an active SDK example. It is skipped by the host because the authoritative implementation is the native module under src/editor/NoteChain.

Tool actions and host batch-edit requests use an isolated worker process, so slow plugin work does not block the editor event loop. Each request has a method-specific timeout, can be cancelled by the host, and is rejected when the serialized request exceeds 1 MiB or the response exceeds 4 MiB. At most two worker requests are in flight per process plugin. Canvas overlay/input calls remain bounded synchronous calls because they are latency-sensitive; keep those callbacks small and move heavy work behind explicit actions.