Before it works
- Heimdall needs the Manage Roles permission, and the live role has to sit below Heimdall’s highest role.
- The live role cannot carry staff permissions. Anyone who links an account and goes live receives it, so Heimdall refuses a role with permissions such as Administrator, Manage Server, Manage Roles, Ban Members or Manage Messages, and a role that has any dashboard permission allowed.
- Each Heimdall instance has to have the providers configured by whoever runs it. A provider that is not set up says so when a member tries to link it.
Setting it up
Navigate to in the dashboard.
To carry the role into Minecraft, add it to your Minecraft Role sync mappings with the direction set to Discord to Minecraft. See Minecraft.
How members link an account
A member runs/streaming link and gets two buttons, visible only to them.
- Twitch or YouTube signs them in with Discord and reads the Twitch and YouTube accounts already connected to their Discord profile (User Settings > Connections). Only connections Discord has verified count, so a member can only link an account they actually own. Linking again replaces their Twitch and YouTube links with whatever their profile shows at that moment, which is also how a removed connection drops off.
- Kick checks their Discord account first, then signs them in to Kick. Kick is not a Discord connection type, so it has its own sign-in.
/streaming status shows a member’s links and whether each is live, and /streaming unlink removes them all.
Links belong to one server. A member who wants the role in two servers links in each.
The linked accounts list
The page lists every member with a linked account, live members first, with a link to each channel. Staff can unlink a member from there. There is no way to add a link on somebody’s behalf, because a link only means something when the member proved they own the account.The gotcha: how quickly the role changes
Twitch tells Heimdall the moment a stream starts or stops, so the role follows within seconds. Kick and YouTube are checked on a timer, so the role can lag by a few minutes. YouTube is checked less often the more channels are linked across an instance, because Google limits how many lookups a day are allowed. In Minecraft, the role sync mode decides when the in-game change lands. Straight away, over the bot connection and Straight away, over RCON apply it immediately. On the player’s next join waits until the player reconnects, so a streamer who is already online will not see their rank change until they rejoin. Heimdall only ever removes the live role from members it gave it to. A member who already had the role, for example because staff gave it to them, keeps it when their stream ends. If staff remove the role from someone mid-stream, Heimdall does not put it back until their next stream.Required permissions
Linking, checking and unlinking your own accounts needs no permission.
