# Plugin's features & config

{% hint style="info" %}
Here you can find explanations of almost all plugin features. You can find screenshots and/or text explanations of every feature.
{% endhint %}

{% hint style="info" %}
Most of features requires you to provide ID(s) of role(s), channel(s) or your server.\
You can get their ID(s) only when you've enabled **Developer Mode** in your **Discord** settings.\
Click on **User Settings** button(gear icon) -> in **App Settings category** find **Advanced** point, click on it -> enable Developer Mode by switch switcher to on(will be green colored)
{% endhint %}

## Service:

<mark style="color:green;">Section where you NEED to configure basic settings without which the plugin will not start</mark>

### &#x20;   Language

&#x20;    <mark style="color:green;">Defines what language will be used to send messages</mark>\
&#x20;    <mark style="color:green;">You can translate language file by yourself(and suggest your translation on our Discord server)</mark>\
&#x20;    <mark style="color:green;">or use pre-translated supported languages files</mark>\
&#x20;    <mark style="color:green;">List of supported languages ❘</mark> [here](https://windstudio.gitbook.io/discordwhitelist/step-by-step-setting/setting-up-our-bot)

### &#x20;   Check-Updates

&#x20;    <mark style="color:green;">Should plugin send message about updates of a plugin to a player(OP & Permission) and in console?</mark>

### &#x20;   ServerID

&#x20;    <mark style="color:green;">(Requires developer mode enabled!)</mark>\
&#x20;    <mark style="color:green;">Copy your guildID using: RMB on your server -> click on</mark> <mark style="color:green;"></mark><mark style="color:green;">**COPY ID**</mark> <mark style="color:green;"></mark><mark style="color:green;">button</mark>

### &#x20;   Token

&#x20;    <mark style="color:green;">Required to start the plugin.</mark>\
&#x20;    <mark style="color:green;">You can find Bot Token on</mark> [<mark style="color:purple;">**Discord Developer Portal**</mark>](https://discord.com/developers/applications)\
&#x20;    <mark style="color:green;">Some instructions how to setup this plugin:</mark>\
&#x20;     <mark style="color:green;">1 ❘ Go to Discord Developer Portal, create(or choose existing) bot</mark>\
&#x20;     <mark style="color:green;">2 ❘ Go to his settings, then go to 'Bot' page and enable in 'Privileged Gateway Intents' header:</mark>\
&#x20;     <mark style="color:green;">PRESENCE INTENT, SERVER MEMBERS INTENT and MESSAGE CONTENT INTENT</mark>\
&#x20;     <mark style="color:green;">3 ❘ Scroll up and tap 'Reset bot token' button, then copy this token and replace</mark>\
&#x20;     <mark style="color:green;">'ReplaceThisWithYourBotToken' with your token</mark>\
&#x20;     <mark style="color:green;">4 ❘ Save config and reload the server</mark>

### &#x20;   TokenReplacement

&#x20;    Since plugin uses unique encryption system for every token,\
&#x20;    <mark style="color:green;">plugin generate a unique password to access your token, so</mark>\
&#x20;    <mark style="color:green;">you should enable this if you want to change your token to</mark>\
&#x20;    <mark style="color:green;">let plugin generate new password for your new token.</mark>     \
&#x20;    <mark style="color:green;">Some instructions of usage:</mark>\
&#x20;     <mark style="color:green;">1 ❘ Turn off your server(or, if you use ReloadModule, you can keep server online)</mark>\
&#x20;     <mark style="color:green;">2 ❘ Go to config, then enable TokenReplacement(replace 'false' to 'true')</mark>\
&#x20;     <mark style="color:green;">3 ❘ Replace your Token with new one</mark>\
&#x20;     <mark style="color:green;">4 ❘ Save your config, then you can enable server(or, if you use ReloadModule, reload plugin)</mark>\
&#x20;    <mark style="color:green;">This feature will set to 'false' when encryption success</mark>

### &#x20;   Version:

