Getting Started

Getting Started

StreamLink connects a stream provider (Twitch today) to configurable, in-game Minecraft behavior: an event fires (a follow, a raid, a channel point redemption, chat, ...), it's matched against your Event Configs, optionally gated by Conditions, and — if allowed — runs one or more Action Items, all of which can read and write Variables along the way.

This page is a map of the wiki, in the order you'd typically read it if you're new to configuring StreamLink.

Wiki Map

1. Event Configs — start here. Defines what StreamLink events exist (channel follow, raid, subscription, chat, bits, hype train, channel point redemptions, StreamLink-native login/logout, ...) and how each one's JSON maps to actions by name. Companion reference: Event Config Enums (EventConfigType).
2. Provider Variable Mapping — the provider-based concept, with each provider documented on its own page: Provider: TWITCH and Provider: STREAM_LINK. Each page lists the events it supports and, for each event, which fields get pulled out of the raw payload and what StreamLink variable name/type they land in.
3. Conditions — optional gates on whether an Action is allowed to run (string compare, numeric range/equality, chat username, subscriber check, boolean check, variable existence), plus ConditionList for combining multiple conditions with AND/OR. Companion reference: Condition Enums (ConditionType, ConditionCompareMethod).
4. Action Items — the actual steps an Action runs: send a chat message, run a console command, give an item, spawn/modify a monster, move the player, play a sound, show a toast, sleep, or read/write/persist a Variable. Companion reference: Action Item Enums (ActionItemType, TimeUnits, VariableMathOperation, plus the shared VariableDataType/VariableScope enums).
5. Variables — the runtime value type (Variable) that Conditions read and Action Items read/write, how it's populated from provider payloads and Action-declared defaults, its VariableScope (provider/action/event/global/system) and VariableDataType (string/integer/decimal/boolean), and the #name# placeholder syntax used to interpolate variable values into message text.

Suggested reading order for a first config

If you're writing your first Event → Condition → Action chain:

1. Pick the event you want to react to on Event Configs, and check that provider's page (e.g. Provider: TWITCH) for what variables it gives you to work with (e.g. event.user-name).
2. If the action should only fire sometimes, add a Condition (or a ConditionList of several) that checks one of those variables.
3. Write the Action Item steps you want to run, referencing variables with #variable-name# in any message/text field — see Variables for the full placeholder/scope/data-type model those steps operate on.