Discord Whitelister icon

Discord Whitelister -----

A simple spigot plugin which allows whitelisting through a discord text channel.




Updated and tested for minecraft version 1.20.4.

  • MESSAGE_CONTENT intent now required.
  • Spigot API version 1.17.1 -> 1.20.4
  • JDA v4-> v5
Tested for a limited time, please contact me if you face any errors.
----------, Jan 22, 2024

  • Now uses Discord's slash commands instead of the ! prefix (/whitelist instead of !whitelist)

  • Fixed errors during startup and shutdown when fresh configs

  • Added updating player count when players enter/exit vanished mode (Works with EssentialsX, SuperVanish, and VanishNoPacket)
Credit to Xyntexx & TheMrEngMan for this update.
----------, Aug 3, 2021

- LuckPerms support
- To enable set 'assign-perms-with-luck-perms' to 'true'
- Make sure you have 'use-server-uuid-cache' set to 'true' in LuckPerms config​

- GeyserMC/Floodgate support
- To enable set 'use-geyser/floodgate-compatibility' to 'true'
- Define 'geyser/floodgate prefix' in the config with the prefix you need​

- Remove a user's registered users from the whitelist if the specified role is not found
- To enable set 'un-whitelist-if-missing-role' to 'true'
- Define the required role by setting 'role-to-check-for' with your desired role name​

- Added crafatar as a secondary option for displaying players' skins
- To enable set 'use-crafatar-for-avatars' to 'true'​

- Bot now only filters out self, not other bots/webhooks
- Use webhooks with this bot at your own risk, they have not yet been tested​
----------, Mar 13, 2021

  • Fix for whitelisting amount issue

  • Added options to delete all unnecessary bot messages (everything except whitelist add & remove messages)
    • To enable set 'remove-unnecessary-messages-from-whitelist-channel' to 'true'
    • use 'seconds-to-remove-message-from-whitelist-channel' to set the desired wait time

  • You can now warn users that they are talking in a commands only channel
    • To enable this set 'show-warning-in-command-channel' to 'true'
    • By enabling 'remove-unnecessary-messages-from-whitelist-channel', this warning and the users message will be removed after a set amount of time
    • Warning message can be edited in 'custom-messages.yml'

  • Added an option to disable info commands
    • To enable set 'hide-info-command-replies' to 'true'
----------, Feb 3, 2021

Added @DiscordMention parameter to !whitelist add command for staff members.

  • Staff members can now add @DiscordMention to the end of the existing whitelist add command like so:
    • !whitelist add minecraftUsername @DiscordMention
  • This allows staff members to keep control of the whitelisting process without requiring user input.
  • With whitelisted-role-auto-add & whitelisted-role-auto-remove enabled, the bot will now add the user to the user list & assign roles automatically which previously the user would have to whitelist themselves to do.
----------, Dec 20, 2020

  • A few bug fixes
----------, Dec 5, 2020

  • Added '!whitelist clear' command for limited whitelisters:
    • This allows limited whitelisters to remove all their whitelisted minecraft names and regain the ability to whitelist up to the current max whitelist amount
    • The user will also have their Discord whitelisted-roles revoked if whitelisted-role-auto-remove is enabled (the role(s) will be re-added upon a successful whitelist)
    • This feature can be disabled by setting allow-limited-whitelisters-to-unwhitelist-self to false

  • Changed logging solution to Logback

  • re-shaded dependencies to avoid conflicts with other plugins

  • Better handling during on-ban event
----------, Nov 18, 2020

Quite a bit has been added since 1.3.8, so if you experience any issues please report them here: https://github.com/JoeShimell/DiscordWhitelisterSpigot/issues or add me on Discord: Joe#5782