&#x20;    <mark style="color:green;">Current version of plugin's components</mark>\
&#x20;    <mark style="color:green;">Please, use this to report any problem related to plugin</mark>

### &#x20;   InstallationIndicator

&#x20;   <mark style="color:green;">This can help you know what's going on with plugin. This can help you know what's going on with</mark>\
&#x20;   <mark style="color:green;">plugin. There are some indicators of plugin work that'll be changed until plugin setup success</mark> \
&#x20;    <mark style="color:green;">❘ LAUNCHED - Plugin was launched for the first time</mark>\
&#x20;    <mark style="color:green;">❘ TOKEN\_ERROR - Plugin can't login bot with token you've provided</mark>\
&#x20;    <mark style="color:green;">❘ SECURE\_ERROR - Plugin can't encrypt/decrypt token you've provided \[Contact developer]</mark>\
&#x20;    <mark style="color:green;">❘ JDA\_ERROR - Bot can't login for some reasons \[Contact developer]</mark>\
&#x20;    <mark style="color:green;">❘ INSTALLED - Plugin successfully installed and works fine</mark>

## Database:

<mark style="color:green;">Database-related section, where you can change database type and its settings</mark>

### &#x20;   Type

&#x20;    <mark style="color:green;">Defines which database type plugin will use to store data</mark>\
&#x20;    <mark style="color:green;">You can use following types (case-sensitive):</mark>\
&#x20;     <mark style="color:green;">❘ SQLite - local file database. Designed for small servers</mark>\
&#x20;     <mark style="color:green;">❘ MySQL - server database. Designed for networks</mark>

{% hint style="info" %}
Other database settings you can find inside your **config.yml** and usually it's doesn't needs to be changed. All information also included near these settings, so you can easily see what they do.
{% endhint %}

## Configuration:

<mark style="color:green;">Section, where you can configure main features of plugin</mark>

### &#x20;  Discord.Bot.Activity:

&#x20;  <mark style="color:green;">Section, settings of which related to your bot</mark>

&#x20;  ![](https://3012341793-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F3ZvojSJcFt9CbKM0Giif%2Fuploads%2FkRwTGaJtzgJqdW0ftI55%2Fimage.png?alt=media\&token=7bd6cc61-2f40-4e21-9d75-c02859a68e08)

&#x20;        Status\&Activities

&#x20;        <mark style="color:green;">You can choose if you wanna set custom status and bot activities to bot.</mark>\
&#x20;        <mark style="color:green;">Defines will plugin change bot's status and activity</mark>

#### &#x20;        Status

&#x20;        <mark style="color:green;">Defines which type of status bot will use.</mark>\
&#x20;        <mark style="color:green;">Available types(DND = Do Not Disturb):</mark>\
&#x20;        <mark style="color:green;">Online | DND | Idle | Invisible</mark>

#### &#x20;        Type

&#x20;        <mark style="color:green;">Defines which type of activity bot will use.</mark>\
&#x20;        <mark style="color:green;">Available types: Playing | Listening | Watching | Streaming | Competing</mark>

#### &#x20;        Text

&#x20;        <mark style="color:green;">Complements type. You can set any text(not so long), like:</mark> \
&#x20;        <mark style="color:green;">"Playing Minecraft server | 2 players online"</mark>\
&#x20;        <mark style="color:green;">This feature can count online players, so it</mark>\
&#x20;        <mark style="color:green;">supports vanish plugins to not count invisible players.</mark> \
&#x20;        <mark style="color:green;">Detected and supported vanish plugins you can find</mark> \
&#x20;        <mark style="color:green;">at the end of the config.</mark>

#### &#x20;        URL

&#x20;        <mark style="color:green;">Working only for 'Streaming'</mark> <mark style="color:green;"></mark><mark style="color:green;">**type**</mark><mark style="color:green;">! Grants user open this URL while bot "streaming" something.</mark>\
&#x20;        <mark style="color:green;">For example, works with 'https://www.twitch.tv/user' & 'https://www.youtube.com/watch?v=ID'</mark>

