# Mod Tools

### This article will run you through the setup of SnailBot's Moderation Tools.

## Introduction

SnailBot now has moderation tools - to get started using them, run +modtools enable and mention the channel you wish to use for logging. To configure the tools further, run `+modtools configure` to show the available options, or run `+modtools configure <option> <value>` to change the setting. Do not include `<>` when running the commands.

You can refer to the chart below to see all of the available options.

|             Option             |                                                    Description                                                    |
| :----------------------------: | :---------------------------------------------------------------------------------------------------------------: |
|        MESSAGE\_REMOVALS       |                                     Logs what message was deleted and by who.                                     |
|         MESSAGE\_EDITS         |                              Logs what message was edited and shows the differences.                              |
|     VOICE\_CHANNEL\_ACTIONS    |                                    Logs movement and actions in voice channels.                                   |
|          ROLE\_CHANGES         |                               Logs what was changed in the role and who changed it.                               |
|          MEMBER\_JOINS         |                                             Logs when a member joins.                                             |
|         MEMBER\_LEAVES         |                                              Logs when a member left.                                             |
|      MEMBER\_NICK\_CHANGES     |                                     Logs when a member's nickname is changed.                                     |
|      MEMBER\_NAME\_CHANGES     |                                     Logs when a member's username is changed.                                     |
|        CHANNEL\_CHANGES        |                              Logs what was changed in the channel and who changed it.                             |
|     DM\_USER\_WHEN\_WARNED     |                                  Send user a direct message when they get warned.                                 |
| SHOW\_USER\_WHO\_GAVE\_WARNING |                                   Show the user who gave the warning in the DM.                                   |
|   WARN\_FOR\_POSTING\_INVITE   |                      Warn a user for posting invite links. *(Moderators / Admins are exempt)*                     |
|          JOIN\_MESSAGE         |            The message you want to be sent when a user joins. (Use {user} placeholder to show the user)           |
|     JOIN\_MESSAGE\_CHANNEL     |                                 The channel where you want the join message sent.                                 |
|    ROLE\_TO\_GIVE\_ON\_JOIN    |                               The role you want to give to new users when they join.                              |
|      PERSPECTIVE\_ENABLED      |               Enables Google's Perspective API monitoring for your server. *(Partner-Only Feature)*               |
|     PERSPECTIVE\_THRESHOLD     | Sets a threshold for marking messages as "toxic". (0.0 is most sensitive, 1.0 is least sensitive, default is 0.7) |

## Commands

| **Command                                                                                          All commands are listed without the bot prefix.              (Default: +)** |           Description                                                                                 Note: Do not include <> when running commands.          |
| :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | :-----------------------------------------------------------------------------------------------------------------------------------------------------------: |
|                                                                     modroles \<list/add/remove> \<role(s)>                                                                     |                                                   Manage the list of roles considered to be moderator roles.                                                  |
|                                                                    adminroles \<list/add/remove> \<role(s)>                                                                    |               Manage the list of roles considered to be admin roles. Roles with the **ADMINISTRATOR** permission are automatically admin roles.               |
|                                                                           purge user \<user> \<limit>                                                                          |                                                   Purge the specified amount of messages by a specified user                                                  |
|                                                                                 purge \<limit>                                                                                 |                                                             Purge the specified amount of messages                                                            |
|                                                                          rules \<add/edit/move/remove>                                                                         |                                        Manage the server rules. Run this without any subcommands to see the rule list.                                        |
|                                                                             warn \<user> \[reason]                                                                             | Warn the specified user using the optional specified reason. You can also specify a rule to include it in the warning by putting \[rule:\<id>] in the reason. |
|                                                                              ban \<user> \[reason]                                                                             |                                                  Bans the specified user with the optional specified reason.                                                  |


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://theelite96.gitbook.io/snailbot-docs/mod-tools.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.