Skip to main content

Starboard

Plugin name: starboard

The starboard plugin provides an ongoing board of highlighted messages through community voting.

Commands

NameDescriptionDefault LevelUsage
!stars show {mid}Displays the given starred messageTrusted!stars show 320312743842545664
!stars stats [user]Presents starboard statistics for the whole server or the given userModerator!stars stats OR !stars stats 232921983317180416
!stars block {user}Prevents the user from starring any messages and prevents their messages from being starredModerator!stars block @HepBoat#0361 OR !stars block 520047158104424488
!stars unblock {user}Unblocks a user from the starboardModerator!stars unblock @HepBoat#0361 OR !stars unblock 520047158104424488
!stars hide {mid}Hides a starred message from the starboardModerator!stars hide 320312743842545664
!stars unhide {mid}Unhides a hidden messageModerator!stars unhide 320312743842545664
!stars lockPrevents any new starred messages from being posted to the starboardAdministrator!stars lock
!stars unlockEnables starred messages to be postedAdministrator!stars unlock
!stars check {mid}Updates star reaction count on given messageAdministrator!stars check 320312743842545664
!stars updateUpdates reaction count for the whole starboardAdministrator!stars update

Configuration Options

OptionDescriptionTypeDefault
channelsA mapping of channels to Starboard Configurationsdictempty

Starboard Configuration

OptionDescriptionTypeDefault
channelsSets which channel starred messages should be posted todictempty
clear_on_deleteWhether a starboard entry is deleted if the original message is deletedbooltrue
min_starsMinimum number of star reactions required before a message is posted to the starboardint1
star_color_maxSets the "max" star level. Changes shading of rich embed bar color per level and gives the starboard entry a different emoji at max levelint15
prevent_self_starWhether to prevent a user from starring their own messageboolfalse
sourcesChannels to post starred posts fromdictempty
ignored_channelsChannels to ignored starred posts fromdictempty

Configuration Example

  starboard:
channels:
301118039326457867:
clear_on_delete: true
min_stars: 6
star_color_max: 15
prevent_self_star: true
ignored_channels: []
sources: []