CHANGELOG.md

Changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

5.1.0 - 2023-08-29

Added

• New welcome system:
  • Members must wait 10 minutes before being confirmed
  • Visual layout to select appropriate roles for the user
• Rules message now contains link to full Scioly.org rules
• Censoring messages now consumes less memory and is less likely to block internal bot event loop
• Reduced errors in edit message logging
• Recent messages in ping subsystem are now stored using a collections.deque.

5.0.9 - 2023-06-11

Added

• ruff is now the main linter for the repository

Changed

• Default supported version is now Python 3.10

Fixed

• GitHub Actions runner now performs linting check as expected, rather than failing every time
• Improper regular expressions would cause errors on each ping, now silently ignored

5.0.8 - 2023-03-15

Changed

• Logs no longer use print(), rather native Python logging features (closes #460)
• Logs are saved to a file, and also printed to the user when in development mode

Fixed

• Edited message logs no longer error when a message has never truly been edited.

5.0.7 - 2023-02-19

Changed

• Dependencies upgraded to work with Python 3.11
• Users are only warned of using frequent pings when adding small ping terms (closes #467)

Fixed

• Using All States argument with /states would not be handled correctly

5.0.6 - 2023-02-08

Changed

• Invitational dropdowns in #invitationals now show archived invitationals, so users can update their roles without invitationals being open.

Fixed

• CI would never pass on master because of a check that was accidentally running.

5.0.5 - 2022-11-19

Added

• Logs of deleted messages not in cache now include warning that non-caching may be due to ephemeral state

Fixed

• Invitational archive and extend buttons attached to archive reports now function properly
• Removed typos in embed sent to archived invitational channels

5.0.4 - 2022-10-30

Added

• Autocompletion for staff invitational management commands
• Command group for commands related to the Scioly.org wiki

Fixed

• Self-mute button is functional again

5.0.3 - 2022-10-01

Changed

• Most references to "tournaments" were changed to references to "invitationals"

Removed

• Removed unneeded files

5.0.2 - 2022-09-24

Changed

• Invitational dropdowns now reset after choosing an option
• Instructions on joining/leaving invitational channels through #invitationals are clearer

5.0.1 - 2022-09-18

Added

• Users using ! or ? are now notified to use slash commands (closes #403)

Fixed

• Typo in /invitational renew command
• /ping on_message event handler would often take up event loop

5.0.0 - 2022-09-14

Added

• New Discord UI interfaces for several commands (closes #370)
• MongoDB is now where Pi-Bot stores his information (closes #369)
• /cron allows staff to edit/remove tasks from Pi-Bot's CRON system (closes #379)
• /ban and /mute now suggest ban/mute lengths, rather than asking the moderator for their own suggested length
• The bot can now listen for individual user responses. Helpful for users attempting to interact with application commands in complex ways.
• /invitational add, /invitational approve, /invitational edit, and /invitational archive allow staff to manage invitational data
• /invitational season allows staff to manage the season of each invitational
• /invitational renew allows staff to renew previously archived channels
• Invitational tournaments can now be archived from any channel
• /event add and /event remove allow staff to modify events from the server
• Event-modifying commands no longer require staff to manually add event roles to the server, instead, roles are automatically generated.
• /tagupdate add, /tagupdate edit, and /tagupdate remove allow staff to modify tags from the server
• /censor add and /censor remove allow staff to modify censor entries from the server
• /stealfish can now occasionally give bear more fish rather than take fish away.
• /prepembed now has an interactive creation tool to create embeds.
• /prepembed now allows for exporting/import embeds.
• Direct message logs are now more cleanly formatted and use relative dates.
• Users are now sent a direct message about why their message was deleted after editing it to include a censored term.
• Staff can now change a user's nickname or kick the user from a innapropriate username report.
• Edited message logs now include a link to jump to a message.
• Deleted message logs of non-cached messages now contain an explanation for why more data is not available in the log.
• Censor cog for handling all message censoring.
• Logging cog for handling all logging. Logging functionality was moved out of bot.py.
• Spam cog for handling catching caps and spamming.
• Loading commands now frequently show a loading emoji to signify processing.
• A YesNo view was added for commands that need a final confirmation.
• A user command was added for confirming users.
• /kick and /ban confirm that the correct action took place after completing the desired action.
• /kick and /ban can send a message to the user alerting them to the action that just took place.
• Staff commands now double-check for permissions, once handled by the library, once handled by each command.
• Staff can now refresh only part of the bot, if desired.
• Staff can now set a custom bot status for a specified amount of time.
• CRON handling is now handled by a group of methods, rather than just one method.
• Add cooldowns to member commands.
• Members can be confirmed through a User Interaction (ie, right-clicking on a user icon).

Embeds

• Adding/updating embeds is now done through Discord UI, with the help of dedicated classes.
• Embeds sent previously can now be updated.
• The limits on specific values in embeds is now validated.

Pings

• Pings now show recent message history in the channel to give context.
• Ping messages now have a red color, and are formatted differently. The Click Here link is now embedded in the embed description.
• Ping commands now live in a separate slash command group.

Reporting

• Reports are now interactive, often featuring buttons that can be clicked to activate specific actions.
• Separate views/embeds are now used depending on the report type.
• When reports are acted upon, messages are sent to #closed-reports.

Changed

• bot.py was split into separate files/cogs. (closes #42)
• Some dependencies were updated (numpy).
• The default Python runtime was updated to 3.10.
• New tournament channels will not be created if an appropriate tournament channel already exists, just in the archived category
• Automated data updates are no longer made on a constant basis; rather, data is updated only when changes are needed because of a process
• The layout of the /about embed response was slightly updated.
• /pronouns only allows adding/removing one pronoun role at once.
• /forums, /obb, /gallery, and /exchange were simplified into /link.
• /info no longer checks for the user's staff role, and instead only checks the category name of the channel the command was called in.
• /wiki was split into separate commands: /wikilink, /wikisearch, and /wikisummary.
• /treat can now be used to share a wide variety of treats. Yum!
• Users who are repeatedly spamming/using caps are now warned through direct messages, rather than in public channels.
• Edited and deleted message logs now use Discord UI relative times instead of displaying times in UTC.
• README now features slash commands instead of typical commands.
• Version is now stored in bot.py - info.py was removed.
• Message history in #welcome is now gotten newest-first in an effort to conserve resources.

Removed

• The exalt/unexalt commands were removed.
• The getVariable command was removed.
• The report command was removed.
• The nukeuntil command was temporarily removed.
• The /graphpage and /graphscilympiad commands were temporarily removed.
• Users can no longer indefinitely self-mute.
• Google Sheets is no longer used to store data, and all systems related to storing data in Google Sheets were removed.
• The forums-interacting aspect of the bot was removed.
• The ability for staff to mark tournament as "opening soon" was removed. Tournaments are now open from when they are officially added by staff.
• The wiki stylist was temporarily disabled.
• /me was removed.
• /eat was removed.
• /report was removed.
• /list and /help were removed, as users can now see all commands in a list through Discord UI.
• /latex, /resultstemplate, and /school were temporarily removed.
• Users will no longer be banned from using /stealfish.
• Edited and deleted message logs no longer show the raw event payload.
• RegEx pings were removed.
• Permissions for Launch Helpers were removed.
• The assemble_embed method was removed; instances of its use were replaced with the use of discord.Embed.
• The auto_report method was removed. Rather, reporting is now handled by a specific cog.

Fixed

• /invyarchive (previously !archive) now correctly links to the #competitions channel for more questions/info about an archived tournamentin the response embed (closes #363)
• Direct message logs no longer log outgoing messages from the bot.

4.5.20 - 2021-06-03

Changed

• !invite now links to partner invite link
• discord.gg/scioly is now an allowed external Discord link

Fixed

• Fixed incorrect dates in CHANGELOG
• Fixed misspelling in !division command

4.5.19 - 2021-04-15

• Timing issues with !selfmute, !mute, and !ban should be fixed (closes #242)

4.5.18 - 2021-04-11

Fixed

• !archive would make a tournament channel no longer viewable to current competitors (closes #365)

4.5.17 - 2021-04-09

Added

• Voice channels can now be opened for state channels (hello socal! :D)

4.5.16 - 2021-04-04

Fixed

• An empty requested tournaments list would break the tournament-updating sequence
• Added more try/except blocks to refresh algorithms to stop the entire algorithm from stopping in case one part breaks

4.5.15 - 2021-03-22

Added

• Added !archive command (closes #263)

Fixed

• !dogbomb with no arguments referred to shiba bomb (closes #323)

4.5.14 - 2021-02-16

Changed

• !magic8ball response now replies to the original message (closes #356)
• !fish can no longer give bear 69 fish at any time (closes #355)
• Updated discord.py pip package to 1.6.0

4.5.13 - 2021-02-13

Changed

• Slightly cleaned up logs

4.5.12 - 2021-02-11

Added

• More detailed, helpful logs for code or command errors

4.5.11 - 2021-02-06

Fixed

• Fixed !getuserid command name

4.5.10 - 2021-02-05

Fixed

• Fixed various errors on logging deleted and edited messages (closes #298)

4.5.9 - 2021-01-28

Fixed

• MET table is removed from matplotlib memory when the graph is generated (closes #340)

4.5.8 - 2021-01-15

Changed

• !coach now gives the user a link to the public Coach role application.

4.5.7 - 2021-01-15

Added

• Live member count channel for staff to monitor server (closes #320)

4.5.6 - 2021-01-14

Added

• Support for the "Self Muted" role
• Option for users who self-muted to unmute through a reaction on a special message (closes #325)

4.5.5 - 2021-01-13

Fixed

• Tournament list breaks if number of available tournaments decreases by a large margin (closes #316)
• !fish breaks if fish count gets too large (closes #324)

4.5.4 - 2020-12-17

Changed

• !beareats now deletes original command message (closes #304)
• Messages with only exclamation marks are no longer thought to be commands (closes #282)

4.5.3 - 2020-12-16

Fixed

• Fixed error in datetime string that would cause cron task times to become unreadable

4.5.2 - 2020-12-15

Changed

• !xkcd command now returns random comic if no second argument is given (closes #302)

Fixed

• !xkcd now correctly handles comics requested that are above maximum number
• !help xkcd now works (closes #301)

4.5.1 - 2020-12-14

Fixed

• Messages by Launch Helper+ are no longer deleted in #welcome by the #welcome manager task
• Pinned messages in #welcome are no longer deleted by the #welcome manager task

4.5.0 - 2020-12-14

Added

• Users can be auto-confirmed under special circumstances
• All messages will be deleted in #welcome if they exist for more than 3 hours (skipped between 12AM and 11AM EST)

Changed

• !confirm will confirm the user first, then delete message (closes #176)
• !confirm will delete the original message sent by Pi-Bot when use joins (closes #95)
• Users who leave the server will have any messages mentioning them in #welcome deleted (closes #251)

4.4.46 - 2020-11-27

Added

• Added documentation for !info in commandinfo

4.4.45 - 2020-11-27

Added

• !info command now displays info about the server (closes #261)

4.4.44 - 2020-11-26

Changed

• !ping add now escapes the regular expression before adding

4.4.43 - 2020-11-20

Fixed

• Tournament list embed message that exceeds character limit is now split up

4.4.42 - 2020-11-20

Fixed

• Censor can no longer mention users (closes #222)

4.4.41 - 2020-11-19

Added

• !forums now sends a link to the Scioly.org forums (closes #284)

Changed

• Members can now run specific allowed commands outside of #bot-spam (closes #275)

4.4.40 - 2020-11-18

Added

• !userfromid to get a user from specified ID (closes #283)

4.4.39 - 2020-11-17

Changed

• Bot statuses are now stored in array instead of long conditional (closes #174)

4.4.38 - 2020-11-15

Added

• Added the !magic8ball command (closes #272)

Fixed

• Commands now work in DM's again (closes #278)

4.4.37 - 2020-11-14

Added

• Simple !xkcd command (closes #181)

4.4.36 - 2020-11-13

Added

• !list all now shows pages of commands separately (closes #187)

4.4.35 - 2020-11-12

Changed

• Calling !tag example where example is a legitimate tag will delete the original message (closes #274)
• Commands run by members in channels other than #bot-spam will now not be processed and will direct the user to the appropriate channel. (closes #219)

Fixed

• Typo in !stealfish (closes #273)

4.4.34 - 2020-11-11

Fixed

• !nuke n would throw an error if the user attempted to delete -n messages when n was larger than the number of messages in the channel

4.4.33 - 2020-11-11

Added

• !nuke now accepts negative indexes to delete all but last n messages (closes #271)

Fixed

• Deletion needed reports for tournament channels would occur despite tournament channels not needing to be deleted (closes #270)

4.4.32 - 2020-11-10

Added

• Documentation for !tag added (closes #265)

Changed

• When user sends link to external Discord server, a warning is now displayed explaining why the message was censored (closes #267)

4.4.31 - 2020-11-07

Fixed

• !wiki pageName where pageName is not a valid page name now shows proper error (closes #257)
• !wiki link pageName was fixed to actually link to pageName (closes #256)
• Wiki URLs now accurately link to page titles containing ":" or "/" (closes #161)

4.4.30 - 2020-11-06

Added

• !tag command, which references the Tags spreadsheet (closes #253)

4.4.29 - 2020-11-05

Changed

• !wiki with no other arguments now sends link to the wiki homepage (closes #189)
• !wiki [page_name] will now assume !wiki link [page_name] (closes #231)
• !wiki will now report too many arguments given when there are more than 7 arguments

Fixed

• Edited message log fields are now capped at 1024 characters, which will hopefully result in many less error messages regarding overflowing edited message logs

4.4.28 - 2020-11-04

Added

• !graphscilympiad command added to make a graph of Scilympiad final results (closes #243)

Changed

• !tournament now ignores commonly used words to cut down on mistaken reports (closes #250)
• async def list() command was renamed to async def list_command() in code to avoid overwriting built-in list() function

4.4.27 - 2020-11-03

Added

• Added !rule command for quickly displaying a rule (closes #200)

Removed

• Removed !invites command, which led to nothing

4.4.26 - 2020-11-02

Added

• Commandinfo for each command can now support flags (closes #29)

4.4.25 - 2020-11-01

Changed

• Changed CATEGORY_TOURNAMENTS name to lowercase tournaments for standardization

4.4.24 - 2020-11-01

Changed

• !wikipedia terms with multiple words now do not need quotes (closes #241)
• !wikipedia with no function term will now assume the link function (ex, !wp red bear now assumes !wp link red bear)

4.4.23 - 2020-10-31

Changed

• !help with no other arguments now shows special message (closes #140)

4.4.22 - 2020-10-30

Changed

• #member-leave messages now show if user was unconfirmed and when they joined. (closes #237)

4.4.21 - 2020-10-29

Added

• Added !rand command to generate random numbers (closes #199)

4.4.20 - 2020-10-28

Added

• Added !resultstemplate command to make a results template from raw Scilympiad results (closes #244)

4.4.19 - 2020-10-27

Fixed

• Bot now uses Intents

4.4.18 - 2020-10-27

Fixed

• Fixed ping issues with censor (closes #222)

4.4.17 - 2020-10-26

Added

• !vc now works for #games (closes #245)

4.4.16 - 2020-10-24

Fixed

• Fixed typo in the name of "They / Them / Theirs" role (closes #240)

4.4.15 - 2020-10-23

Fixed

• Tournaments list showed channels opening in 0 days.

4.4.14 - 2020-10-22

Added

• Global variables for server variables (such as the names of all roles and channels) (closes #232)

4.4.13 - 2020-10-21

Changed

• Requested tournaments list now uses middle dot symbol rather than dash to separate command and number of votes (closes #233)
• !list now shows commands in alphabetical order (closes #235)

4.4.12 - 2020-10-20

Changed

• Tournament list is formatted cleaner (closes #230)
• !pronouns help message is now formatted cleaner (closes #142)

Fixed

• Member leave messages no longer mention users, as this can break after user has left the server (closes #229)

4.4.11 - 2020-10-17

Fixed

• #server-support mentions renamed to #site-support

4.4.10 - 2020-10-16

Changed

• !mute, !ban, and !selfmute now display times in Eastern time.
• Tournament voting commands are now shown next to proposed tournament channels.

Fixed

• !me called with no arguments now deletes original message.
• !list fixed for regular members.

4.4.9 - 2020-10-15

Added

• Log member leave events to #member-leave channel.

4.4.8 - 2020-10-14

Changed

• Hotfix for !selfmute being broken for all members.

4.4.7 - 2020-10-14

Changed

• !selfmute now sends an error message when staff members run the command, as the command will not work for them.
• Messages needed to mute for caps changed from 6 to 8.

4.4.6 - 2020-10-08

Added

• Added the !graphpage command to assist in graphing wiki pages. For example, !graphpage "2020 New Jersey State Tournament" Y 1 C to graph the Division C chart for that state tournament.

Changed

• Updated .gitignore to avoid including .svg files in version control as they are often temporary files.

4.4.5 - 2020-10-07

Added

• Added a CHANGELOG.md file (closing #215)
• Added the !vc command (closing #182)

Fixed

• New tournament channels now enable reading messages by members with the All Tournaments role (closing #212)
• Cron list tasks that can not be completed are now skipped (closing #201)