RoleNotify

This is the cog guide for the rolenotify cog.

You will find detailed docs about usage and commands.

[p] is considered as your prefix.

Note

To use this cog, load it by typing this:

[p]load rolenotify

Note

This cog requires the Members Intent

Usage

Notify a user when they have a Role added or removed from them

Commands

rolenotify

Permissions

User -

Bot Admin or Manage Roles

Syntax

[p]rolenotify

Description

Configure RoleNotify

channel

Permissions

User -

Bot Admin or Manage Roles

Syntax

[p]rolenotify channel <channel>

Description

Set the channel to output Role Notifications to

Pass 0 to clear the channel

Pass nothing to see the configured channel

role

Permissions

User -

Bot Admin or Manage Roles

Syntax

[p]rolenotify role

Description

Configure settings for a Role

info

Permissions

User -

Bot Admin or Manage Roles

Syntax

[p]rolenotify role info <role>

Description

Display the configured settings for a Role

method

Permissions

User -

Bot Admin or Manage Roles

Syntax

[p]rolenotify role method <role> <method>

Description

Set the notification method

Valid options are dm and channel

method

Permissions

User -

Bot Admin or Manage Roles

Syntax

[p]rolenotify role channel <role> <channel>

Description

Set the channel to output Role Notifications to

Pass 0 to clear the channel and use the server defined channel

add

Permissions

User -

Bot Admin or Manage Roles

Syntax

[p]rolenotify role add <role> <state>

Description

Set if the notification should be sent on Role Add

<state> should be any of these combinations, on/off, yes/no, 1/0, true/false

remove

Permissions

User -

Bot Admin or Manage Roles

Syntax

[p]rolenotify role remove <role> <state>

Description

Set if the notification should be sent on Role Remove

<state> should be any of these combinations, on/off, yes/no, 1/0, true/false

message

Syntax

[p]rolenotify role message <role> <option> <message>

Description

Set the notification message

<option> can be either add or remove

Formatting options available for <message> are

{role_name} = Role Name

{role_mention} = Role Mention (no pings)

{user_name} = User’s Display Name

{user_mention} = User Mention