Docs/Plugins/Starboard
Starboard
Star-reaction boards - multiple per server, each with its own emoji, sources and thresholds.
React with ⭐ and, once a message collects enough stars, it gets posted to a board channel. HepBoat supports multiple independent boards, and you can set them up on the dashboard's Setup → Starboard page instead of by hand.
plugins:
starboard:
channels:
665875009507426304: # the board channel
min_stars: 4
clear_on_delete: true
prevent_self_star: true
sources: # only watch these channels
- 661841080152752169
Each board is keyed by its board channel and configures its own behaviour.
Choosing what a board watches
sourcesis an allowlist: set it and the board only ever picks up messages from those channels. Leave it empty and the board watches the whole server.ignored_channelssubtracts instead - useful when you want everything except a couple of channels.- A board channel is never a source for itself, so starring a board post cannot loop it back onto the board.
Thresholds and behaviour
min_stars- how many reactions a message needs before it is posted.prevent_self_star- stop members starring their own messages. The rejected reaction is removed, so the count on the source message matches what the board actually counted.clear_on_delete- remove the board entry when the original message is deleted.star_color_max- the star count at which the entry's colour reaches the top of its range.
Emoji, and the two modes
By default a board watches ⭐ and runs in classic mode: the entry's
emoji escalates from ⭐ to 🌟 as the count climbs, and its colour ramps from
yellow toward orange, reaching full colour at star_color_max.
Set emoji to any other unicode emoji and that board switches to lite
mode: it watches your emoji instead, and the entry keeps a static emoji
and a fixed colour with no escalation.
Custom server emojis are not supported - only unicode ones. A renamed or deleted custom emoji would silently break the board at runtime, so it is refused when you save instead.
Because each board has its own emoji and its own sources, you can run several at once over the same channels: a ⭐ board for the usual highlights and, say, a 📌 board that a different set of people curate.
Commands
| Command | What it does |
|---|---|
/stars block |
Block a user from contributing stars on the starboard. |
/stars unblock |
Lift a stars block. |
/stars hide |
Hide a starboard entry by source message id. |
/stars unhide |
Un-hide a previously hidden starboard entry. |
/stars hidden |
List starboard entries that are currently hidden. |
/stars show |
Re-display a starboard entry by source or starboard message id. |
/stars stats |
Show overall or per-user starboard stats. |
/stars check |
Re-sync one starboard entry against actual Discord reactions (admin). |
/stars update |
Re-sync the newest 100 posted starboard entries (admin). |
/stars lock |
Lock the starboard so no new entries post (admin). |
/stars unlock |
Unlock the starboard. |