# Moderation

{% hint style="info" %}
Note: This module needs to be configured before being enabled
{% endhint %}

This module allows moderators to issue punishments to server members!

## How it works

* This module is a central hub for moderators to use
* This means that moderators can only take out certain moderation actions, without the need to have external permissions - which could be used wrongfully
* Moderators can not take action on anyone above or equal to their role or bots, and depending on their role can only take certain actions

## Permission Chart

<table><thead><tr><th>Feature</th><th data-type="checkbox">Moderators</th><th data-type="checkbox">Managing Mods</th><th data-type="checkbox">Admins</th></tr></thead><tbody><tr><td>Look Up User Info</td><td>true</td><td>true</td><td>true</td></tr><tr><td>Issue Timeouts</td><td>true</td><td>true</td><td>true</td></tr><tr><td>Issue Server Bans</td><td>true</td><td>true</td><td>true</td></tr><tr><td>Issue Kicks</td><td>false</td><td>true</td><td>true</td></tr><tr><td>Issue Bans</td><td>false</td><td>false</td><td>true</td></tr></tbody></table>

## Commands

### Set-Up

{% hint style="info" %}
Prior to setup, please create 3 seperate roles which will be used for permission scaling, as shown in the above chart
{% endhint %}

set up the moderation module using the `/moderation-setup` command!

{% hint style="info" %}
you must have administrator permissions to use the /moderation-setup command
{% endhint %}

With this command you can set the required roles to be able to use moderation, and what they can access.

<figure><img src="/files/bswkZNpfnq08afANPEiP" alt=""><figcaption></figcaption></figure>

once running the command with your selected roles, you will get a message back to show your edits. After your first time using the module, you will always get a warning before overriding your current settings.

<figure><img src="/files/zoidvcjMNFfklP1YRH5p" alt=""><figcaption></figcaption></figure>

### Usage

This module is all used within the `/moderation_dashboard` command. This command is a hub for dealing with moderation actions. Depending on the users role, and what you have configured above. The moderating user will see different options

<figure><img src="/files/k5wYcoCyqtgZ1U26sUlx" alt=""><figcaption><p>An example for managing mods. Please see the above permission chart for more details on what each configured role can see.</p></figcaption></figure>

If a user is above or equal to their permission level, they will see limited actions:

<figure><img src="/files/lklZxKBby0rj3BPDPJAn" alt=""><figcaption><p>This image shows an example when a user tries to moderate a user above them.</p></figcaption></figure>

From this pannel, moderators can undergo different actions.

## Options

### Warnings

When selecting warnings, a submenu will appear below for the moderator

<figure><img src="/files/jnttl58jZ6n2UbInviA8" alt=""><figcaption><p>The warnings section</p></figcaption></figure>

There are 4 options

List warning - Lists the selected users current warnings

Add Warning - Adds a new warning for the user

Remove Warning - Removes a warning for the user

Remove all warnings - Removes all of this users Current Warnings

### Timeout

This will time out a user and remove their `expression permissions` (send messages, join vcs...) for the specified amount of time

#### Options

Duration - The duration in seconds of the timeout

Reason - The reason (that is shared with the user) for the timeout

### Server Ban

This function temporaily takes away a users ability to see member channels, but allows them to only see read-only channels.

When selecting this option, you will have 2 fields:

Duration - The duration in seconds of the server ban

Reason - The reason (that is shared with the user) for the server ban

Once done, the user will then be granted the server ban role, which takes away their permissions.

### User info

This returns various pieces of information about a user about their discord account (i.e when they joined the server) and provides a moderation view (BETA) for the user.![](/files/wZwLFoxGGY7d1TvFFgLb)

### Kick

{% hint style="info" %}
This is only avalible to managing moderators and admins
{% endhint %}

This kicks the specified user from the server

**Options**

Reason - The reason (that is shared with the user) for the kick

### Ban

{% hint style="info" %}
This is only avalible to admins
{% endhint %}

This bans the specified user from the server

**Options**

Reason - The reason (that is shared with the user) for the ban

## Disable

Disable this plugin by using `/moderation-disable` command and agreeing to the confirmation pop-up

This will disable all commands accociated with the module, remove all role data. But, will keep warning data.

<figure><img src="/files/BkAAMRRHQDpeKd6hYUQT" alt=""><figcaption><p>disabling the moderation plugin</p></figcaption></figure>


---

# Agent Instructions: 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://docs.olilz.xyz/modules/moderation.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.