Emote Boards: Starboard Re-implementation, Minor Fixes #850

jkriste · 2023-06-04T20:21:18Z

🪧 Emote Boards

This PR adds a new feature in replacement of starboard. Emote boards are the generic version of starboard:

An emote board is added and given a channel for ClemBot to repost messages to.
Given enough reactions on a message, the message will be reposted.

In addition to features present in starboard, emote boards also support:

Multiple emote boards per server.
Unicode and custom emojis.
The ability for ClemBot to repost content to multiple channels per emote board.
A leaderboard with multiple categories for general and specific emote boards.
Message persistence and automatic management of reposted content (for up to 30 days).
Per-Emote Board configuration/customization.

Resolves #821.
Resolves #782.
Resolves #645.
Resolves #635.
Resolves #331.
Resolves #234.

⚙️ Commands

NOTE: When a emoteboard parameter is present, this refers to either the board's name or the board's emote.

Signature: emoteboard [emoteboard]
Use: Displays all emote boards in the server or the info for a given emote board.
Aliases: board, boards, eb, emojiboard
Example: boards, board :star:, board starboard

Add

Signature: emoteboard add <emote> <name> <channel>
Use: Creates an emote board and attaches it to the given channel.
Required Claims: manage_emote_boards
Aliases: create
Example: emoteboard add :star: starboard #starboard, emoteboard add :a_custom_emote: myboard #my-board

Remove

Signature: emoteboard remove <emoteboard>
Use: Deletes the emote board from the server.
Required Claims: manage_emote_boards
Aliases: delete
Example: emoteboard remove :star:, emoteboard remove starboard

Leaderboard

Signature: emoteboard leaderboard [emoteboard]
Use: Displays the leaderboard for ALL emote boards in the server or for the given emote board.
Aliases: top
Example: emoteboard leaderboard :star:, emoteboard leaderboard, emoteboard leaderboard starboard

Here are the current leaderboard categories that are implemented:

Users ordered by total reactions received.
Users ordered by number of posts.
Posts ordered by highest number of reactions received on one post.

Set Threshold

Signature: emoteboard set threshold <emoteboard> <threshold>
Use: Sets the reaction threshold (the number of reactions in order to post) for the given emote board.
Required Claims: manage_emote_boards
Aliases: limit, reactions, emotes
Example: emoteboard set threshold :star: 4, emoteboard edit threshold starboard 4

Set Bots

Signature: emoteboard set bots <emoteboard> <allow bot posts>
Use: Sets whether bot messages can be reposted to this given emote board.
Required Claims: manage_emote_boards
Aliases: bot, allow_bots, bot_posts
Example: emoteboard set bots :star: true, emoteboard set allow_bots starboard false

Set Emote

Signature: emoteboard set emote <board name> <emote>
Use: Sets the emote for the given board.
Required Claims: manage_emote_boards
Aliases: emoji
Example: emoteboard set emote starboard :star:, emoteboard set emoji starboard :a_custom_emote:

Channel Add

Signature: emoteboard channel add <emoteboard> <channel>
Use: Adds a channel to the given emote board.
Required Claims: manage_emote_boards
Example: emoteboard channel add :star: #my-channel, emoteboard channel add starboard #starboard

Channel Remove

Signature: emoteboard channel remove <emoteboard> <channel>
Use: Removes the given channel from the given emote board, if present.
Required Claims: manage_emote_boards
Aliases: delete
Example: emoteboard channel remove :star: #my-channel, emoteboard channel delete starboard #starboard

ℹ️ Other

