Streaming Hub 0.2 documentation

Start with installation or migration, then learn how Core, Editor and Tray work together.

Start using Streaming HubInstall the components and run your first automation.Move from 0.1Copy your projects and settings while keeping the originals.Understand Core, Editor and TrayKnow what keeps running and where changes are saved.Inspect an automation runFollow executed steps and compare captured values.

Getting started

Installation and first launch — Install Core, an Editor and the integrations you need.
Move from Streaming Hub 0.1 — Copy selected projects and settings into a new installation.
Basic settings — Choose local preferences, Core settings and service connections.
Create your first automation — Save and test a small automation before using live events.

Using Streaming Hub

Core, Editor and Tray — Understand what executes your automations and what closing a window does.
Editing, Apply and Save — Distinguish an Editor draft, Core's active state and the saved project.
Projects and transferable data — Know what a project saves and what stays local.
Settings and service profiles — Keep Editor preferences, Core settings and project configuration separate.
Plugins and component updates — Install and update a compatible set of registered components.
Publishers and plugin trust — Review signed community plugins before allowing their code to run.
Entities and workspaces — Edit reusable plugin resources with explicit Apply and validation.
Context storage — Context storage gives automations controlled access to configured file roots.
Files and folders — Copy, move and organize local files with Core actions, folder signals and project-specific access.

User interface

Core Settings — Control Core from Tray without opening an Editor.
Runs and captured history — Inspect executed steps, historical structure and captured values.
Editor interface overview — Find definitions, execution history, supporting panels and status.
Automation workspace — Organize signals, folders, sequences and tests.
Sequence editor — Configure ordered and nested steps before applying changes.
Side panels — Open Variables, Runtime, Insert Field, Encyclopedia and Tests.
Status bar — Distinguish project state, Core connectivity and service health.
Tests and reusable test chains — Run a deliberate chain of automation tests and pauses.
Keyboard shortcuts — Configure Editor commands separately from global automation signals.
OBS workspace — Create Assets, Slots and nested Bindings through the API.
Macros workspace — Edit reusable definitions and inspect caller mappings.
Statistics workspace — Define signal-driven values and inspect rule diagnostics.
Database workspace — Browse and edit permitted context files.
Log panel — Filter lifecycle and automation messages around a problem.

Core concepts

Core concepts — Follow a signal from its event to an automation result.
Signals — Choose what starts an automation and what data it receives.
Automations — Combine an enabled signal with a sequence of actions.
Sequences and steps — Build ordered actions with nested branches, loops and macros.
Variables — Separate saved variable definitions from current runtime values.
Data and context — Use event fields, run-local values and macro inputs deliberately.
Conditions — Guard a step or choose a branch from event and runtime values.
Macros — Reuse sequences with explicit input and output mappings.
Live State Source — Use a selected service to decide whether your stream is live.
Data Explorer — Inspect configured context files through Core.

Integrations

Integrations — Connect plugin services and keep project resources separate.
OBS Studio — Connect OBS and bind reusable assets and slots.
Twitch — Authorize the required account capabilities and test a live workflow.
YouTube — Authorize a channel and configure the live-chat workflow.
DonationAlerts — Receive donation events and route them to controlled reactions.
Stream Deck — Connect the Core bridge and configure project button zones.
vMix — Configure the endpoint and project input bindings.
Piper TTS — Configure local speech and verify its installed voices.
AI Services — Use provider connections and model profiles from automation actions.

Learning guides

Guides and recipes — Choose a short learning exercise or a complete streaming workflow.
Test a signal — Run a controlled event against the applied automation.
Use a variable in a condition — Guard an action with a project Boolean.
Pass data between steps — Use a run-local action result in a later step.
Process items in a loop — Run a nested sequence for each item in a list or object.
Handle a step error — Choose how execution responds to a failing action.
Configure concurrent execution — Coordinate repeated triggers and shared outputs.
Use context storage in an automation — Read and append files beneath an allowed root.
Change an OBS scene from a Twitch event — Connect a controlled Twitch event to an applied OBS scene action.

Practical guides

Organize local files — Archive a ready recording or prepare scene logos using approved local file locations.
Send chat messages on a timer — Send a reusable announcement through a connected chat service.
Track signal data with Statistics — Update a statistic from a selected event without a separate automation.
React to donations in OBS with animation and Piper TTS — Combine a donation event with controlled OBS and optional speech steps.
Stop or mute Piper from Stream Deck — Provide a deliberate stop action and optional persistent speech toggle.
Build an interactive UI Choice on Stream Deck — Display a project-defined choice and handle its response.
Control a Twitch prediction from Stream Deck — Create, lock and resolve a prediction using explicit button workflows.
Show Twitch prediction events in OBS — Update a reusable OBS card from prediction lifecycle events.
Queue Twitch reward videos without overlap — Coordinate separate reward automations through one folder boundary.
Celebrate a follower goal with Threshold Reached — Count follower events and trigger a controlled goal reaction.
Build an AI chat bot for Twitch — Generate a controlled reply and send it through the intended chat account.
Add chat history and viewer memory to an AI bot — Supply explicitly configured context files and keep dialogue bounded.
Moderate donation TTS with AI — Return a speech decision, moderated text and a selected language.

Diagnostics and support

Core and client connection — Resolve missing Core, pairing, permission and compatibility problems.
Changes not appearing — Check draft, applied and saved state before repeating an action.
Recover an interrupted update — Use the recorded outcome before retrying component installation.
Compare automation runs — Compare retained executions without replacing historical data.
Runtime inspection — Inspect run and step data from the Runtime side panel.
Recover a project — Protect the original files while diagnosing a failed project open.
Diagnose a service connection — Check an integration without confusing it with Core connectivity.
Logs and diagnostics — Collect the smallest useful evidence without exposing secrets.
Crash reports — Identify which component stopped and preserve useful diagnostics.

Reference

Global keyboard shortcut signal — Trigger a Core automation from a registered Windows shortcut.
User Script — Run JavaScript, C#, or Python with typed inputs and JSON results.
Built-in signals — Choose an installed Core signal and inspect its declared fields.
Built-in step reference — Categories of executable steps provided by Streaming Hub.
Data paths — Address event, runtime, variable and other structured values with explicit roots.
Expressions — Combine paths, literals, comparisons, arithmetic and Boolean logic in If branches and Step Conditions.
Math: Number Operate — Calculate a numeric expression and write its result to a variable or runtime path.
Concurrency modes — Control overlapping automation runs and coordinate groups of signals that share a resource.
Error policies — Control sequence behavior after a step fails.
Encyclopedia — Browse the action and signal catalog available in the current installation.
Glossary — Short definitions of recurring Streaming Hub terms.

Plugin SDK

Plugin SDK — Build integrations that run in Core and expose portable descriptors.
Create a plugin — Build, sign and load a minimal independent integration.
Plugin manifest — Declare entry identity, compatibility, capabilities and limits.
Plugin lifecycle — Keep Core startup and shutdown independent of an Editor.
Define actions — Expose stable action IDs, schemas and cancellable execution.
Define signals — Emit declared events through Core's existing intake.
Schema UI and references — Describe forms as data that clients can render safely.
Settings, credentials and interactions — Separate machine-local settings from transferable project data.
Plugin entities and detached drafts — Validate related records without mutating live state during preview.
Localization and icons — Keep IDs stable while supplying readable presentation metadata.
Plugin signing and security — Distinguish official signatures, community keys and local consent.
Test a plugin — Verify headless lifecycle, protected data and final package loading.
Package and version a plugin — Distribute one complete authenticated package and its compatibility metadata.