Skip to content

starboard.md

Latest commit

 

History

History
110 lines (91 loc) · 4.38 KB

starboard.md

File metadata and controls

110 lines (91 loc) · 4.38 KB
Raw

Starboard plugin

Posts popular messages to a dedicated channel when they collect enough star reactions. Configure named boards in YAML, set a channel and minimum stars, and Dreamliner handles the rest.

Starred messages are tracked in the database, so counts and starboard posts survive bot restarts.

Configuration

plugins:
  starboard:
    enabled: true
    config:
      # Global defaults (apply to every board)
      ignored_channels: []
      ignored_roles: []
      allow_bot_messages: false
      allow_nsfw: true
      # color: 16744272
      boards:
        main:
          channel_id: "1234567890123456789"
          stars_required: 3
          enabled: true
          show_star_count: true
          copy_full_embed: true
          count_self_stars: false
          ignored_channels: []
          ignored_roles: []
          # allow_bot_messages: true   # optional override
          # allow_nsfw: false          # optional override
          # color: 16744272            # optional override
          star_emoji:
            - "⭐"

Global defaults

Field Description
ignored_channels Channel IDs where star reactions are ignored for all boards
ignored_roles Role IDs whose members cannot be starred (author filter) for all boards
allow_bot_messages When true, bot messages can be posted (default false)
allow_nsfw When true, messages from NSFW channels can be posted (default true)
color Default embed color as a decimal integer (optional)

Per-board fields

Field Description
channel_id Text channel where starred messages are posted
stars_required Minimum number of star reactions needed
enabled Turn this board on or off
star_emoji Reaction emojis to count (default ⭐). Supports custom emojis like <:star:1234567890>
show_star_count Show the star count on a disabled button below the post
copy_full_embed Include embeds from the original message
count_self_stars When true, the message author's own star reaction counts (default false)
ignored_channels Extra ignored channels for this board (merged with global)
ignored_roles Extra ignored roles for this board (merged with global)
allow_bot_messages Optional override of the global bot-message setting
allow_nsfw Optional override of the global NSFW setting
color Optional override of the global embed color

Merge rules

  • Channel and role ignore lists are the union of global + board.
  • allow_bot_messages, allow_nsfw, and color use the board value when set; otherwise the global default.

You can define multiple boards with different names, channels, thresholds, or emojis:

plugins:
  starboard:
    config:
      boards:
        main:
          channel_id: "1234567890123456789"
          stars_required: 5
        highlights:
          channel_id: "9876543210987654321"
          stars_required: 10
          star_emoji:
            - "🌟"

Set enabled: false on the plugin section to turn starboard off without removing your board settings.

Behavior

  • When a message reaches stars_required stars, the bot posts it to the starboard channel with a link back to the original.
  • If reactions are removed and the count drops below the threshold, the starboard post is removed.
  • If the original message is deleted, the starboard post is removed too.
  • Messages already in a starboard channel are ignored.
  • Messages in ignored channels (global or board) are ignored.
  • Messages from authors with an ignored role (global or board) are ignored.
  • Bot messages are ignored unless allow_bot_messages is enabled (board override or global).
  • NSFW source channels are allowed unless allow_nsfw is disabled.
  • By default, the message author's own star does not count. Set count_self_stars: true on a board to include it.

Requirements

  • The bot needs Read Message History, Send Messages, and Embed Links in the starboard channel.
  • Reactions on older messages (including before a bot restart) are supported. The bot fetches uncached messages when someone reacts.

Setup

  1. Create a #starboard channel in Discord.
  2. Open the dashboard with /config.
  3. Set plugins.starboard.config.boards.main.channel_id to your starboard channel ID.
  4. Set stars_required to your preferred minimum (e.g. 3), then Save.