Documentation

Getting started#

Solyx Cups answers Fortnite cup questions directly in your Twitch chat — points to qualify, a player’s placement, the running round and countdowns. Three steps get you there.

1. Sign in with Twitch and pick your channel.
2. Add the bot, then give it moderator rights with /mod solyxbot.
3. Set your Epic name and region, then activate the commands you want.

Sign-in & permissions#

Sign-in works through Twitch only. We request exactly one permission — user:read:moderated_channels — to learn which channels you moderate. There is no write access to your account, and we never read your chat history.

Who can manage a channel

The dashboard belongs to the channel, not to a person: the broadcaster and every Twitch moderator of that channel see and edit the same settings.

Why the bot needs moderator rights

Twitch rate-limits ordinary accounts to roughly one message every two seconds. As a moderator the bot may answer far more quickly — without mod rights busy chats will notice long delays.

Commands#

Every command can be renamed and given aliases, so !qual can just as well be !points. Names and aliases share one namespace — no two commands may claim the same word.

Variables#

Variables are replaced with live values when the command runs. Cup commands use their own set, your own text commands a smaller general one.

In your own text commands

Only these are listed because only these have a data source. Anything else would silently produce empty replies.

Variables can be nested, e.g. $(repeat 3 $(sender)). Some take an argument after the name, separated by a space, e.g. $(math 1 + 1) or $(randint 1 30).

In cup commands

In Chat Alerts

Each alert message in the “Chat Alerts” module has its own set of variables, listed below by alert type.

Twitch directives#

When the entire response of a command or timer is one of the directives below, the bot carries out the Twitch chat action instead of sending it as text — the same shorthand Twitch itself understands, e.g. /timeout. It only works with the bot’s own moderator rights, so a few broadcaster-only actions are missing on purpose (see note below), and it must be the whole message: mixing a directive with regular text is not supported.

Not supported, because they need the broadcaster’s own approval rather than the bot’s moderator rights: /mod, /unmod, /vip, /unvip, /raid, /unraid, /commercial.

Cup parameters#

These settings live on the channel and apply to every cup command at once. You set them under “Fortnite cups”.

Dashboard modules#

Beyond chat commands, the channel dashboard has a few modules that broadcasters and moderators configure directly there.

Roles & permissions

Five predefined roles exist — Broadcaster, Moderator, VIP, Subscriber, Non-subscriber. They apply automatically from your Twitch account status, can’t be renamed or deleted, but their permissions can be edited like any other role. On top of that you can create your own roles and assign them to specific Twitch accounts by searching for them.

Permissions are grouped by area — general, commands, timers, moderation, nukes, cups, roles — each with its own view/toggle/manage-style checkboxes. “Administrator” grants everything at once.

Spam filters

Four automatic filters run on chat messages: repeated messages, links, blocked-language terms, and message flood. Each can be switched on or off independently, gets its own reason text, can be limited to while the channel is online/offline/during notifications, can exclude or target roles (moderators and the broadcaster are always excluded), and can ignore platform emotes. Before the real action (delete, timeout, or warn — with a base and a maximum timeout) an optional warn step can run first, and hits can optionally be announced in chat with a cooldown.

Timers

Rotating auto-messages: a timer has a name, up to five message variants the bot cycles through, an interval in minutes, a minimum number of chat messages since the last send, and a toggle to only run while the channel is live.

Blocked terms

Each term can hold several phrases at once (any one of them triggers it), a match type (contains, whole word, or regular expression), case sensitivity, an action (delete, timeout with a duration, or warn) with an optional reason, and an exempt level (this role and everyone above it is skipped). The first enabled rule that matches, in list order, wins. Rules can be exported to and imported from a JSON file — handy for reusing a rule set across channels.

Nukes

A manual bulk-moderation tool for raids or spam waves: match a text pattern and/or a specific username across the last 1–30 minutes of chat, optionally limited to accounts that followed within a chosen time window. A preview always runs first and lists every match before you delete, time out, or warn them; every run stays in a history list.

Giveaways

A Fossabot-style giveaway: viewers enter either by writing a configurable keyword in chat, or automatically just by chatting at all while the giveaway runs ("active chatters"). A subscriber luck multiplier (1–10) increases a subscriber’s odds relative to everyone else without excluding non-subscribers. Starting and drawing a winner are separate steps — the dashboard shows the live participant list while it runs, and a weighted random draw picks the winner once you click it, with an optional chat announcement for both the start and the winner.

A live, read-only preview of the channel’s real Twitch chat sits next to the settings while the giveaway page is open, so you can watch entries come in without switching tabs.

Chat Alerts

Fossabot-style automatic chat messages for subscriptions, resubs, gifted and mass-gifted subs, raids, bits, charity donations, ad breaks, hype trains, polls, predictions, new followers, watch streaks, and going live/changing game or title — each with its own on/off toggle, message text, and (where it applies) a minimum threshold. See “Variables → In Chat Alerts” above for the placeholders each alert type supports.

Subscription, resub, gift, mass-gift, raid, bits, and follower alerts work immediately. Hype Train, Charity, Ad Break, Poll, and Prediction alerts need extra Twitch permissions from the broadcaster — if any of those stay silent, have the broadcaster sign out and back in once on the dashboard to grant them.

OBS overlay

A browser source (/twitch/cups/overlay) that shows the live cup status on stream. Configurable in the dashboard: dark or light, an accent colour, side-by-side or stacked layout, with or without a card frame, scale, whether the countdown shows, and whether it hides entirely when no cup is live or shows only while one is running. Copy the finished URL or open it directly, then add it as an OBS Browser Source — the dashboard also shows the recommended pixel size once the preview has loaded.

Switching from Fossabot#

The channel overview has a “Fossabot import” dialog with three independent imports, so switching does not mean starting from zero:

• Commands — fetched automatically from Fossabot’s public command list for the channel, no login needed on the Fossabot side.
• Timers — pasted in, one message per line; add “| minutes” after a line to set its interval, otherwise 15 minutes is used.
• Blocked terms — pasted in, one phrase per line.

Fossabot doesn’t expose timers or blocked terms through a public API, which is why those two need pasting instead of a one-click fetch.

Examples#

Chat

Your own command

$(user) targets the person named in the command — with !search @Test → @Test | …, $(user) resolves to Test, not to whoever typed the command. Without a named person it falls back to the caller, just like $(touser). To always mention the caller themself, use $(sender) instead.

FAQ#