Plugin's features & config

Here you can find explanations of almost all plugin features. You can find screenshots and/or text explanations of every feature.

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)

Service:

InstallationIndicator

This can help you know what's going on with plugin. This can help you know what's going on with plugin. There are some indicators of plugin work that'll be changed until plugin setup success ❘ LAUNCHED - Plugin was launched for the first time ❘ TOKEN_ERROR - Plugin can't login bot with token you've provided ❘ SECURE_ERROR - Plugin can't encrypt/decrypt token you've provided [Contact developer] ❘ JDA_ERROR - Bot can't login for some reasons [Contact developer] ❘ INSTALLED - Plugin successfully installed and works fine

Version:

Current version of plugin's components

Check-Updates

Should plugin send message about updates of a plugin to a player and in console?

Token

Required to start the plugin. You can find Bot Token on Discord Developer Portal Some instructions how to setup this plugin: 1 ❘ Go to Discord Developer Portal, create(or choose existing) bot 2 ❘ Go to his settings, then go to 'Bot' page and enable in 'Privileged Gateway Intents' header: PRESENCE INTENT, SERVER MEMBERS INTENT and MESSAGE CONTENT INTENT 3 ❘ Scroll up and tap 'Reset bot token' button, then copy this token and replace 'ReplaceThisWithYourBotToken' with your token 4 ❘ Save config and reload the server

TokenReplacement

You should use this when you change your token to make it secured again. Some instructions of usage: 1 ❘ Turn off your server(or, if you use ReloadModule, you can keep server online) 2 ❘ Go to config, then enable TokenReplacement(replace 'false' to 'true') 3 ❘ Replace your Token with new one 4 ❘ Save your config, then you can enable server(or, if you use ReloadModule, reload plugin) This feature will set to 'false' when encryption success

GuildID

(Requires developer mode enabled!) Copy your guildID using: RMB on your server -> click on COPY ID button

Language

Defines what language will plugin use to send messages You can translate language file by yourself(and suggest your translation on our Discord server) or use pre-translated supported languages files List of supported languages ❘ here

Database:

Type

Defines which database type plugin will use to store data You can use following types (case-sensitive): ❘ SQLite - local file database. Designed for small servers ❘ MySQL - server database. Designed for all networks

Other 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.

Settings:

Discord.Bot.Activity:

Status&Activities

You can choose if you wanna set custom status and bot activities to bot. Defines will plugin change bot's status and activity

Status

Defines which type of status bot will use. Available types(DND = Do Not Disturb): Online | DND | Idle | Invisible

Type

Defines which type of activity bot will use. Available types: Playing | Listening | Watching | Streaming | Competing

Text

Complements type. You can set any text(not so long), like: "Playing Minecraft server | 2 players online"

URL

Working only for 'Streaming' type! Grants user open this URL while bot "streaming" something. For example, works with 'https://www.twitch.tv/user' & 'https://www.youtube.com/watch?v=ID'

Plugin.ChannelD:

Whitelist

You need provide valid channelID in which you wanna player's being whitelisted

Global

ChannelID that used for texting about welcome users. Here you need provide valid channelID in which whitelisted player will receive Welcome message Required for WHITELIST_WELCOME_MESSAGE (7) feature.

Logs

In this channel you will receive every log message after some action(for example, whitelisting, linking or check). As before, needs valid ID Required for LOGGING (16) feature.

Plugin.RoleID:

Admin

[Discord Role] Plugin will check for role with this ID(s) when user uses '/whitelist' SlashCommand Grants access to use '/whitelist' SlashCommand

Whitelist.Add

[Discord Role] Plugin will add role(s) with this ID(s) when user added in whitelist

Whitelist.Remove

[Discord Role] Plugin will remove role(s) with this ID(s) when user was whitelisted

Link.Add

[Discord Role] Plugin will add role(s) with this ID(s) when user linked his accounts [] Role(s) will be removed when user unlink his accounts

Link.Remove

