Documentation menu

Docs/Plugins/Plugins Overview

Plugins Overview

Every plugin, what it does, and how to switch it on.

HepBoat's behaviour is organised into plugins. Most configurable plugins run only if their block exists under plugins: in your config, and an empty block enables their defaults. Feature-gated plugins still need their grant, while Global and Discord AutoMod logging are always-on services. Custom Commands is also unusual: scripts can be managed without a block, and execution follows its feature grant unless you explicitly set enabled: false.

plugins:
  utilities: {}
  starboard:
    channels:
      665875009507426304:
        min_stars: 4

Start with the Plugin Setup Checklist for the permissions, safe rollout, Diagnostics, and verification steps shared by every feature. Then use the plugin page below for its exact settings.

Setup checklist

  1. Give staff dashboard access and Discord command levels on Setup > Access & Permissions.
  2. Set up a mod log channel before automatic moderation.
  3. Open the plugin's page, check for a feature lock, and save its block.
  4. Run Diagnostics, then follow the plugin page's test with a non-staff member.
  5. Confirm the member response, mod log event, and dashboard record before widening the feature to the whole server.

The plugins

Plugin What it does
Infractions Warnings, mutes, kicks, bans and friends - numbered, searchable, reversible, with timed expiry, reports, self-mutes and ban appeals.
Censor Content filtering: invites, domains, words/tokens, zalgo, caps, mentions, nicknames - plus an anti-raid layer.
Spam Rate-based anti-spam: messages, mentions, duplicates, links, attachments and more, with per-level rules and automatic punishment.
Image Scan Catches scams that arrive as pictures: fingerprint matching against images your mods teach, optional OCR through your censor lists.
Honeypot Trap channels that automatically action bots posting where no human would.
Mod Log Renders 109 action types (native Discord AutoMod included) into the channels you choose, with per-channel routing and optional custom formats.
Admin Role management, persistence across rejoins, join roles, welcomes, archives and moderator utilities.
Applications Application forms for your server - staff apps, whitelist requests and signups, reviewed from Discord or the dashboard queue.
Auto Level XP, levels, role rewards, rank cards and a public web leaderboard, with multiple tracks and custom curves.
AutoMod Manage Discord's native AutoMod rules from the dashboard, and log every AutoMod action.
Custom Commands Your own commands and auto-responders, written in a small scripting DSL with a dashboard workbench.
Starboard Star-reaction boards, multiple boards per server.
Tags Save and recall snippets of text.
RSS Feeds Post new items from RSS, Atom or RDF feeds to your channels, with custom messages, keyword filters and an optional role ping.
Games A per-server economy: earn currency, play casino games from blackjack to the bank heist, go fishing, invest in the market, and spend it in the role and flair shop.
Quests Server-authored quests over games, the economy and everyday activity, paid in coins, XP or a role and claimed by the member.
Music Voice-channel music playback with a queue and DJ role.
Utilities Info commands, reminders, per-channel posting rules, sticky messages, auto-clean, announcements, fun commands.
Global Always-on basics: about, help, docs, dashboard links.
Commands Not a plugin - how the command system itself works: prefix, slash opt-in, levels, overrides, lockdowns.

Two plugins from earlier generations of HepBoat - Reddit and Twitch feeds - were retired in the rewrite. For channel feeds, use the RSS Feeds plugin.

Feature flags

Some systems are gated by per-server feature grants, managed by the operator. When your server lacks a grant, the dashboard shows a lock banner on the respective page instead of letting you configure something the bot would ignore.

Flag Name Locked without it
LEVELS_PRO Pro Leveling The server-wide default rank-card background is ignored; Members cannot set a custom rank-card background; Backgrounds already saved are kept, but not rendered on cards
MODLOG_CUSTOM_FORMAT Custom Mod-Log Formats modlog.custom. overrides are ignored, so the built-in format is used
MUSIC Music All music commands (play / pause / skip / queue / …) are disabled
NETWORKS Server Networks (own) Creating a network; Accepting a network invite
APPEALS Ban Appeals Enabling / serving the appeal form; Pre-ban appeal-link DMs to banned users
WEB_API External Web API Issuing API keys; All /api/v1 endpoints (read / import / export)
WEB_API_WRITE Web API: write & moderate /api/v1 endpoints using the moderate or write scope (read / import / export still work under WEB_API)
HONEYPOT Honeypot Honeypot trap channels stop firing (no auto-action / cleanup)
RANK_CARDS Rank Cards Rank / profile commands reply with text instead of an image card
AUTOMOD_DASH AutoMod Dashboard Dashboard-driven AutoMod create / edit / delete (logging + mirror still work)
IMAGE_SCAN Image Scam Scanning The imagescan plugin: fingerprint matching, the !scamimage commands, and the Image Scan dashboard page
IMAGE_SCAN_OCR Image Scam Scanning: OCR OCR of posted images (fingerprint matching keeps working without this)
CUSTOM_COMMANDS Custom Commands (execution) Execution of CMD custom commands and every LISTEN trigger (the cc management commands and the dashboard workbench keep working)
GLOBAL_NETWORK Global Ban Network (join) Opting in to the global network (an existing member is NOT ejected by revoking this; they leave via the normal leave action)
SCAM_SUBMISSIONS Scam List Submissions The "Submit to global" action on the Image Scan page is unavailable, so fingerprints cannot be offered for the fleet-wide list
GAMES Games & Economy All economy and game commands (balance / pay / daily / slots / blackjack / ...) are disabled; The role shop and flair shop are closed; balances and past purchases are kept; Rank-card flair that members already bought is kept, but not drawn on cards; The public games leaderboard page is unavailable
APPLICATIONS Applications Applications cannot be created, posted, or submitted on this server
APPLICATIONS_PRO Applications Pro This server is limited to 3 applications with 10 questions each; Custom application status messages will not be used; Submission threads will not be created
RSS RSS feeds Feeds are not checked and nothing is posted on this server
QUESTS Quests Quests are not tracked and cannot be claimed on this server
QUESTS_PRO Quests Pro This server is limited to 5 quests; Quests can only pay coins, not XP or a role
PREMIUM Premium New premium-gated features are unavailable (each also lists its own flag here)
FOUNDERS_PREMIUM Founders Premium The server is not on the founders plan (no behavior locks by itself)
WHITELISTED Whitelisted (service) On a whitelist-only instance the bot will not set up (new invite) or serve (existing server) without it