Spooky's documentation
Configuration
Boarding

Boarding

Comprehensive guide on setting up and managing reaction-based boards in your server.

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

/

/board setup

Set up a board in the chosen channel with a specific emoji and threshold.

Configuration

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

/

/board remove

Remove the existing configuration for the specified board.

Configuration

Parameters

[board_type]The type of board to remove configuration for.
Parameters:
  • board_type: The type of board to remove (starboard, clownboard, or skullboard).
Example:

Status Board

/

/board status

Check the current setup, emoji, and threshold of the specified board.

Configuration

Parameters

[board_type]The type of board to check the status of.
Parameters:
  • board_type: The type of board to check the status of (starboard, clownboard, or skullboard).
Example:

Blacklist Board

/

/board blacklist

Add a channel to the board blacklist so it won't be posted to any board.

Configuration

Parameters

[channel]The channel to blacklist from receiving board posts.
Parameters:
  • channel: The channel to blacklist from all board posting.
Example:

Unblacklist Board

/

/board unblacklist

Remove a channel from the board blacklist.

Configuration

Parameters

[channel]The channel to remove from the blacklist.
Parameters:
  • channel: The channel to remove from the blacklist.
Example:

Status Blacklist

/

/board blacklist_status

Display all channels that are blacklisted from boarding in this guild.

Configuration
Example:

Setup Pin

/

/board pin setup

Set up the pin board for the server.

Configuration

Parameters

[channel]The channel where pinned messages should be sent.
Parameters:
  • channel: The channel where pinned messages should be sent.
Example:

Remove Pin

/

/board pin remove

Remove the pin board for the server.

Configuration
Example:

Status Pin

/

/board pin status

Display the configuration for the pin board.

Configuration
Example:

Blacklist Pin

/

/board pin blacklist

Add a channel to the pin board blacklist so it won't receive pinned messages.

Configuration

Parameters

[channel]The channel to blacklist from receiving board posts.
Parameters:
  • channel: The channel to blacklist from the Pin Board.
Example:

Unblacklist Pin

/

/board pin unblacklist

Remove a channel from the pin board blacklist.

Configuration

Parameters

[channel]The channel to remove from the blacklist.
Parameters:
  • channel: The channel to remove from the Pin Board blacklist.
Example:

Status Blacklist Pin

/

/board pin blacklist_status

Display all channels that are blacklisted from pin board in this guild.

Configuration
Example:

How the Boarding Feature Works

Reaction-Based Boards

  1. Setup: Use /board setup to define the board type, channel, emoji, and threshold.
  2. Trigger: When a message receives the specified emoji and exceeds the threshold, it is sent to the configured board channel.
  3. Updates: Reaction counts on the board message update dynamically as users add or remove reactions.

Pin Board

  1. Setup: Configure a Pin Board using /board pin setup.
  2. Trigger: When a message is pinned in any channel, it is sent to the configured Pin Board channel.
  3. Blacklist: Channels can be blacklisted using /board pin blacklist to prevent their pinned messages from being posted.

Blacklist Management

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.