Welcome to the Hangar Open Beta. Please report any issue you encounter on GitHub!
Avatar for Strokkur424

Set a global password for your server!

Report PasswordWhitelist?

📄 PasswordWhitelist

A plugin to make users enter a password on server join.

Description

This plugin adds a new twist to whitelisting! Instead of manually adding players to your whitelist, you can set a server-wide password, which all connecting users will have to enter on server join. The plugin utilizes the new dialog system introduced with the 1.21.6 Minecraft update and a new configuration API introduced by Paper in 1.21.7 to make the process very clean and smooth.

Features

  • Extensive customizability
  • MiniMessage Format
  • New dialog system introduced in 1.21.6
  • Async configuration-phase password input

Folia compatibility

Folia compatibility is a goal, which at the time of writing might not be reached yet, as no public builds of Folia 1.21.7 have been released so far.

Paper compatibility

This plugin should work on all Paper servers on version 1.21.7 (build #17) and higher.

Permissions

⚠️ It is suggested that you install LuckPerms for managing permissions.

Below is a table of all permissions, their default values, and their descriptions:

Permission Default Description
passwordwhitelist.exclude false Excludes a user from having to enter the password
passwordwhitelist.command.use op Main permission required to run the /passwordwhitelist command
passwordwhitelist.command.help true Permission required to run the '/passwordwhitelist help' subcommand
passwordwhitelist.command.reload true Permission required to run the '/passwordwhitelist reload' subcommand
passwordwhitelist.command.enable true Permission required to run the '/passwordwhitelist enable' subcommand
passwordwhitelist.command.disable true Permission required to run the '/passwordwhitelist disable' subcommand
passwordwhitelist.command.attempts true Permission required to run the '/passwordwhitelist attempts' subcommand
passwordwhitelist.command.password true Permission required to run the '/passwordwhitelist password' subcommand
passwordwhitelist.command.password.set op Permission required to run the '/passwordwhitelist password set' subcommand
passwordwhitelist.command.password.show op Permission required to run the '/passwordwhitelist password show' subcommand

If you are confused about the true values for some of the subcommands: The only reason they are set to true by default is to make quick permission setups easier. All players require to passwordwhitelist.command.use permission in order to use any command. The sub-permissions merely allow for fine-grained control for server owners.

Note regarding the exclude permission

Because of the exclude permission being checked during the configuration phase of a player's server connection, it is not possible to check the player's permission through Paper's API. Therefore, this feature requires that LuckPerms is installed on the server.

Command

  • Aliases: passwordwhitelist, /passw, and /pw.
Command Description
/passwordwhitelist help Show a help message
/passwordwhitelist reload [<file>] Reload a plugin data file
/passwordwhitelist enable Enable the password whitelist
/passwordwhitelist disable Disable the password whitelist
/passwordwhitelist password set <password> Set a new password
/passwordwhitelist password show Show the current password
/passwordwhitelist attempt reset <player> Reset a player's failed password attempt count

Information

CategoryAdmin Tools
Published onJuly 16, 2025
LicenseCC-BY-ND-4.0
Downloads0
Stars1
Watchers0

Pinned Versions

Members