### &#x20;  Plugin.ChannelD:

&#x20;  <mark style="color:green;">Settings which contains all IDs of channels that plugin will use</mark>

#### &#x20;        Whitelist

&#x20;        <mark style="color:green;">This channel will be defined as channel where</mark> \
&#x20;        <mark style="color:green;">users can type their nickname to be whitelisted</mark>

#### &#x20;        Global

&#x20;        <mark style="color:green;">That channel will be defined as channel where</mark>\
&#x20;        <mark style="color:green;">bot will send welcome messages for whitelisted users</mark>\
&#x20;        <mark style="color:green;">Here you need provide valid channelID in which whitelisted player will receive</mark> <mark style="color:green;"></mark>_<mark style="color:green;">Welcome</mark>_ <mark style="color:green;"></mark><mark style="color:green;">message</mark>\
&#x20;        <mark style="color:green;">Required for WHITELIST\_WELCOME\_MESSAGE (7) feature.</mark>

#### &#x20;        Logs

&#x20;        <mark style="color:green;">In this channel you will receive every log message after some action(for example, whitelisting,</mark>\
&#x20;        <mark style="color:green;">linking or check). As before, needs valid ID</mark>\
&#x20;        <mark style="color:green;">Required for LOGGING (16) feature.</mark>

### &#x20;  Plugin.RoleID:

&#x20;  <mark style="color:green;">Settings which contains all IDs of roles that plugin will use</mark>

#### &#x20;        Admin

&#x20;        <mark style="color:green;">\[Discord Role]</mark> \
&#x20;        <mark style="color:green;">Plugin will check for role with this ID(s) when user uses '/whitelist' SlashCommand</mark>\
&#x20;        <mark style="color:green;">Grants access to use '/whitelist' SlashCommand</mark>

#### &#x20;        Whitelist.Add

&#x20;        <mark style="color:green;">\[Discord Role]</mark>\
&#x20;        <mark style="color:green;">Plugin will add role(s) with this ID(s) when user added in whitelist</mark>

#### &#x20;        Whitelist.Remove

&#x20;       <mark style="color:green;">\[Discord Role]</mark>\
&#x20;        <mark style="color:green;">Plugin will remove role(s) with this ID(s) when user was whitelisted</mark>

#### &#x20;        Link.Add

&#x20;        <mark style="color:green;">\[Discord Role]</mark> \
&#x20;        <mark style="color:green;">Plugin will add role(s) with this ID(s) when user linked his accounts</mark>\
&#x20;        <mark style="color:green;">\[] Role(s) will be removed when user unlink his accounts</mark>

#### &#x20;        Link.Remove

&#x20;        <mark style="color:green;">\[Discord Role]</mark>\
&#x20;        <mark style="color:green;">Plugin will remove role(s) with this ID(s) when user linked his accounts</mark>\
&#x20;        <mark style="color:green;">\[] Role(s) will be added back when user unlink his accounts</mark>

#### &#x20;        Reactions.Add

&#x20;        <mark style="color:green;">\[Discord Role]</mark>\
&#x20;        <mark style="color:green;">Plugin will add role(s) with this ID(s) when player click on ReactionButton</mark>

#### &#x20;        Reactions.Remove

&#x20;        <mark style="color:green;">\[Discord Role]</mark> \
&#x20;        <mark style="color:green;">Plugin will remove role(s) with this ID(s) when player click on ReactionButton</mark>

#### &#x20;        Require.Whitelist

&#x20;        <mark style="color:green;">\[Discord Role]</mark> \
&#x20;        <mark style="color:green;">Plugin will require role(s) with this ID(s) to whitelist user</mark>

#### &#x20;        Require.Link

&#x20;        <mark style="color:green;">\[Discord Role]</mark> \
&#x20;        <mark style="color:green;">Plugin will require role(s) with this ID(s) to link accounts</mark>

