# Introduction

{% hint style="danger" %}
**ProtectList** is not an official bot created by **Discord**. It's a bot created by **mad\_rage**, a Discord user who develops public bots to improve platform security.
{% endhint %}

## Preview

ProtectList is a blacklist robot allowing its users to be warned in the event of the presence of a malicious user.

* It has a very advanced [blacklist module](/blacklist-module/report-a-user), very responsive and above all, very powerful.
* It also has a very advanced and very intuitive [moderation module](/moderation-module/ban-unban-command) that will allow you to properly moderate your server.
* It has a complete [dashboard ](/dashboard/page-1)that allows you to customize the bot to your liking.
* Finally, it has a [premium ](/premium/for-designers)that allows you to access very sophisticated commands and all this, for free.

## Quick links

{% content-ref url="/pages/k0Bfh259a8j8EXtvS29q" %}
[Report a user](/blacklist-module/report-a-user)
{% endcontent-ref %}

{% content-ref url="/pages/tSTdqrN1wpq142c5P09k" %}
[Broken mention](broken://pages/tSTdqrN1wpq142c5P09k)
{% endcontent-ref %}

## Get Started

ProtectList has concocted the most important information about its bot here.

{% content-ref url="/pages/5Ka6KwMMvMmJgBZNcfS5" %}
[Getting set up](/fundamentals/getting-set-up)
{% endcontent-ref %}

{% content-ref url="/pages/mcuTjv1xcwHA5aMUPGWF" %}
[Setting permissions](/fundamentals/getting-set-up/setting-permissions)
{% endcontent-ref %}

{% content-ref url="/pages/fXICrNdyFbannFqqopKT" %}
[Inviting Members](/fundamentals/getting-set-up/inviting-members)
{% endcontent-ref %}


# Report a user

{% hint style="warning" %}
**Warning** ! By submitting a report to ProtectList reviewers, you may be subject to **penlaties** if we consider your report to be **troll**.
{% endhint %}

## Make a report

To create a report, you just need to run the command `/report` and indicating, as in the example below, the user, the reason and a valid proof.

<figure><img src="https://cdn.discordapp.com/attachments/956608874121691156/1090655100629946559/image.png" alt=""><figcaption><p>Example of the command <code>/report</code></p></figcaption></figure>

{% hint style="warning" %}
**Warning** ! ProtectList does not take into account reports for **games** or other, we only take reports **related** to the **Discord platform**.
{% endhint %}

You will then need to validate, or not, your report by clicking on the two buttons proposed.

<figure><img src="https://cdn.discordapp.com/attachments/956608874121691156/1090665075502747779/image.png" alt=""><figcaption><p>Example of the report validation</p></figcaption></figure>

{% hint style="success" %}
**Congratulations**, you have just sent a report to **ProtectList reviewers**, we can't wait for your report to be **answered** !
{% endhint %}

## The response of the report

Generally, you will have the response to your report within 24 hours and it will be sent to you in private messages.

{% hint style="danger" %}
Be **careful** to check that your **private messages** are **open** to **everyone** so that ProtectList can **inform** you of our response !
{% endhint %}

### Your report is approved

Congratulations, your report has been approved by our examiners ! Often, we add details about your report :

1. **Tags** : we add tags so that your report is classified in certain categories (like `Token grabber`, `Scamming` etc...)
2. **Translation** : we translate your report into all ProtectList languages.
3. **Author** : we add your information, as the author of the report, namely, your nickname.

<figure><img src="https://cdn.discordapp.com/attachments/956608874121691156/1090665875402653758/image.png" alt=""><figcaption><p>Example of an approved report</p></figcaption></figure>

{% hint style="info" %}
We keep the **evidence** you provide to us in **our servers** so as not to cause further **harm** to the reported user and also to **keep** our evidence **unique** so that it is not **replicated** and used by **third parties**.
{% endhint %}

### Your report is refused

Ouch, your postponement is refused! There may be several reasons for your postponement to be refused, here are the main ones :

1. **Proof** : your proof does not correlate with the reason you provided to us or it is not explicit enough or it is distorted.
2. **Reason** : the reason you specified to us is not clear enough or does not correlate with your evidence or is not sufficient for a blacklist or finally, we do not take this kind of reason for a blacklist.

<figure><img src="https://cdn.discordapp.com/attachments/956608874121691156/1090663679592239235/image.png" alt=""><figcaption><p>Example of a refused report</p></figcaption></figure>

{% hint style="warning" %}
Please do not return the **same report** immediately after its **refusal**. Instead, be sure to **redo** your report so that it is accepted as **quickly and efficiently** as possible by the examiners.
{% endhint %}


# Scan a user

## Scan a user

To scan a user, you just need to run the command `/scan` and waiting, as in the example below, that the bot search the user.

<figure><img src="/files/WsQdFbTR0vvUGdJ3Djn5" alt=""><figcaption><p>Example of the command <code>/scan</code> if the user is blacklisted</p></figcaption></figure>

If the user is not blacklisted, you will receive this message.

<figure><img src="/files/ttaKpJ3g0K4DlWjYkdVO" alt=""><figcaption><p>Example of the command <code>/scan</code> if the user is not blacklisted</p></figcaption></figure>

## The data of the scan

There is some important data when you scan a blacklisted user.

1. **Tags** : these are the categories that the examiners gave to the report; they are important in determining user toxicity (like `Scamming`, `Doxing`, `DDoS` etc...).
2. **Author** : it's the author report, which makes it possible to establish the level of confidence that can be placed in the report.
3. **Date** : it's the date approval report,  you can draw a conclusion about how long the report lasts and what change can be accomplished.

{% hint style="warning" %}
You are **free** to **trust** us or not on the **report** ! This will **not impact** your server in any way unless you **run** commands for it.
{% endhint %}


# Ban/unban command

## Ban a user

To ban a user, you just need to run the command `/ban` and indicating, as in the example below, the user, the duration, the reason and a proof.

<figure><img src="/files/qJ9B2vRqHWVMMUmIfM6I" alt=""><figcaption><p>Example of the command <code>/ban</code></p></figcaption></figure>

{% hint style="warning" %}
The **duration**, the **reason** and the **proof** are not **obligatory** ! If you **don't specify** a reason or you **don't give** a proof, they will be **filled** as `none`. If you **don't specify** a duration, the ban will be **definitive**.
{% endhint %}

Once the command is run, the robot will do all the necessary checks to find out if the user can be banned from the server. If this is the case, this message will be resend to you.

<figure><img src="/files/qGES3BYa4q1l0Aai9WbN" alt=""><figcaption><p>Example of the command <code>/ban</code> response</p></figcaption></figure>

{% hint style="success" %}
**Congratulations**, you have just banned a user with **ProtectList** ! The **ban informations** will be **saved** by the bot and you will be able to **get** it.
{% endhint %}

## Unban a user

### With the button

You can unban a user with the button below the command response. You just have to click on the button and indicate the reason for the unban in the modal appearing, as below.

<figure><img src="/files/EUw85TzAqzCjQfkuuD8V" alt=""><figcaption><p>Example of the modal for deban a user from the button of the command <code>/ban</code></p></figcaption></figure>

When you click on the button `Submit`, the bot will send this message.

<figure><img src="/files/vh8Wsvx4E4wzx7CZZbBi" alt=""><figcaption><p>Example of the response for a deban of a user from the button of the command <code>/ban</code></p></figcaption></figure>

### With the command

The command is the same thing than the button. You have just to run the command `/unban` and indicating, as in the example below, the user ID and the reason.

<figure><img src="/files/7CBwCX0ZaHah8htigEdg" alt=""><figcaption><p>Exemple of the command <code>/unban</code></p></figcaption></figure>

When you execute this command, the bot will send this message :

<figure><img src="/files/HHOVD6TEuRMrY5ytN2Id" alt=""><figcaption><p>Exemple of the response for a deban of a user from the command <code>/unban</code></p></figcaption></figure>

{% hint style="success" %}
**Congratulations**, you have just unbanned a user with **ProtectList** ! The **unban informations** will be **saved** by the bot and you will be able to **get** it.
{% endhint %}


# Timeout/untimeout command

##


# Page 1


# For Designers

{% hint style="info" %}
**Good to know:** depending on the product you're building, it can be useful to explicitly document use cases. Got a product that can be used by a bunch of people in different ways? Maybe consider splitting it out!
{% endhint %}

## Figma Integrations

{% tabs %}
{% tab title="Installing" %}
{% embed url="<https://www.figma.com/community/plugin/950514102619019349/Automater>" %}
{% endtab %}

{% tab title="Configuring" %}
Maecenas faucibus mollis interdum. Donec id elit non mi porta gravida at eget metus. Donec ullamcorper nulla non metus auctor fringilla. Donec sed odio dui. Donec ullamcorper nulla non metus auctor fringilla.
{% endtab %}

{% tab title="Customizing" %}

{% endtab %}
{% endtabs %}


# For Developers

{% hint style="info" %}
**Good to know:** depending on the product you're building, it can be useful to explicitly document use cases. Got a product that can be used by a bunch of people in different ways? Maybe consider splitting it out!
{% endhint %}

## GitHub Integrations

Cras mattis consectetur purus sit amet fermentum. Praesent commodo cursus magna, vel scelerisque nisl consectetur et.

{% tabs %}
{% tab title="Installing" %}
Sed posuere consectetur est at lobortis. Integer posuere erat a ante venenatis dapibus posuere velit aliquet. Aenean lacinia bibendum nulla sed consectetur. Maecenas sed diam eget risus varius blandit sit amet non magna.

```
string | ComponentClass<any, any> | FunctionComponent<any>
```

{% endtab %}

{% tab title="Second tab" %}
Maecenas faucibus mollis interdum. Donec id elit non mi porta gravida at eget metus. Donec ullamcorper nulla non metus auctor fringilla. Donec sed odio dui. Donec ullamcorper nulla non metus auctor fringilla.
{% endtab %}
{% endtabs %}


# Getting set up

<details>

<summary>Step1: Creating your organization</summary>

</details>

<details>

<summary>Step 2: Inviting your team</summary>

</details>

<details>

<summary>Step 3: Making your first post</summary>

</details>

<details>

<summary>Step 4: Publishing a post</summary>

</details>


# Setting permissions

{% hint style="info" %}
**GitBook tip:** your product docs aren't just a reference of all your features, use them to encourage folks to perform certain actions and discover the value in your product.
{% endhint %}

## Permission levels

There are 4 types of permission levels in the product.

<table><thead><tr><th width="180">Role</th><th>Capabilities</th></tr></thead><tbody><tr><td>Administrator</td><td>Has all admin privileges</td></tr><tr><td>Editor</td><td>Can edit posts</td></tr><tr><td>Viewer</td><td>Can only view posts</td></tr><tr><td>Guest</td><td>Can only view posts they are inivted to</td></tr></tbody></table>


# Inviting Members

{% hint style="info" %}
**GitBook tip:** Try out a range of different content types to keep folks engaged and interested in each feature, some content types work for different chunks of information
{% endhint %}

<details>

<summary>As a Guest User</summary>

</details>

<details>

<summary>As an Editor</summary>

</details>

<details>

<summary>As an Admin</summary>

</details>