StreamKit+ Documentation

Guides for streamers (how to use the app) and for addon developers (sandbox API, manifest, permissions).

Integration addons extend StreamKit+ from an isolated worker process. Addon code runs inside a VM sandbox and uses global APIs (network, events, api, …) — no SDK imports inside the worker.

For streamers

How to use StreamKit+ as a viewer of the desktop app — not how to write addons.

Section Description
Getting started First launch, license, what each module is
Main window Timer, quick actions, title bar, status
Latest events Live event feed and replay chips
Chat window Combined chat, sending replies, appearance
Settings Sidebar, save/reset, Main and Interface
Addons and catalog Install platforms, permissions, updates
Overlay Effects on screen and in OBS
Widgets and applications OBS widgets and in-app windows
Donation timer Countdown files and auto rules
Sound effects Alert sounds on events
Hotkeys Keyboard agent and presets
Cooperative sync Share overlay and hotkeys with other PCs
Game integrations Viewer actions inside a game
Text to speech Piper, ElevenLabs, Windows voices
LLM Access AI profiles for addons
License and updates License, app updates, changelog
Backups Zip snapshots and restore

For addon developers

Section Description
Getting started Architecture, installation, project layout, @rocketman-streamkit/addon-generator
Lifecycle How addons are loaded, restarted, and crash-loop protection
manifest.json Manifest fields, types, and validation rules
Publishing and releases Catalog registration, GitHub release layout, caching, and version sync
TypeScript setup tsconfig.json, typings, build output
Permissions Capability flags and user approval
Settings schema GenerateConfig() and settings UI
Localization Per-locale strings in addon code
Security Network restrictions, tokens, sandbox limits
OAuth and secrets Token exchange via outbound HTTP (no built-in auth server API)

Sandbox API

Section Description
API overview All globals at a glance
events Event bus and HTTP handler binding
network HTTP client, endpoints, WebSocket, SSE, SignalR, Socket.IO
api.config & storage Params, app config, private file storage
File access User-approved read/write to specific paths (files API)
Text-to-speech (tts) Play messages via the user's TTS engine (TTS permission)
LLM Access (llm) Chat completions via user LLM profiles (LLM permission)
yt-dlp downloads (ytdlp) Download media via bundled yt-dlp (FILE_ACCESS + NETWORK_REQUEST)
addons (RPC) Addon-to-addon requests and events
dashboard Events widget, chat, overlay triggers
status, notify, ui Status bar, viewer count, notifications, OAuth result pages
Alerts (alerts) Cross-addon alert display coordination (no permission)
Currency User's primary currency and amount conversion
Language detection (language) Detect text language via fastText (~176 languages; no permission)
Utilities Timers, crypto, console, developer mode

Addon categories

Section Description
Platform addons platform.streaming, platform.donation
Overlay addons Effects, static web, simple media
Widget addons Persistent web pages and OBS sources
Application addons In-app sandboxed windows
Game addons In-game effects and input triggers

Typings

Install sandbox declarations from npm — version must match the StreamKit+ release you target:

npm install --save-dev @rocketman-streamkit/types

See TypeScript setup for tsconfig.json and globals (declare global — no imports in addon code).