Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
28 changes: 28 additions & 0 deletions docs/custom-bot/modules/moderation/ping-protection.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
# Ping protection

Powerful and highly customizable ping-protection module to protect members/roles from unwanted mentions with moderation capabilities.

<ModuleOverview moduleName="ping-protection" />

## Features {#features}

* Protect your users and roles from unwanted (future) pings by sending a customizable warning message
* Completely block pings with a native AutoMod integration (if enabled) together with a custom block message
* Protect every member with a protected role from (future) pings (if enabled)
* Whitelist specific channels, users and roles for pinging
* Customize the moderation actions for repeatedly pinging protected entities with a customizable punishment log message
* Customize how long and if you want data to be stored, such as the pings history

## Setup {#setup}

### Set up protected roles and members

The protected roles and members are who will be protected from pings, and when someone pings a proteted role or user, then a warning message is sent or blocked by AutoMod depending on the [configuration](https://scnx.app/glink?page=bot/configuration?file=ping-protection|configs/configuration).

How to start setting up protected roles and members:
1. Select the role(s) you do not allow members to ping in the 'Protected Roles' field.
2. You can optionally select if all members with that role should automatically be protected as well with the 'Protect all users with a protected role' - This field is enabled by default.
3. Select the member(s) you do not allow to be pinged by entering their user ID's in the 'Protected Users' fields - You can add multiple members by clicking on the 'Add field' button for *each individual member*.

You can view the exact places on this image below:
![](@site/docs/assets/custom-bot/modules/ping-protection/protectedConfig.png)