Kanin's BotBaseAutomations - Settings
Module
| Setting | Default | What it does |
|---|---|---|
| Module switch (top of the panel) | On | While off, no rule runs. /automations enable and /automations disable do the same |
| Command switches (Commands tab) | All on | Turn single /automations subcommands off |
Rule fields
| Field | Default | What it does |
|---|---|---|
| Rule Name | Required | Shown in the rule list, /automations commands and logs |
| Description | Empty | A note for your team |
| Enabled | On | A disabled rule never runs |
| Run this rule when | When a message is sent | The trigger; scheduled rules add their schedule here, spam rules their threshold (below) |
| Conditions | None | Condition groups (see Conditions Reference) |
| Actions | None | What the rule does, in order (see Actions Reference) |
Trigger settings
Some triggers show settings of their own under Run this rule when:
| Field | Trigger | Default | What it does |
|---|---|---|---|
| Also check edited messages | When a message is sent | Off | Run the rule again when a message is edited (see Notes on triggers) |
| Staff actions | Moderation triggers | On | Run for warns, timeouts, kicks, bans and notes staff made, with a command or in Discord |
| Automatic actions | Moderation triggers | On | Run for the ones automation rules, infraction thresholds, anti-spam or bots made, and for timeouts that ran out. One of the two stays on |
Spam trigger settings
Spam triggers show their settings under Run this rule when (see Spam triggers):
| Field | Default | What it does |
|---|---|---|
| Anti-Spam settings / Own threshold | Anti-Spam settings | Use the detector's threshold on the Anti-Spam tab (only while it is on), or the rule's own. Not on Any spam detected, which always uses the detectors |
| Amount | The detector's default | With an own threshold: how many messages, mentions, links, emoji, lines, ... (or joins, new threads) trip the rule |
| Within (seconds) | The detector's default | With an own threshold: the window they must fall in, 1 to 3600 seconds |
| Count per channel | Off | With an own threshold, per-member triggers: count each channel on its own instead of across the server |
| Keep cleaning for (seconds) | 10 | Per-member triggers: how long after it fired the rule does not fire again for the member, and, when it deletes spam, deletes their further messages of that kind silently. 0 to 60; 0 turns it off |
Advanced
| Field | Default | What it does |
|---|---|---|
| Cooldown (seconds) | 0 (off) | Minimum time between two runs of this rule |
| Cooldown applies to | Whole rule | With a cooldown: Whole rule (one cooldown for everyone), Per member (each member has their own) or Per channel (each channel has its own). Events without a member or channel share the rule's cooldown |
| Max executions per user | 0 (no limit) | How many times the rule may run for the same member, ever. Failed runs do not count |
| Rule order | 0 | Rules with the same trigger run from the lowest number up |
| Allow further rules | On | Off stops later rules for this event after this one ran successfully (ran at least one action). On a message this also stops its spam rules, and on a spam trigger the later spam triggers for that message |
| Log to mod log | Off | Posts an Automation Rule Fired entry to Mod Logs (the Bot Automations log type) each time the rule runs: what it matched, how many actions succeeded, and each action that failed with why, also when all of them failed |
| Include bots and webhooks | Off | When a message is sent: also run for messages from other bots and webhooks (the spam detectors never count them) |
| Include the bot's own events | Off | Also run for the bot's own messages, reactions, role and nickname changes, threads and so on. Messages a rule posted never count. Not shown for triggers without a person behind them (schedules, anti-raid level changes, channels and roles) or for spam triggers, since spam detection never counts the bot |
Limits that apply to every rule:
- At most 30 rule runs per minute per server; further rules are skipped until the minute has passed.
- Wait before the next action pauses for at most 30 seconds.
- Chains of rules set off by other rules' actions stop after two rounds.
Run history
Each rule counts its runs (the "runs" figure on the Rules tab, /automations list and /automations stats). The bot also keeps a record of each run (the rule, the member and channel, what the conditions or the spam threshold matched, and whether all actions succeeded) for 30 days, or longer where a rule's Max executions per user needs it to count past runs. Only the run counts are shown in the dashboard.
A warn, timeout, kick or ban a rule hands out records a moderation case with the action's Reason. What the rule matched is not added to the case as proof; turn on Log to mod log to have it posted with each run.
Logs tab
The Logs tab shows the staff log filtered to Automations: who created, changed, deleted or toggled a rule, and who turned the module on or off, from the dashboard or with /automations.
Click an entry to see exactly what was done. An edit lists every setting it changed, before and after: the trigger and its options, a condition inside its group, an action with its type next to the fields that changed, an action added or removed, cooldowns and the other options.
A created rule's entry holds the whole rule as it was saved, and a deleted rule's the whole rule as it was when deleted, so a rule can be read back from the log alone.