Iris
Add to Discord

Moderation

Kick, ban, mute, and manage infractions.

Configure Moderation in the dashboard

Overview#

Moderation is the manual half of keeping a server in order: warn, mute, kick, ban, softban and tempban, plus the channel controls that go with them. Every action is written to a numbered case, so /cases @member is a full history rather than whatever staff remember.

The member is told what happened. Iris sends them a direct message naming the action, the server and the reason, styled however you want it, and that message is where an appeal starts if you allow appeals.

Appeals arrive in a channel of your choosing with the case attached, so a decision is made against the record rather than an argument in a DM nobody else can see.

Setup#

  1. Drag Iris above every role you want it to be able to act on, in Server Settings > Roles.
  2. Open the dashboard and go to Moderation > Moderation, then turn the module on.
  3. Set the Mod Log Channel so actions are recorded somewhere you can read them.
  4. Pick a Mute Role, or turn on Auto-Create Mute Role and let Iris build one with the name and colour you set.
  5. Style the notice each action sends under DM Messages.
  6. Turn on Allow Appeals and pick the Appeal Channel if you want to hear from the people you punish.

Settings#

SettingTypeDefaultWhat it does
Enable ModerationToggleOffThe master switch for the module.
Mute RoleRoleNoneThe role applied by /mute. Leave empty only if auto-create is on.
Mod Log ChannelChannelNoneWhere each case is recorded.
DM Users on ActionToggleOnTell the member what happened and why.
Auto-Create Mute RoleToggleOffBuild the mute role on first use. While off, /mute needs a role picked above.
Role NameTextMutedName of the auto-created mute role.
Role ColorColour#808080Colour of the auto-created mute role.
Allow AppealsToggleOffAdds an appeal button to the DM the member receives.
Appeal ChannelChannelMod log channelWhere appeals are posted for review.
Appealable actionsListAll fiveWhich of ban, tempban, kick, mute and warn may be appealed.
Sync embed style across actionsToggleOffStyle one DM embed and every other action copies the footer and image.
MessageTextYou were banned from {server} for {reason}The DM text, set per action. Keep it to one line. Supports the variables below.
FooterTextNoneSmall line at the foot of the DM.
Image URLTextNoneImage below the DM text.

Action DMs are a single red line with a disabled button reading Message from server: <your server>, so the member always knows where the punishment came from. The colour is fixed and the embed has no title.

The DM text accepts {user}, {server}, {reason}, {moderator} and {duration}. Unban notices are off by default; the other five are on.

Commands#

CommandWhat it doesRequires
/ban <user> [reason]Ban a member.Ban Members
/unban <user_id>Lift a ban by user id.Ban Members
/softban <user> [reason]Ban then immediately unban, clearing their recent messages.Ban Members
/tempban <user> <duration> [reason]Ban for a set time, then unban automatically.Ban Members
/kick <user> [reason]Remove a member.Kick Members
/mute <user> [duration] [reason]Apply the mute role. Leave the duration out for a permanent mute.Manage Roles
/unmute <user>Take the mute role off again.Manage Roles
/warn <user> <reason>Warn a member and open a case.Manage Messages
/unwarn <user> <case>Remove a warning by case number.Manage Messages
/warnings <user>List active warnings.Manage Messages
/cases <user>The full case history for a member.Manage Messages
/case <case>The detail of one case.Manage Messages
/setnick <user> <nickname>Change a member's nickname.Manage Nicknames
/nick [nickname]Change Iris's own nickname in this server. Leave it empty to reset it.Manage Nicknames
/vckick <user>Disconnect a member from voice.Move Members
/role add <member> <role> [reason]Give a role.Manage Roles
/role remove <member> <role> [reason]Take a role away.Manage Roles
/lock [channel]Stop the lockdown roles sending in a channel. Set those roles under Anti-Raid first.Manage Channels
/unlock [channel]Undo a lock.Manage Channels
/lockdown [reason]Lock the whole server down.Administrator
/unlockdown [reason]End the lockdown and restore every channel to its original permissions.Administrator
/slowmode set <seconds>Set a channel slowmode delay.Manage Channels
/slowmode removeClear the slowmode.Manage Channels

Purge#

Purge is a group rather than one command. Every subcommand deletes up to 1000 messages and every one takes Manage Messages. Pick the one that describes what you want gone, so a cleanup does not take the conversation with it.

CommandWhat it doesRequires
/purge all <count>The most recent messages, whatever they are.Anyone
/purge user <user> [count]Only messages from one member.Anyone
/purge match <text> [count]Messages containing some text.Anyone
/purge not <text> [count]Messages that do not contain that text.Anyone
/purge startswith <text> [count]Messages beginning with some text.Anyone
/purge endswith <text> [count]Messages ending with some text.Anyone
/purge links [count]Messages containing a link.Anyone
/purge invites [count]Messages containing a Discord invite.Anyone
/purge images [count]Messages with an image or attachment.Anyone
/purge mentions [count]Messages that ping a user or role.Anyone
/purge embeds [count]Messages containing an embed.Anyone
/purge bots [count]Messages from bots.Anyone
/purge humans [count]Messages from people rather than bots.Anyone
/purge text [count]Plain text only, leaving embeds and attachments alone.Anyone
/purge after <message_id> [count]Everything posted after a given message.Anyone

Permissions#

PermissionWhy Iris needs it
Ban MembersBan, unban, softban and tempban.
Kick MembersKick.
Manage RolesApplies the mute role, and runs the role commands.
Manage MessagesPurge, and locking a channel.
Manage ChannelsLock, unlock, lockdown and slowmode.
Manage NicknamesRenaming a member.
Move MembersDisconnecting someone from voice.

What it looks like#

I
Iris APP Today at 8:52 PM

Member banned.

Case

#128

Member

@rulebreaker

Moderator

@you

Reason

Advertising in DMs

I
Iris APP Today at 8:52 PM

You were banned from Iris HQ for advertising in DMs

The case in the mod log, and the notice the member receives.

Tips and gotchas#

Iris says it cannot ban someone.

Their top role is above Iris, or they are the server owner, who nobody can ban.

The member never got the DM.

Their DMs are closed. The action still applies and the case is still written; only the notice is lost.

How far back does purge reach?

Up to 1000 messages, and Discord refuses to bulk delete anything older than 14 days. Older messages have to go one at a time.

Where do warnings go when I unwarn?

The warning stops counting but the case stays in the history, with the removal recorded against it.