### &#x20;  Plugin.Blacklist:

&#x20; <mark style="color:green;">Settings related to blacklist</mark>

#### &#x20;        Nickname

&#x20;        <mark style="color:green;">Plugin will deny these nicknames being whitelisted</mark>\
&#x20;        <mark style="color:green;">When user tries whitelist his nickname and it found in this list - his try would be rejected</mark>

&#x20;       ![](https://3012341793-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F3ZvojSJcFt9CbKM0Giif%2Fuploads%2FfWgLFK8Qn8TqlcEiT1X7%2F%D0%B8%D0%B7%D0%BE%D0%B1%D1%80%D0%B0%D0%B6%D0%B5%D0%BD%D0%B8%D0%B5.png?alt=media\&token=c2d848a2-e947-4574-9aeb-e3740fc21a0f)

#### &#x20;        ID

&#x20;        <mark style="color:green;">Plugin will check user for his Discord Account ID,</mark>\
&#x20;        <mark style="color:green;">and if this list contains this ID,</mark>\
&#x20;        <mark style="color:green;">he will be denied being whitelisted.</mark>\
&#x20;        <mark style="color:green;">Message equals with blacklisted nicknames</mark>\
&#x20;       ![](https://3012341793-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F3ZvojSJcFt9CbKM0Giif%2Fuploads%2FojSxRH1MYC8WNUUldLjs%2F%D0%B8%D0%B7%D0%BE%D0%B1%D1%80%D0%B0%D0%B6%D0%B5%D0%BD%D0%B8%D0%B5.png?alt=media\&token=c41c5db9-f085-41ec-afa7-faa263de2aba)

## Plugin

<mark style="color:green;">Section, where you can turn on/off every feature of plugin,</mark>\ <mark style="color:green;">configure some of them and read small description of every</mark>\ <mark style="color:green;">feature, configure EWhitelist and Vanish support</mark>

### &#x20;   Settings.BedrockSymbol

&#x20;   <mark style="color:green;">Special symbol for '</mark><mark style="color:green;">**BEDROCK\_SUPPORT**</mark><mark style="color:green;">' feature</mark>\
&#x20;   <mark style="color:green;">User will be able to place this symbol before his nickname</mark>\
&#x20;   <mark style="color:green;">in message and plugin will add his nickname</mark>\
&#x20;   <mark style="color:green;">with this symbol before nickname in whitelist</mark>\
&#x20;   <mark style="color:green;">/!\ It's not actual support of GeyserMC, patience and</mark>\
&#x20;   <mark style="color:green;">it will be added in the future.</mark>

### &#x20;   Message.Welcome.Type

&#x20;   <mark style="color:green;">Type of message that will be used on Welcome Message.</mark>\
&#x20;   <mark style="color:green;">This will affect on message style.</mark>\
&#x20;   <mark style="color:green;">Available types:</mark> \
&#x20;     <mark style="color:green;">EMBED:</mark>\
&#x20;     ![](https://3012341793-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F3ZvojSJcFt9CbKM0Giif%2Fuploads%2FY02OzACRjwqF8M9yuizh%2F%D0%B8%D0%B7%D0%BE%D0%B1%D1%80%D0%B0%D0%B6%D0%B5%D0%BD%D0%B8%D0%B5.png?alt=media\&token=b4d274f4-d4d5-417b-ab50-1a336aa6512c)\
&#x20;     <mark style="color:green;">TEXT:</mark>\
&#x20;     ![](https://3012341793-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F3ZvojSJcFt9CbKM0Giif%2Fuploads%2Flu12RVWaE4YfBsxEIwEV%2F%D0%B8%D0%B7%D0%BE%D0%B1%D1%80%D0%B0%D0%B6%D0%B5%D0%BD%D0%B8%D0%B5.png?alt=media\&token=dc5a1cb5-003f-40c8-a270-dcc97d4dddc2)

### &#x20;   Enabled

