deckcore

Generic Stream-Deck engine — a config-driven button registry with a pluggable capability system, a "decks" view-template model, and Preact UI modules (editor + touch panel). deckcore is a library, not a standalone app: a host application embeds DeckCoreService, injects its own capabilities/paths, seeds its own buttons, and serves the UI.

It powers RigzDeck — a lightweight standalone stream-deck app (turn any tablet into a deck) — and can be embedded in any host application: register your own capabilities, seed your own buttons, serve the UI.

What's inside

• service.py — DeckCoreService:
  • eval engine (resolve-by-id) + async eval loop, publishes resolved button visuals on an event bus (topic streamdeck:buttons);
  • capability registry — register_action(type, fn) / register_monitor(type, fn);
  • deck-v2 data model — a shared button pool (function only) + independent deck templates (each with its own layout / categories / ordered items); one button may live on many decks;
  • generic capabilities — actions launch · http · flag_toggle/set · displayfusion · media · hotkey; monitors flag · file_field · poll · sse_field · displayfusion_profile.
• web/ — Preact UI modules: StreamDeck.jsx (editor), TouchDeck.jsx (touch panel), deckstyle.js, deck.css, plus minimal same-origin api.js / sse.js helpers.

Pluggable by design

The core ships only host-agnostic capabilities. A host registers extra ones via register_action() / register_monitor() and seeds its own default buttons through the default_buttons= constructor argument — so the same engine powers very different decks without any if host == "..." branching.

from deckcore.service import DeckCoreService

svc = DeckCoreService(bus, runtime_dir=..., default_buttons=[...])
svc.register_action("my_thing", lambda action, btn: {"success": True, "message": "ok"})

Folder templates

The normal open_deck action supports three presentation modes: replace (grid subpage), radial, and categories (category sidebar with paged keys). Select the mode in the existing action editor. All modes reference the same deck template and shared button pool; no content-specific page or plugin action is required.

For category mode, item.style.placement places a key in the grid, beside its category, or in the toolbar. This is local to the deck item and editable in the existing inspector. Category mode uses equal-sized cells and the deck's size/gap/font settings; free coordinates and multi-cell spans remain available in grid mode. The usual key renderer handles widgets, status and per-item style in both views.

The Elgato plugin continues to consume resolved visuals and press stable button IDs; it does not mirror web folder navigation. A state's omitted image inherits the button's default.image; an explicit empty image suppresses it.

Status

v0.1.0 — early but functional.

License

MIT — see LICENSE.