Please check the wiki for more information on these added features: https://github.com/JoeShimell/DiscordWhitelisterSpigot/wiki/Configuration


  • Better handling when not eligible to access the 'GUILD_MEMBERS' intent
  • Merging premium version back to the free version - Thank you to the people that supported me over at mc-market
  • General bug fixes

  • In-game ban events
    • When enabled, the bot will listen in-game for the /ban command. When the ban command is executed and the target Minecraft username is linked to a Discord ID, the bot will remove any assigned whitelisted-roles and assign any set banned-roles. The bot will also remove any other Minecraft usernames that were whitelisted through the same Discord ID.

  • Whitelisted Roles Auto Remove
    • Automatically removes any whitelisted-roles from a Discord user if a user in any of the add-remove-roles removes any of their registered Minecraft usernames through the bot. The bot also removes any whitelisted-roles if any of their linked Minecraft names are removed in-game when add-in-game-adds-and-removes-to-list is enabled.

  • Adds In-Game Add and Removes To Lists
    • When enabled, the bot listens for vanilla or easy whitelist add/remove commands. When someone is removed they are added to a store called in-game-removed-list.yml. This means users in Discord cannot re-add users that have been removed in-game (not through the bot). When a user is added in-game and is located in either removed lists (removed-list.yml & in-game-removed-list.yml) they will be removed from said lists automatically.

  • Assign Permissions with Ultra Permissions
    • Automatically assigns permissions set in server-root/plugins/DiscordWhitelister/on-whitelist-permissions.yml to the target Minecraft username on whitelist success. The bot also automatically removes any assigned permissions when removed from the whitelist either through the bot or in-game, and when banned.

  • Use On Whitelist Commands
    • Runs any amount of commands as either the console or the target Minecraft username when the player is successfully whitelisted. Any command you add to the list supports %PLAYER% which will be replaced with the target Minecraft username when the player is successfully whitelisted. NOTE: The 'PLAYER' type will only work if the target whitelisted player is in the server at the time of command dispatch. This should only be used in specific situations.

  • Utility Commands
    • !clearname [mcName]:
      • Clears a whitelisted name from a limited-add user, un-whitelists the target name alongside removing on-whitelist perms if enabled; and gives the user a whitelist token back.
    • !clearban [mcName]:
      • Clears the target name from either or both removed lists so a limited-add user can add the specified name in the future.
        These commands remove the need to edit the files manually if you run into an issue regarding mistaken whitelist adds etc.

  • Custom prefix support for utility commands.
  • Custom message support for utility commands.
  • Added an option to disable un-whitelisting on server/guild leave.
  • The bot will now check on start-up if any users have left whilst the bot was offline and un-whitelist their associated Minecraft names accordingly.

  • Automated instructional message:
    • Sends an instructional message (if enabled) after a successful whitelist, to help the next user whitelist correctly.
    • Message can be sent instantaneously or delayed with a timer.
    • Message can be edited within custom-messages.yml.

  • The whitelist remove command now also removes any occurrences of the specified name from the user list if there is any.
----------, Oct 29, 2020

Quite a bit has been added since 1.3.8, so if you experience any issues please report them here: https://github.com/JoeShimell/DiscordWhitelisterSpigot/issues or add me on Discord: Joe#5782

Please check the wiki for more information on these added features: https://github.com/JoeShimell/DiscordWhitelisterSpigot/wiki/Configuration

  • Better handling when not eligible to access the 'GUILD_MEMBERS' intent
  • Merging premium version back to the free version - Thank you to the people that supported me over at mc-market
  • General bug fixes

  • In-game ban events
    • When enabled, the bot will listen in-game for the /ban command. When the ban command is executed and the target Minecraft username is linked to a Discord ID, the bot will remove any assigned whitelisted-roles and assign any set banned-roles. The bot will also remove any other Minecraft usernames that were whitelisted through the same Discord ID.

  • Whitelisted Roles Auto Remove
    • Automatically removes any whitelisted-roles from a Discord user if a user in any of the add-remove-roles removes any of their registered Minecraft usernames through the bot. The bot also removes any whitelisted-roles if any of their linked Minecraft names are removed in-game when add-in-game-adds-and-removes-to-list is enabled.

  • Adds In-Game Add and Removes To Lists
    • When enabled, the bot listens for vanilla or easy whitelist add/remove commands. When someone is removed they are added to a store called in-game-removed-list.yml. This means users in Discord cannot re-add users that have been removed in-game (not through the bot). When a user is added in-game and is located in either removed lists (removed-list.yml & in-game-removed-list.yml) they will be removed from said lists automatically.

  • Assign Permissions with Ultra Permissions
    • Automatically assigns permissions set in server-root/plugins/DiscordWhitelister/on-whitelist-permissions.yml to the target Minecraft username on whitelist success. The bot also automatically removes any assigned permissions when removed from the whitelist either through the bot or in-game, and when banned.

  • Use On Whitelist Commands
    • Runs any amount of commands as either the console or the target Minecraft username when the player is successfully whitelisted. Any command you add to the list supports %PLAYER% which will be replaced with the target Minecraft username when the player is successfully whitelisted. NOTE: The 'PLAYER' type will only work if the target whitelisted player is in the server at the time of command dispatch. This should only be used in specific situations.

  • Utility Commands
    • !clearname [mcName]:
      • Clears a whitelisted name from a limited-add user, un-whitelists the target name alongside removing on-whitelist perms if enabled; and gives the user a whitelist token back.
    • !clearban [mcName]:
      • Clears the target name from either or both removed lists so a limited-add user can add the specified name in the future.
    • These commands remove the need to edit the files manually if you run into an issue regarding mistaken whitelist adds etc.

  • Custom prefix support for utility commands.
  • Custom message support for utility commands.
  • Added an option to disable un-whitelisting on server/guild leave.
  • The bot will now check on start-up if any users have left whilst the bot was offline and un-whitelist their associated Minecraft names accordingly.

  • Automated instructional message:
    • Sends an instructional message (if enabled) after a successful whitelist, to help the next user whitelist correctly.
    • Message can be sent instantaneously or delayed with a timer.
    • Message can be edited within custom-messages.yml.

  • The whitelist remove command now also removes any occurrences of the specified name from the user list if there is any.
----------, Oct 29, 2020

  • Fixed an issue where the bot would hang if it did not have access to the 'GUILD_MEMBERS' intent on start-up and now gives information to users on where to enable it.
----------, Oct 27, 2020

  • Relocated dependencies to avoid potential conflicts with other plugins.
