Purger

Make sure that your purger module is enabled before configuring the purger module (!module purger to enable, and !module list to see if it's enabled).

 

Purging Messages & Channels

There is no configuration for the purger module. It only has one command, purge, which offers a huge selection of options to customize Gaius' message cleaning. The maximum number of messages that can be deleted at one time is 500. The oldest messages Gaius will search for it 2 weeks to save resources due to Discord API limitations.

 

Purge

Required Permissions (Staff)

 

Basic Examples

There isn't a need to understand the entire functional possibilities in order to use the purge command. Sometimes, only deleting a number of messages or a number of messages from a person or role is good enough. Deleting messages that contain a certain word is just as easy.

Command

Descriptive Example

!purge amount

!purge 10

 

- Purges 10 messages from the channel

!purge amount @mention

!purge 10 @yeetmaster#3000

 

- Purges 10 messages from a specific user in the channel

!purge amount @rolemention

!purge 10 @Troll Role

 

- Purges 10 messages from a specific role in the channel

!purge amount text

!purge 10 REEE

 

- Purges 10 messages with that text/letter in the channel

 

Advanced Examples

The listed modifiers below give your purging process some extra oomph to its accuracy and precision. These modifiers are attached at the end of the command message. As a helpful tip, you can still use the examples above while adding the modifiers below at the end.

Modifier

Descriptive Example

--startat

!purge 10 --startat 833536475148058624

 

- "Start at this message ID and work your way downward"

--stopat

!purge 10 --stopat 833536475148058624

 

- "Work your way upward until you get to this message ID"

--range

!purge 10 --range 833536475148058624 833536475148058625

 

- "Start at this message ID, but don't go past that message ID"

--startswith

!purge 10 --startswith pancakes

 

- "Delete messages that starts with the word 'pancakes'"

--includes

!purge 10 --includes pancakes

 

- "Delete messages that has the word 'pancakes'"

--endswith

!purge 10 --endswith pancakes

 

- "Delete messages that has the word 'pancakes' at the end"

--mentions

!purge 10 --mentions @Staff

 

- "Delete messages that have this specific mention"

It is possible to use more than one mention for a wider search.

Example: !purge 10 --mentions @Staff @Mod @Supporter

--links

!purge 10 --links

 

- "Delete messages that have a link"

--bots

!purge 10 --bots

 

- "Delete messages created by bots"

--images

!purge 10 --images

 

- "Delete messages that have an attachment"

--invites

!purge 10 --invites

 

- "Delete messages that have a server invite link"

--embeds

!purge 10 --embeds

 

- "Delete messages that contain embedded text"

--not

!purge 10 --not --bots

 

- "Invert, or make into the opposite of, whatever other modifiers I gave you"

In the given example, this would result in the Gaius deleting any message that was NOT sent by a bot.

 


 

FAQ

 

Q. Will kicking Gaius reset the bot?

- No, kicking/banning Gaius will never reset your settings or prefix.

Q. How do I see all the commands?

- The help command is man's best friend (not dogs).

 

 


 

Video

Not yet available

If you have or find a video on Gaius specifically for what is covered in this documentation page, you can send the info to Fairy 狐 紫#0001 via DM (You must be in the support server in order to make contact).

 


 

Points of Interest

Staff Handbook
Bot Logging/Exlog
Verification Module
Anti-Spam Protection
Wordlist Filtering

 

(Top of Page)

Previous Page   |   Next page


Revision #10
Created Sun, Mar 29, 2020 11:32 AM by Tommyfoxy2
Updated Mon, Sep 13, 2021 1:35 AM by Fairy