[Discord Role] Plugin will remove role(s) with this ID(s) when user linked his accounts [] Role(s) will be added back when user unlink his accounts

Reactions.Add

[Discord Role] Plugin will add role(s) with this ID(s) when player click on ReactionButton

Reactions.Remove

[Discord Role] Plugin will remove role(s) with this ID(s) when player click on ReactionButton

Require.Whitelist

[Discord Role] Plugin will require role(s) with this ID(s) to whitelist user

Require.Link

[Discord Role] Plugin will require role(s) with this ID(s) to link accounts

Plugin.Blacklist:

Nickname

Plugin will deny these nicknames being whitelisted When user tries whitelist his nickname and it found in this list - his try would be rejected

ID

Plugin will check user for his Discord Account ID, and if this list contains this ID, he will be denied being whitelisted. Message equals with blacklisted nicknames

Plugin

Settings.BedrockSymbol

Special symbol for 'BEDROCK_SUPPORT' feature User will be able to place this symbol before his nickname in message and plugin will add his nickname with this symbol before nickname in whitelist

Message.Welcome.Type

Type of message that will be used on Welcome Message. This will affect on message style. Available types: EMBED: TEXT:

Enabled

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

EPHEMERAL_MESSAGES

If this setting enabled - all messages sent by users and bot(except logs) will be deleted after 15-60(120 for useful messages) seconds

WHITELIST_ROLE_ADD

Defines will user get role when he was whitelisted. Uses 'RoleID.Whitelist.Add' as role

WHITELIST_ROLE_REMOVE

Defines will user lose role when he was whitelisted. Uses 'RoleID.Whitelist.Remove' as role

BLACKLIST

Defines will blacklist feature be enabled

WHITELIST_CHANGE_NAME

Defines will user's nickname be changed when he was whitelisted

WHITELIST_DM

Defines will Direct Message be sent to user when he was whitelisted If enabled:

WHITELIST_WELCOME_MESSAGE

Defines will bot send message into 'ChannelID.Global' channel when user was whitelisted You can choose between: EMBED: and TEXT:

WHITELIST_CONFIRMATION_MENU

Defines will confirmation menu will send to user when he's trying being whitelisted When enabled: and when disabled:

EWHITELIST

Defines will plugin use own Nickname-based whitelist system Old screenshot:

REACTIONS

Defines will plugin add 'RoleID.Reactions.Add'/remove 'RoleID.Reactions.Remove' when user click on special button:

REQUIRE_ROLE

Defines will plugin require role(s) to whitelist 'RoleID.Require.Whitelist'/link user 'RoleID.Require.Link'

REGEX_CHECK

Defines will plugin check nickname before adding/removing it to/from whitelist (for SlashCommand)

BEDROCK_SUPPORT

Defines will plugin allow use 'BedrockSymbol' before nickname and add native support for Geyser(Floodgate) (screenshot soon)

LINKING

Defines will linking system be turned on and can players(users) use its commands In Discord: In-Game:

LINKING_LEFT_USERS_REMOVE

Defines, will plugin unlink user's accounts and remove his from whitelist when he left from Discord server (screenshot soon)

LINKING_NAME_CHANGE

Defines will linked discord user's nickname changed like his Minecraft nickname (or changed when he unlinked his account)

LOGGING

Defines will plugin send logs(for whitelisting/linking/checking) in channel. Uses 'ChannelID.Logs' as logs channel. Example:

EWhitelist

Enabled

Defines will EWhitelist be enabled (not overrides 'Plugin.Settings.Enabled' section)

Maintenance

Defines will Maintenance be turned on (only Administrators added in whitelist can join)

Message.Blacklisted

Message when player trying join the server while he blacklisted

Message.OnMaintenance

Message for player when he's trying join the server while Maintenance mode turned on

Message.NotWhitelisted

Message when not whitelisted player trying to join

---

We hope that this explanation helped you! Feel free to ask any questions on our Discord server. Use buttons below to navigate to next page(or previous).