&#x20;    <mark style="color:green;">!!! ❘ PLEASE,</mark> <mark style="color:green;"></mark><mark style="color:green;">**𝐃𝐎 𝐍𝐎𝐓**</mark> <mark style="color:green;"></mark><mark style="color:green;">ENABLE 2 SAME FEATURES AT SAME MOMENT - IT WILL FORCE RUN</mark>\
&#x20;          <mark style="color:green;">THEM TWICE!</mark>\
\
&#x20;    <mark style="color:green;">Documentation of how-to-use this system:</mark>\
\
&#x20;    <mark style="color:green;">1 ❘ Section 'Plugin.Settings.Enabled' contains all enabled features that plugin will use as list</mark>\
&#x20;    <mark style="color:green;">2 ❘ To enable some feature, read all description texted below, then scroll down in 'Enabled' section</mark>\
&#x20;         <mark style="color:green;">and add line with that feature in this list feature you need. This will look something like this:</mark>\
&#x20;         <mark style="color:green;">| ...:                                                        |</mark>\
&#x20;         <mark style="color:green;">| Enabled:                                            |</mark>\
&#x20;         <mark style="color:green;">|   - "EPHEMERAL\_MESSAGES"   |</mark>\
&#x20;         <mark style="color:green;">|   - "EWHITELIST"                            |</mark>\
&#x20;         <mark style="color:green;">|                                                             |</mark>\
\
&#x20;    <mark style="color:green;">3 ❘ To disable any feature, you just need remove line with this feature. This will look something like</mark>\
&#x20;          <mark style="color:green;">this:</mark>\
&#x20;          <mark style="color:green;">| ...:                                                        |</mark>\
&#x20;          <mark style="color:green;">| Enabled:                                            |</mark>\
&#x20;          <mark style="color:green;">|   - "EPHEMERAL\_MESSAGES"   |</mark>\
&#x20;          <mark style="color:green;">|                                                             |</mark>\
&#x20;      <mark style="color:green;">As you can see, feature named "EWHITELIST" does not enabled right now  as shown above</mark>\
&#x20;      <mark style="color:green;">By default almost some features commented to disable them, you can enable them by removing '#'</mark>\
&#x20;      <mark style="color:green;">before '-', or just remove this line(to be honest, unnecessary) if you don't need them.</mark>\
&#x20;    <mark style="color:green;">We hope this mini-tutorial was helpful for you.</mark>\
\
&#x20;    <mark style="color:green;">Description of every feature listed below:</mark>

#### &#x20;        EPHEMERAL\_MESSAGES

&#x20;        <mark style="color:green;">If this setting enabled - all messages sent by users and bot(except logs) will be deleted after</mark>\
&#x20;        <mark style="color:green;">15-60(120 for useful messages) seconds</mark>

#### &#x20;        WHITELIST\_ROLE\_ADD

&#x20;        <mark style="color:green;">Defines will user get role when he was whitelisted. Uses '</mark>_<mark style="color:green;">RoleID.Whitelist.Add</mark>_<mark style="color:green;">' as role</mark>

#### &#x20;        WHITELIST\_ROLE\_REMOVE

&#x20;        <mark style="color:green;">Defines will user lose role when he was whitelisted. Uses '</mark>_<mark style="color:green;">RoleID.Whitelist.Remove</mark>_<mark style="color:green;">' as role</mark>

#### &#x20;        BLACKLIST

&#x20;        <mark style="color:green;">Defines will blacklist feature be enabled</mark>\
&#x20;       ![](https://3012341793-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F3ZvojSJcFt9CbKM0Giif%2Fuploads%2FfWgLFK8Qn8TqlcEiT1X7%2F%D0%B8%D0%B7%D0%BE%D0%B1%D1%80%D0%B0%D0%B6%D0%B5%D0%BD%D0%B8%D0%B5.png?alt=media\&token=c2d848a2-e947-4574-9aeb-e3740fc21a0f)

#### &#x20;        WHITELIST\_CHANGE\_NAME

