Start here to find the right document. The repo README covers install and supported actions; the plugin README covers the implementation workspace.
| Document | What it covers |
|---|---|
| Set Up VDO.Ninja on Stream Deck | Plain-language setup, key colours, and troubleshooting. No programming knowledge assumed. |
| VDO.Ninja Version Compatibility Audit | Which controls work on older VDO.Ninja builds, and what Activate Guest needs. |
| Document | What it covers |
|---|---|
| Plugin Architecture and Roadmap | The high-level architecture and where the project is heading. |
| VDO.Ninja Stream Deck Plugin Build Plan | The concrete product/build plan: action classes, default profiles, state model, acceptance checks. |
| Stream Deck Plugin Best Practices | Reusable checklist for any Stream Deck plugin, including the icon and manifest rules this repo follows. |
| Stream Deck Hardware and SDK Notes | Hardware surfaces, key/dial differences, and SDK constraints. |
| Document | What it covers |
|---|---|
| Verified API Commands, Values, and Callback Payloads | The working reference for the command registry and state parser, checked against runtime source. |
| VDO.Ninja API Action Map | How the API surface maps onto Stream Deck actions. |
| VDO.Ninja API Surfaces and State | &api WebSocket/HTTP/SSE, iframe postMessage, and WebRTC data-channel routing. |
| Document | What it covers |
|---|---|
| Runtime Comparison Audit | The implementation compared against the current VDO.Ninja runtime. |
| Professional Parity and No-Regression Review | Whether the plugin would be a regression for Companion users, and what Marketplace-ready requires. |
| Onboarding and Configuration Review | How Stream Deck plugins usually guide setup, and what that implies here. |
| Bitfocus Companion VDO.Ninja Module Research | What the existing Companion module does, as the parity baseline. |
Research and audit documents carry their own dates. Treat anything dated as a snapshot of that day’s source, not a live description of the plugin.