CONTRIBUTING.md and README.md have been improved by:
- Reformatting (along with)
- Minor visual improvements
- Better hyperlinks
- Grammar fixes
Removed left behind/unused gifMe token from BotSecrets.
on_raw_reaction_add has been implemented in clem_bot.py
The library emoji was added to support unicode-based emojis (and for verification that we're given an actual emoji).
Dependencies have been updated.

✅ To-Do

Finish API-side of feature.
Finish bot-side of feature.
Talk with J on the best way to do leaderboards.
Finish documentation of feature.
Replace Starboard mention in README.
Test
~~Beg J and Milo to review the PR~~

github-actions · 2023-06-16T09:15:31Z

Black linting failed: Please run poetry run black bot from the ClemBot.Bot folder

github-actions · 2023-06-16T09:15:31Z

Static type linting failed: Please see CI error output for details and fix the PRs typing

github-actions · 2023-06-20T07:30:50Z

Black linting failed: Please run poetry run black bot from the ClemBot.Bot folder

github-actions · 2023-06-20T07:30:50Z

Static type linting failed: Please see CI error output for details and fix the PRs typing

github-actions · 2023-07-05T19:38:59Z

Static type linting failed: Please see CI error output for details and fix the PRs typing

github-actions · 2023-07-21T05:35:52Z

isort linting failed: Please run poetry run isort . from the ClemBot.Bot folder

github-actions · 2023-07-21T05:35:52Z

Black linting failed: Please run poetry run black bot from the ClemBot.Bot folder

I was too lazy to try and summarize the feature in 1 sentence.

jkriste · 2023-07-23T21:52:28Z

@Jay-Madden bug has been fixed and is now ready for review 👍🏻

github-actions · 2023-07-24T04:39:00Z

Static type linting failed: Please see CI error output for details and fix the PRs typing

github-actions · 2023-07-24T04:57:37Z

Static type linting failed: Please see CI error output for details and fix the PRs typing

ClemBot.Bot/bot/api/emote_board_route.py

ClemBot.Bot/bot/utils/helpers.py

Jay-Madden · 2023-08-05T23:44:56Z

Hmm, this doesnt appear to handle super reactions. how do we want to deal with that?

Jay-Madden

Fantastic excellent PR overall, some general comments and nitpicks.

i dont think we need to channel add subcommand? or the board name? not fully following the use for that

ClemBot.Api/ClemBot.Api.Data/Models/EmoteBoard.cs

ClemBot.Bot/bot/clem_bot.py

ClemBot.Bot/bot/bot_secrets.py

ClemBot.Api/.editorconfig

ClemBot.Bot/bot/services/emote_board_service.py

ClemBot.Bot/bot/api/emote_board_route.py

ClemBot.Bot/bot/services/emote_board_service.py

ClemBot.Bot/bot/cogs/emote_board_cog.py

ClemBot.Bot/bot/utils/converters.py

Jay-Madden · 2023-08-06T01:18:10Z

Closed and reopened to trigger docs preview build

Jay-Madden · 2023-08-06T01:39:22Z

Also, we should add this functionality to the readme

netlify · 2023-08-06T23:16:38Z

❌ Deploy Preview for clembotdocs failed.

Name	Link
🔨 Latest commit	`6063ca9`
🔍 Latest deploy log	https://app.netlify.com/sites/clembotdocs/deploys/64d3161f3baa03000886c6d7

github-actions · 2023-08-07T04:48:30Z

Static type linting failed: Please see CI error output for details and fix the PRs typing

Jay-Madden

yolo

…t#850)

jkriste added 7 commits May 21, 2023 03:09

Rough outline of API + bot files/minor functionality

584dc16

Minor changes, more file scaffolding

f3583d7

More outlining + filling in the dots here and there, new library

1a80ddd

Push for J

2ad5568

A good portion of the API is done :)

b2705db

Merge remote-tracking branch 'ClemBotProject/master' into starboardTLC

a666f9a

New library, updated MD files, further progress on PR

04cc048

jkriste self-assigned this Jun 4, 2023

jkriste added documentation Improvements or additions to documentation enhancement New feature or request Large Feature This feature is indepth and will require changes in multiple places dependencies Pull requests that update a dependency file labels Jun 4, 2023

jkriste added 3 commits June 7, 2023 17:25

Quick push to sync w/ laptop

5354839

Large API overhaul + minor refactors on the bot-side

0f403c9

Almost done with API, bot-side is close as well

a042887

Sync with laptop

a3936a7

it's testing time (leaderboards not done yet, i'm lazy)

1e99fb5

Documentation is all that is left

ea95327

jkriste added 3 commits July 21, 2023 01:37

linting

c2f02c8

Documentation finished + minor fixes, polishing

da3d74c

Remove starboard mention in README

05a7349

I was too lazy to try and summarize the feature in 1 sentence.

jkriste marked this pull request as ready for review July 23, 2023 08:28

Remove unnecessary import from prior commit

a44634f

