AutoPing
This is the cog guide for the autoping cog. You will find detailed docs about usage and commands.
[p] is considered as your prefix.
Usage
Automatically ping a user/role when a message is sent in a channel.
Can be used to notify a user or role when a message is sent in a channel.
Pings are always sent in the channel the message was sent in.
Pings are rate limited to a default of 1 per hour.
If the latest message in the channel when a ping is about to be sent includes a ping of the target user OR is sent by the target user, that user will not be pinged. Roles are always pinged.
Messages from bots/webhooks are ignored.
Anyone can run `autoping add` to add themselves to the autoping list for the channel. You can restrict this with the Permissions cog if desired.
Only users with mention everyone or admin permissions can set the rate limit or add/remove autoping for roles or other users.
Commands
autoping
Syntax
[p]autoping
Description
Configure autopings for this channel.
autoping add
Syntax
[p]autoping add [target]
Description
Add yourself or a user/role to the autoping list for this channel.
Only admins can add other users or roles.
Examples:
- [p]autoping add to add yourself to the list.
- [p]autoping add @user to add a user to the list.
- [p]autoping add ID to add a role/user by ID.
- [p]autoping add Role Name to add a role by name.
autoping clear
Note
This command is locked to server admins.
Syntax
[p]autoping clear
Description
Clear the autoping list for this channel.
autoping ratelimit
Note
This command is locked to server admins.
Syntax
[p]autoping ratelimit <time>
Description
Set the rate limit for autoping in this channel.
Examples:
- [p]autoping ratelimit 10 minutes to set the rate limit to 10 minutes.
- [p]autoping ratelimit 1 hour to set the rate limit to 1 hour.
autoping remove
Syntax
[p]autoping remove [target]
Description
Remove yourself or a user/role from the autoping list for this channel.
Only admins can remove other users or roles.
Examples:
- [p]autoping remove to remove yourself from the list.
- [p]autoping remove @user to remove a user from the list.
- [p]autoping remove ID to remove a role/user by ID.
- [p]autoping remove Role Name to remove a role by name.
autoping settings
Note
This command is locked to server admins.
Syntax
[p]autoping settings
Description
Show the current autoping settings for this channel.
Also shows currently added users and roles.