SnuggleLink

SnuggleLink connects each Minecraft server to the SnuggleSMP Hub website. It does two things: it keeps the Hub's stats page up to date, and it lets Twitch viewers send fun effects to streamers while they play.

The stats page

Every 30 seconds, each server tells the Hub its name, its player limit and who's online (names only). This is what the Hub's stats page shows.

If birthdays are turned on, the server also sends the birthdays people set with SnuggleBirthdays, every few minutes. Only the month and day are sent.

Linking your Twitch account

1. Type /snugglelink.
2. You get a short code that expires after a few minutes, and a link to the Hub. Click the link.
3. Enter the code on the Hub.

If you're already linked, it tells you which Twitch account, and a new code re-links you to a different one.

Viewer effects

When you're linked and streaming, your viewers can spend channel points (or cheer bits) on your stream to send you effects in-game. When one arrives, you see who sent it in your action bar, and players within 32 blocks see a chat line like "Name on Twitch sent you a confetti party!"

None of the effects can hurt you, break blocks or leave anything behind.

Jump scares (the last four) are spaced out so viewers can't chain them. There's at least 20 seconds between scares on the same streamer. Extra scares wait their turn for up to 2 minutes; after that they're refunded.

By default, sound effects are only played to the streamer, so your stream hears them but players around you don't.

Pausing effects

Need a break, or doing something tricky? Type /snugglelink pause. Effects stop until you type /snugglelink resume, even if you log out. Channel point redemptions sent while you're paused or offline are refunded. Bit cheers are passed back to the Hub instead of being played.

For staff

• Each server needs the Hub address, the Hub plugin key and a unique server.name (letters, digits, - and _) in config.yml. Until those are set, the plugin stays disconnected and says so in the console. Run /snugglelink reload after changing them.
• Only turn birthdays.enabled on for servers that run SnuggleBirthdays.
• Effects can be switched off one by one under effects.allow, or turned off entirely in some worlds with effects.disabled-worlds. Redemptions for switched-off effects are refunded.
• sounds.audience can be streamer (only the streamer hears it) or nearby (everyone close by). sounds.max-volume caps how loud a streamer's sounds can be.
• The action bar and chat messages, the chat radius, the parrot's lifetime and the scare gap are all in config.yml too.