jkriste requested review from Jay-Madden, Iapetus-11 and smathep July 23, 2023 21:54

Better documentation, removed unnecessary converter.

cd0dc3f

Fix mute duration in mute doc

c390ed8

had no idea i was even using the converter...it's been a long time

a82dbc6

Iapetus-11 reviewed Jul 31, 2023

View reviewed changes

ClemBot.Bot/bot/api/emote_board_route.py Outdated Show resolved Hide resolved

Iapetus-11 reviewed Jul 31, 2023

View reviewed changes

ClemBot.Bot/bot/api/emote_board_route.py Show resolved Hide resolved

Iapetus-11 reviewed Jul 31, 2023

View reviewed changes

ClemBot.Bot/bot/utils/helpers.py Outdated Show resolved Hide resolved

Remove useless import, emit typing.Union, small reformat

ec85f49

Jay-Madden requested changes Aug 6, 2023

View reviewed changes

Jay-Madden closed this Aug 6, 2023

Jay-Madden reopened this Aug 6, 2023

Merge remote-tracking branch 'ClemBotProject/master' into starboardTLC

995756c

Implemented most changes requested

801e937

jkriste added 2 commits August 7, 2023 00:50

Refactor constant name change (i forgor)

a753992

Add docs

6063ca9

jkriste requested a review from Jay-Madden August 9, 2023 04:42

Jay-Madden approved these changes Oct 20, 2023

View reviewed changes

Jay-Madden merged commit 9d0c6df into ClemBotProject:master Oct 20, 2023
2 checks passed

jkriste deleted the starboardTLC branch October 23, 2023 16:03

Jay-Madden pushed a commit to Jay-Madden/ClemBot that referenced this pull request Jan 27, 2024

Emote Boards: Starboard Re-implementation, Minor Fixes (ClemBotProjec…

3ee04ff

…t#850)

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Emote Boards: Starboard Re-implementation, Minor Fixes #850

Emote Boards: Starboard Re-implementation, Minor Fixes #850

jkriste commented Jun 4, 2023 •

edited

Loading

github-actions bot commented Jun 16, 2023

github-actions bot commented Jun 16, 2023

github-actions bot commented Jun 20, 2023

github-actions bot commented Jun 20, 2023

github-actions bot commented Jul 5, 2023

github-actions bot commented Jul 21, 2023

github-actions bot commented Jul 21, 2023

jkriste commented Jul 23, 2023

github-actions bot commented Jul 24, 2023

github-actions bot commented Jul 24, 2023

Jay-Madden commented Aug 5, 2023

Jay-Madden left a comment

Jay-Madden commented Aug 6, 2023

Jay-Madden commented Aug 6, 2023

netlify bot commented Aug 6, 2023 •

edited

Loading

github-actions bot commented Aug 7, 2023

Jay-Madden left a comment

Emote Boards: Starboard Re-implementation, Minor Fixes #850

Emote Boards: Starboard Re-implementation, Minor Fixes #850

Conversation

jkriste commented Jun 4, 2023 • edited Loading

🪧 Emote Boards

⚙️ Commands

Add

Remove

Leaderboard

Set Threshold

Set Bots

Set Emote

Channel Add

Channel Remove

ℹ️ Other

✅ To-Do

github-actions bot commented Jun 16, 2023

github-actions bot commented Jun 16, 2023

github-actions bot commented Jun 20, 2023

github-actions bot commented Jun 20, 2023

github-actions bot commented Jul 5, 2023

github-actions bot commented Jul 21, 2023

github-actions bot commented Jul 21, 2023

jkriste commented Jul 23, 2023

github-actions bot commented Jul 24, 2023

github-actions bot commented Jul 24, 2023

Jay-Madden commented Aug 5, 2023

Jay-Madden left a comment

Choose a reason for hiding this comment

Jay-Madden commented Aug 6, 2023

Jay-Madden commented Aug 6, 2023

netlify bot commented Aug 6, 2023 • edited Loading

❌ Deploy Preview for clembotdocs failed.

github-actions bot commented Aug 7, 2023

Jay-Madden left a comment

Choose a reason for hiding this comment

jkriste commented Jun 4, 2023 •

edited

Loading

netlify bot commented Aug 6, 2023 •

edited

Loading