Boarding
The Boarding feature enables server administrators to create reaction-based boards like Starboard, Clownboard, Skullboard, and Pin Board. These boards highlight messages based on reaction thresholds or pinned status. You can also blacklist specific channels from each board.
Commands
Setup Board
Parameters
[board_type]The type of board to set up.
[channel]The channel where the board messages will be sent.
[emoji]The emoji that triggers the board when reacted to.
[threshold]The number of reactions required to post the message to the board.
Parameters:
board_type
: The type of board to set up (starboard, clownboard, or skullboard).channel
: The channel where messages meeting the criteria will be sent.emoji
: The emoji that triggers the board when reacted to.threshold
: The number of reactions required to post the message to the board (range: 1-10).
Example:
Remove Board
Parameters:
board_type
: The type of board to remove (starboard, clownboard, or skullboard).
Example:
Status Board
Parameters:
board_type
: The type of board to check the status of (starboard, clownboard, or skullboard).
Example:
Blacklist Board
Parameters:
channel
: The channel to blacklist from all board posting.
Example:
Unblacklist Board
Parameters:
channel
: The channel to remove from the blacklist.
Example:
Status Blacklist
Example:
Setup Pin
Parameters:
channel
: The channel where pinned messages should be sent.
Example:
Remove Pin
Example:
Status Pin
Example:
Blacklist Pin
Parameters:
channel
: The channel to blacklist from the Pin Board.
Example:
Unblacklist Pin
Parameters:
channel
: The channel to remove from the Pin Board blacklist.
Example:
Status Blacklist Pin
Example:
How the Boarding Feature Works
Reaction-Based Boards
- Setup: Use /board setup to define the board type, channel, emoji, and threshold.
- Trigger: When a message receives the specified emoji and exceeds the threshold, it is sent to the configured board channel.
- Updates: Reaction counts on the board message update dynamically as users add or remove reactions.
Pin Board
- Setup: Configure a Pin Board using /board pin setup.
- Trigger: When a message is pinned in any channel, it is sent to the configured Pin Board channel.
- Blacklist: Channels can be blacklisted using /board pin blacklist to prevent their pinned messages from being posted.
Blacklist Management
- Use /board blacklist or /board pin blacklist to restrict channels from board posting.
- /board blacklist_status and /board pin blacklist_status display all blacklisted channels for each respective board type.
Notes
- Permissions: The bot requires permissions to send messages, manage messages, and embed links in the specified board channels.
- Emoji Validity: Ensure the emoji used is either a standard Unicode emoji or a valid custom guild emoji.
- Multiple Boards: Different board types (Starboard, Clownboard, Skullboard) can use unique emojis and thresholds.
- Rate Limiting: Commands like /board setup and /board pin setup are rate-limited to avoid accidental misuse.
The Boarding feature is a powerful tool for highlighting and archiving important or engaging messages within your server.