Starboard

Plugin name: starboard

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

Commands

Name	Description	Default Level	Usage
!stars show {mid}	Displays the given starred message	Trusted	!stars show 320312743842545664
!stars stats [user]	Presents starboard statistics for the whole server or the given user	Moderator	!stars stats OR !stars stats 232921983317180416
!stars block {user}	Prevents the user from starring any messages and prevents their messages from being starred	Moderator	!stars block @HepBoat#0361 OR !stars block 520047158104424488
!stars unblock {user}	Unblocks a user from the starboard	Moderator	!stars unblock @HepBoat#0361 OR !stars unblock 520047158104424488
!stars hide {mid}	Hides a starred message from the starboard	Moderator	!stars hide 320312743842545664
!stars unhide {mid}	Unhides a hidden message	Moderator	!stars unhide 320312743842545664
!stars lock	Prevents any new starred messages from being posted to the starboard	Administrator	!stars lock
!stars unlock	Enables starred messages to be posted	Administrator	!stars unlock
!stars check {mid}	Updates star reaction count on given message	Administrator	!stars check 320312743842545664
!stars update	Updates reaction count for the whole starboard	Administrator	!stars update

Configuration Options

Option	Description	Type	Default
channels	A mapping of channels to Starboard Configurations	dict	empty

Starboard Configuration

Option	Description	Type	Default
channels	Sets which channel starred messages should be posted to	dict	empty
clear_on_delete	Whether a starboard entry is deleted if the original message is deleted	bool	true
min_stars	Minimum number of star reactions required before a message is posted to the starboard	int	1
star_color_max	Sets the "max" star level. Changes shading of rich embed bar color per level and gives the starboard entry a different emoji at max level	int	15
prevent_self_star	Whether to prevent a user from starring their own message	bool	false
sources	Channels to post starred posts from	dict	empty
ignored_channels	Channels to ignored starred posts from	dict	empty

Configuration Example

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