&#x20;        <mark style="color:green;">Defines will user's nickname be changed when he was whitelisted</mark>

#### &#x20;        WHITELIST\_DM

&#x20;        <mark style="color:green;">Defines will Direct Message be sent to user when he was whitelisted</mark>\
&#x20;        <mark style="color:green;">If enabled:</mark> \
&#x20;        ![](https://3012341793-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F3ZvojSJcFt9CbKM0Giif%2Fuploads%2Fr4mn7K0gMDdvWY7z0HkR%2F%D0%B8%D0%B7%D0%BE%D0%B1%D1%80%D0%B0%D0%B6%D0%B5%D0%BD%D0%B8%D0%B5.png?alt=media\&token=c460d925-5055-4075-85aa-cf502cbb7a88)

#### &#x20;        WHITELIST\_WELCOME\_MESSAGE

&#x20;        <mark style="color:green;">Defines will bot send message into 'ChannelID.Global' channel when user was whitelisted</mark>\
&#x20;        <mark style="color:green;">You can choose between:</mark> \
&#x20;        _<mark style="color:green;">EMBED:</mark>_\
&#x20;        ![](https://3012341793-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F3ZvojSJcFt9CbKM0Giif%2Fuploads%2FY02OzACRjwqF8M9yuizh%2F%D0%B8%D0%B7%D0%BE%D0%B1%D1%80%D0%B0%D0%B6%D0%B5%D0%BD%D0%B8%D0%B5.png?alt=media\&token=b4d274f4-d4d5-417b-ab50-1a336aa6512c)\
&#x20;        <mark style="color:green;">and</mark> <mark style="color:green;"></mark>_<mark style="color:green;">TEXT</mark>_<mark style="color:green;">:</mark>\
&#x20;        ![](https://3012341793-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F3ZvojSJcFt9CbKM0Giif%2Fuploads%2Flu12RVWaE4YfBsxEIwEV%2F%D0%B8%D0%B7%D0%BE%D0%B1%D1%80%D0%B0%D0%B6%D0%B5%D0%BD%D0%B8%D0%B5.png?alt=media\&token=dc5a1cb5-003f-40c8-a270-dcc97d4dddc2)

#### &#x20;        WHITELIST\_CONFIRMATION\_MENU

&#x20;        <mark style="color:green;">Defines will confirmation menu will send to user when he's trying being whitelisted</mark>\
&#x20;        <mark style="color:green;">When enabled:</mark>\
&#x20;        ![](https://3012341793-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F3ZvojSJcFt9CbKM0Giif%2Fuploads%2FrZhHBd7F31qvJggaLPwT%2F%D0%B8%D0%B7%D0%BE%D0%B1%D1%80%D0%B0%D0%B6%D0%B5%D0%BD%D0%B8%D0%B5.png?alt=media\&token=369b3c14-6ec1-4511-b6fa-4e1ea191ba47)\
&#x20;        <mark style="color:green;">and when disabled:</mark> \
&#x20;        ![](https://3012341793-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F3ZvojSJcFt9CbKM0Giif%2Fuploads%2FRp9jfQfvuqLnENAMALgQ%2F%D0%B8%D0%B7%D0%BE%D0%B1%D1%80%D0%B0%D0%B6%D0%B5%D0%BD%D0%B8%D0%B5.png?alt=media\&token=19f06e2f-9b3f-4244-b7f6-441906ab3730)

#### &#x20;        EWHITELIST

&#x20;        <mark style="color:green;">Defines will plugin use own Nickname-based whitelist system</mark>\
&#x20;        <mark style="color:green;">Old screenshot:</mark>\
&#x20;        ![](https://3012341793-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F3ZvojSJcFt9CbKM0Giif%2Fuploads%2Fj77DR1DWL3JuT50Gnfpw%2F%D0%B8%D0%B7%D0%BE%D0%B1%D1%80%D0%B0%D0%B6%D0%B5%D0%BD%D0%B8%D0%B5.png?alt=media\&token=d0f948f7-c87f-47a7-acbb-7f8a672fc103)