Note: you do not need to update unless you are experiencing dependency conflicts.
----------, Aug 17, 2020

  • Fixed a bug where the bot would only assign roles on the first discord server and not the multiple discord servers it was listening in.
  • Custom command prefix support (file is located at plugins/DiscordWhitelister/custom-prefixes.yml when generated and enabled in the main config).
  • Added the ability to hide the image of player's skins when whitelisting.
  • Now shows the players' skin armour on whitelist (should now show hair etc. which was missing before).
----------, Jul 8, 2020

  • You can now use ids for Discord roles, this helps when trying to add a role with special characters or emojis
    • To use this, set 'use-id-for-roles' to true and replace your current role names with their corresponding ids
  • Added a reload command to reload the config files and re-initialize the bot without having to restart the server
    • To use this command, enter 'dwreload' or 'discordwhitelisterreload' in game or in the console
----------, Jun 5, 2020

  • Added custom message support (located at (server-root)/plugins/DiscordWhitelister/custom-messages.yml).
  • Fixed a bug where the bot did not check if the user was already on the whitelist, when not using Easy Whitelist.
----------, May 1, 2020

  • Fixed a bug with counting players when vanished and normal players join/leave.
----------, Apr 30, 2020

  • Added server player count to the Discord bots status.
    • Can be toggled on and off in the config (enabled by default).
    • When a player joins/quits with at least one of 'discordsrv.silentjoin', 'discordsrv.silentquit', or 'sv.joinvanished' permissions, the player count will not be modified.

  • Added an option to add/remove a role to users after whitelisting.
    • This feature is meant to be used when users have the ability to whitelist themselves (limited-add-roles).
    • If whitelisted-role-auto-add is set to true (false by default), the Discord role with the name defined by whitelisted-role ("Whitelisted" by default) will be added when the user successfully adds to the whitelist.
    • If whitelisted-role-auto-remove is set to true (false by default), that role will be removed when the user successfully removes from the whitelist.

  • !whitelist add/remove commands are now required to be at start of message.
    • Made the name be the text up to the first space following the command (everything else is ignored).
      This allows writing something like "@user please do !whitelist add " without triggering the bot (fixes #3).

  • Fixed an error that occurred when users leave the guild which did not use the plugin to add to the whitelist.
  • Fixed an error when attempting to assign player count regardless of if the bot was initialized successfully.
Please read the README for updated information on configuring the bot.
Credit goes to @vacer25 & @timroejr for creating this update.
----------, Apr 25, 2020

  • Users are now automatically removed from the whitelist on guild (server) leave.
  • 2 new commands:
    • /dw - shows the current plugin version and Discord connection status
    • /dwabout - general plugin information and link to the github
Version 1.2.0 and greater are not compatible with version 1.1.x and lower. The layout of the internal user-list.yml got updated. You need to remove it manually and let the plugin on v1.2.x create a new one. If you upgrade without knowing what you are doing. Registration will not work correctly.

Credit goes to @zaanposni for creating this update.
----------, Apr 14, 2020

  • now with fancier looking bot messages[​IMG]
  • added a work around to validate minecraft usernames with easy whitelist enabled
if you encounter any issues please report them here: https://github.com/JoeShimo/DiscordWhitelisterBot-Spigot/issues
----------, Nov 6, 2019

note: there is no need to update if you do not use easy whitelist
----------, Nov 6, 2019

  • added basic minecraft username validation
  • now actually errors out if the discord client fails to initialize
  • updates / adds missing entries to the config without user input
  • added Log4j 2 dependency to remove JDA start up warnings
note: there is no need to edit your config file when updating, the bot will automatically add missing entries.
----------, Nov 4, 2019

  • Added Remove List
    This removes the ability for limited whitelist roles to add back users that have been removed by staff members.
  • Minor bug fixes
NOTE: if you're updating, please backup and remove your old config file as the new config is different. The bot will not work with the old one.

if you have any issues with this update (or previous versions) please report it here: https://github.com/JoeShimo/DiscordWhitelisterBot-Spigot/issues
----------, Oct 31, 2019

Replaced the single 'allowed to use' role with 2 roles:
  • Allowed to add & remove
  • Allowed to add
NOTE: if you're updating, please backup and remove your old config file as the new config is different. The bot will not work with the old one.
----------, Oct 29, 2019

  • use '!whitelist add ' in a valid channel to whitelist people on your minecraft server
  • use '!whitelist remove ' in a valid channel to remove people from the whitelist on your minecraft server
  • use '!whitelist' in a valid channel to get info about the bot and how to use it
----------, Aug 25, 2019

includes all case insensitive changes,
minor optimization,
if a user with a valid role types !whitelist without a name after, the bot will now respond with a help message
----------, Aug 25, 2019

Resource Information
Author:
----------
Total Downloads: 14,715
First Release: Aug 1, 2019
Last Update: Jan 22, 2024
Category: ---------------
All-Time Rating:
34 ratings
Find more info at github.com...
Version -----
Released: --------------------
Downloads: ------
Version Rating:
----------------------
-- ratings