DiscordEasyWhitelist

# DiscordEasyWhitelist ## Table of Contents - (#overview) - (#slash-commands) - (#configuration) - (#installation) - (#examples) --- # Overview DiscordEasyWhitelist provides both simple access to the SimpleWhitelist and advanced features for managing player access to the server. Nearly all features can be disabled or modified, allowing for flexible customization. --- # Slash Commands > 💡 Tip: > `` in square brackets **are not** required > `<variables>` in angle brackets **are** required ## /whitelist > 💡 Tip: > **Requires moderator role to access** Provides access to SimpleWhitelist ### `/whitelist check <nickname>` * Checks if SimpleWhitelist contains specified nickname ### `/whitelist add <nickname>` * Adds specified `nickname` to SimpleWhitelist ### `/whitelist remove <nickname>` * Removed specified `nickname` from SimpleWhitelist ## /link > 💡 Tip: > **Requires moderator role to access** Provides access to DiscordSRV's linking feature ### `/link check ` * Checks if `user` **OR** `nickname`. Only one argument is needed ### `/link add <user> <nickname>` * Links `user` with `nickanme` if both of them aren't linked yet ### `/link remove ` * Removes link from `user` **OR** `nickname`. Only one argument is needed ## /accept > 💡 Tip: > **Requires moderator role to access** ### `/accept <user> <nickname>` Complex comand that can execute following tasks if configured accordingly: * Link `user` to `nickname` * Add `nickname` to SimpleWhitelist * Change `user`'s guild name to `nickname` * Add specified list of roles to `user` * Remove specified list of roles from `user` * Send welcome message in specified channel ## /remove > 💡 Tip: > **Requires moderator role to access** ### `/remove <user> ` > ❗ Important: > `nickname` is optional argument because command can execute series of checks to determine `nickname` on it's own if it wasn't provided. > Details on this will be provided later in (#-configuration) section Complex comand that can execute following tasks if configured accordingly: * Unlink `user` from any in-game nickname * Remove `nickname` from SimpleWhitelist * Kick from game if `nickname` is on the server * Ban `user` from guild * Send remove message in specified channel * Send direct message to `user` ## /status > 💡 Tip: > **Does NOT require moderator role to access** ### `/status` * Prints amount of players online, list of them, while annotation linked players with discord mention ## /reload > 💡 Tip: > **Requires moderator role to access** ### `/reload` * Reloads config options from files # Configuration Plugin uses 2 files to configurate itself: * `general.yml` - Contains options to disable/enable certain funmctionality, but also contains role and channel IDs * `langugae.yml` - Contains all possible feedback messages plugin can send > ❗ Important: > If files doesn't exist (e.g. on first start), `general.yml`, `langugae.yml` **AND** `langugae.russian.yml` will be generated. > `langugae.russian.yml` is `langugae.yml` translated to russian langugae ## `general.yml` ### `moderator-roles` * Type: List of strings * Description: List of discord role IDs that will be treated as moderators --- ### `whitelist` #### `enable` * Type: Boolean * Description: If `/whitelist` slash command will be enabled --- ### `link` #### `enable` * Type: Boolean * Description: If `/link` slash command will be enabled --- ### `accept` #### `enable` * Type: Boolean * Description: If `/accept` slash command will be enabled #### `link-to-nickname` * Type: Boolean * Description: If `user` should be linked to `nickname` #### `add-to-whitelist` * Type: Boolean * Description: If `nickname` should be added to SimpleWhitelist #### `change-guild-name` * Type: Boolean * Description: If `user`'s guild name should be changed to `nickname` #### `add-roles` * Type: Boolean * Description: If bot should add roles to `user` #### `roles-to-add` * Type: List of strings * Description: List of role IDs that should be added to `user` #### `remove-roles` * Type: Boolean * Description: If bot should remove roles from `user` #### `roles-to-remove` * Type: List of strings * Description: List of role IDs that should be removed from `user` #### `send-welcome-message` * Type: Boolean * Description: If bot should send welcome message to specified channel #### `welcome-channel-id` * Type: String * Description: Channel ID where welcome message should be sent --- ### `remove` #### `enable` * Type: Boolean * Description: If `/remove` slash command will be enabled #### `unlink-from-nickname` * Type: Boolean * Description: If `user` should be unlinked from any linked nickname #### `fallback-to-guild-username` * Type: Boolean * Description: If `/remove` should fallback to guild name if it can't determine nickname from linking. `/remove` uses series of checks to determine nickname if it wasn't