#### &#x20;        REACTIONS

&#x20;        <mark style="color:green;">Defines will plugin add 'RoleID.Reactions.Add'/remove 'RoleID.Reactions.Remove' when</mark> \
&#x20;        <mark style="color:green;">user click on special button:</mark>\
&#x20;        ![](https://3012341793-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F3ZvojSJcFt9CbKM0Giif%2Fuploads%2FAYoXbS0zSE2HcWxVOe3T%2F%D0%B8%D0%B7%D0%BE%D0%B1%D1%80%D0%B0%D0%B6%D0%B5%D0%BD%D0%B8%D0%B5.png?alt=media\&token=0e3a8652-d379-451a-acf5-d1b6196aee48)

#### &#x20;        REQUIRE\_ROLE

&#x20;        <mark style="color:green;">Defines will plugin require role(s) to whitelist 'RoleID.Require.Whitelist'/link user</mark>\
&#x20;        <mark style="color:green;">'</mark>_<mark style="color:green;">RoleID.Require.Link</mark>_<mark style="color:green;">'</mark>

#### &#x20;        REGEX\_CHECK

&#x20;        <mark style="color:green;">Defines will plugin check nickname before adding/removing it to/from whitelist</mark>\
&#x20;        <mark style="color:green;">(for SlashCommand)</mark>

#### &#x20;        BEDROCK\_SUPPORT

&#x20;        <mark style="color:green;">Defines will plugin allow use 'BedrockSymbol' before nickname and add native support</mark>\
&#x20;        <mark style="color:green;">for Geyser(Floodgate)</mark>\
&#x20;        <mark style="color:green;">(screenshot soon)</mark>

#### &#x20;        LINKING

&#x20;        <mark style="color:green;">Defines will linking system be turned on and can players(users) use its commands</mark>\
&#x20;        <mark style="color:green;">In Discord:</mark> \
&#x20;        ![](https://3012341793-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F3ZvojSJcFt9CbKM0Giif%2Fuploads%2FjBzncWtKgWGf1oaauWmF%2F%D0%B8%D0%B7%D0%BE%D0%B1%D1%80%D0%B0%D0%B6%D0%B5%D0%BD%D0%B8%D0%B5.png?alt=media\&token=f42514bf-fc77-43cb-b634-51541852da10)\
&#x20;        <mark style="color:green;">In-Game:</mark> \
&#x20;        ![](https://3012341793-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F3ZvojSJcFt9CbKM0Giif%2Fuploads%2F18o9kZzewRe4srfsvogu%2F%D0%B8%D0%B7%D0%BE%D0%B1%D1%80%D0%B0%D0%B6%D0%B5%D0%BD%D0%B8%D0%B5.png?alt=media\&token=7c30a947-3541-49ce-84d7-7659149c72d9)

#### &#x20;        LINKING\_LEFT\_USERS\_REMOVE

&#x20;        <mark style="color:green;">Defines, will plugin unlink user's accounts and remove his from whitelist when he left from</mark>\
&#x20;        <mark style="color:green;">Discord server</mark>\
&#x20;        <mark style="color:green;">(screenshot soon)</mark>

#### &#x20;        LINKING\_NAME\_CHANGE

&#x20;        <mark style="color:green;">Defines will linked discord user's nickname changed like his Minecraft nickname</mark>\
&#x20;        <mark style="color:green;">(or changed when he unlinked his account)</mark>

#### &#x20;        LOGGING

&#x20;        <mark style="color:green;">Defines will plugin send logs(for whitelisting/linking/checking) in channel.</mark>\
&#x20;        <mark style="color:green;">Uses '</mark>_<mark style="color:green;">ChannelID.Logs</mark>_<mark style="color:green;">' as logs channel.</mark>\
&#x20;        <mark style="color:green;">Example:</mark>\
&#x20;        ![](https://3012341793-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F3ZvojSJcFt9CbKM0Giif%2Fuploads%2FxK1Y4glajitx403bNTEl%2F%D0%B8%D0%B7%D0%BE%D0%B1%D1%80%D0%B0%D0%B6%D0%B5%D0%BD%D0%B8%D0%B5.png?alt=media\&token=7ce49041-962c-40f8-bd0a-593dec62057b)

### &#x20;   EWhitelist

&#x20;   <mark style="color:green;">EWhitelist is nickname-based type of whitelist, which is</mark>\
&#x20;   <mark style="color:green;">implemented directly into plugin. You can configure it</mark>\
&#x20;   <mark style="color:green;">as you want and as possible.</mark>

#### &#x20;        Enabled

&#x20;        <mark style="color:green;">Defines will EWhitelist be enabled (not overrides '</mark>_<mark style="color:green;">Plugin.Settings.Enabled</mark>_<mark style="color:green;">' section)</mark>\
&#x20;        <mark style="color:green;">Can be changed via the command /ewl enable/disable whitelist</mark>

#### &#x20;        Maintenance

&#x20;        <mark style="color:green;">Defines will Maintenance be turned on (only Administrators added in whitelist can join)</mark>\
&#x20;       <mark style="color:green;">Can be changed via the command /ewl enable/disable service</mark>

#### &#x20;        Sync

&#x20;   <mark style="color:green;">Defines, will plugin do a synchronization between</mark> \
&#x20;        <mark style="color:green;">EWhitelist and default whitelist (add/remove player)</mark>\
&#x20;        <mark style="color:green;">Currently does not synchronize exist players in both systems, only new players</mark>

#### &#x20;        Message.Blacklisted

&#x20;        <mark style="color:green;">EWhitelist kick message when player trying to join the server while he(player) is blacklisted</mark>

#### &#x20;        Message.OnMaintenance

&#x20;        <mark style="color:green;">EWhitelist kick message when player trying join the server</mark>\
&#x20;        <mark style="color:green;">while EWhitelist Maintenance mode turned on</mark>

#### &#x20;        Message.NotWhitelisted

&#x20;        <mark style="color:green;">EWhitelist kick message when not whitelisted player trying to join</mark>

### &#x20;   Vanish

&#x20;   <mark style="color:green;">Section where you can configure Vanish support for plugin</mark>\
&#x20;   <mark style="color:green;">This setting is critically important for you if</mark>\
&#x20;   <mark style="color:green;">you're using Status\&Activities feature, so now,</mark>\
&#x20;   <mark style="color:green;">if you configured this, plugin will ignore</mark>\
&#x20;   <mark style="color:green;">vanished players when count online players</mark>

#### &#x20;        Detected

&#x20;        <mark style="color:green;">The list of detected Vanish plugins.</mark>\
&#x20;        <mark style="color:green;">You don't have to change it, because it will be</mark>\
&#x20;        <mark style="color:green;">updated on every plugin startup</mark>

#### &#x20;        Supported

&#x20;        <mark style="color:green;">The list of supported Vanish plugins</mark>\
&#x20;        <mark style="color:green;">which support will be implemented</mark>\
&#x20;        <mark style="color:green;">in plugin, so plugin will use their</mark>\
&#x20;        <mark style="color:green;">API to detect vanished players.</mark>\
&#x20;        <mark style="color:green;">To enable Vanish plugin support just copy</mark>\
&#x20;        <mark style="color:green;">one of plugin's name in 'Detected' section</mark>\
&#x20;        <mark style="color:green;">above and paste it here as a list, example:</mark>\
&#x20;           <mark style="color:green;">Supported:</mark>\
&#x20;                <mark style="color:green;">- SuperVanish</mark>

***

{% hint style="success" %}
We hope that this explanation helped you! Feel free to ask any questions on our [Discord](https://windstudio.gitbook.io/discordwhitelist/our-contacts/discord) server. Use buttons below to navigate to next page(or previous).
{% endhint %}
