# HolyWhitelistPerm User Guide<\/p>\n
This guide is intended for server owners, admins, and moderators who want to install and use `HolyWhitelistPerm` on a Paper or Folia server.<\/p>\n
## What the Plugin Does<\/p>\n
`HolyWhitelistPerm` works like a permission-based whitelist.<\/p>\n
Players can only join your server when at least one of the following is true:<\/p>\n
– they have the configured join permission
\n– they are OP and `allow-ops` is enabled in the config<\/p>\n
This lets you control server access with your permission system instead of the vanilla whitelist.<\/p>\n
The plugin also supports Folia.<\/p>\n
## Installation<\/p>\n
1. Put the plugin JAR into your server’s `plugins\/` folder.
\n2. Start the server once.
\n3. Open `plugins\/HolyWhitelistPerm\/config.yml`.
\n4. Adjust the permission name or messages if needed.
\n5. Restart the server or use the reload command.<\/p>\n
The same setup works on Folia servers.<\/p>\n
## Default Join Permission<\/p>\n
By default, the plugin checks for:<\/p>\n
“`text
\nholywhitelist.join
\n“`<\/p>\n
Only players with this permission can join.<\/p>\n
## Recommended Setup<\/p>\n
If you use a permission plugin such as LuckPerms, create one group that is allowed to join and grant the permission there.<\/p>\n
Example with LuckPerms:<\/p>\n
“`bash
\n\/lp group default permission set holywhitelist.join false
\n\/lp group member permission set holywhitelist.join true
\n“`<\/p>\n
You can also change the permission name in `config.yml` if you want to use a different node.<\/p>\n
## Configuration Overview<\/p>\n
Example configuration:<\/p>\n
“`yaml
\nsettings:
\n required-permission: “holywhitelist.join”
\n allow-ops: true<\/p>\n
format: messages: ### `settings.required-permission` ### `settings.allow-ops` ### `format.prefix` ### `messages.*` ## MiniMessage Support<\/p>\n Player messages support MiniMessage formatting.<\/p>\n Example:<\/p>\n “`yaml Supported placeholders:<\/p>\n – ` ## Commands<\/p>\n ### Reload the Config<\/p>\n “`text Aliases:<\/p>\n “`text Required permission:<\/p>\n “`text This reloads `config.yml` without restarting the server.<\/p>\n ## Permissions<\/p>\n ### Join Permission<\/p>\n “`text Grants access to the server.<\/p>\n ### Reload Permission<\/p>\n “`text Allows use of the reload command.<\/p>\n ## Common Use Cases<\/p>\n ### Private Server Access ### Staff-Only Development Server ### Temporary Closed Server ## Troubleshooting<\/p>\n ### Players cannot join even though they should<\/p>\n Check the following:<\/p>\n – the player really has the configured permission ### The reload command does not work<\/p>\n Check the following:<\/p>\n – you used `\/holywhitelistperm reload` ### Messages look wrong<\/p>\n If you use MiniMessage formatting, make sure all tags are valid and properly closed.<\/p>\n ## Summary<\/p>\n `HolyWhitelistPerm` is meant to be simple:<\/p>\n – one permission controls access A Minecraft Plugin to Whitelist players with a permission<\/p>\n","protected":false},"featured_media":81641,"template":"","meta":{"_minecraft_slug":"holywhitelistperm","_minecraft_project_id":"hd7SyYxo","_minecraft_author":"AveGamers","_minecraft_license":"MIT","_minecraft_downloads":4,"_minecraft_follows":0,"_minecraft_client_side":"unsupported","_minecraft_server_side":"required","_minecraft_storage_type":"zip","_minecraft_archive_name":"holywhitelistperm.zip","_minecraft_size_bytes":8126,"_minecraft_version_count":1,"_minecraft_updated_at":"2026-05-16T12:25:39.765950Z","_minecraft_date_created":"2026-04-28T22:30:17.603586Z","_minecraft_date_modified":"2026-04-17T09:45:13.175566Z","_minecraft_project_url":"https:\/\/modrinth.com\/mod\/holywhitelistperm","_minecraft_icon_attachment_id":81641,"_minecraft_imported_at":"2026-06-04T16:38:48+00:00","_minecraft_import_hash":"b71c1ff88cf3cbb61b05055223837e39","_minecraft_versions":"","_minecraft_links":"","_minecraft_gallery":"","_minecraft_api_metadata":""},"mod_category":[124,125,126,127,128,129,92],"mod_loader":[130,131,132,133,134],"minecraft_version":[62,37,40,41,73,74,38,78,79,80,81,82],"class_list":["post-81640","mod","type-mod","status-publish","has-post-thumbnail","hentry","mod_category-bukkit","mod_category-folia","mod_category-management","mod_category-paper","mod_category-purpur","mod_category-spigot","mod_category-utility","mod_loader-bukkit","mod_loader-folia","mod_loader-paper","mod_loader-purpur","mod_loader-spigot","minecraft_version-1-21","minecraft_version-1-21-1","minecraft_version-1-21-10","minecraft_version-1-21-11","minecraft_version-1-21-2","minecraft_version-1-21-3","minecraft_version-1-21-4","minecraft_version-1-21-5","minecraft_version-1-21-6","minecraft_version-1-21-7","minecraft_version-1-21-8","minecraft_version-1-21-9"],"yoast_head":"\n
\n prefix: “
\n kick-no-permission: “
\n reload-success: “
\n reload-no-permission: “
\n reload-usage: “
\n“`<\/p>\n
\nThe permission node a player needs to join.<\/p>\n
\nIf set to `true`, server operators can always join even without the permission.<\/p>\n
\nThis prefix is added in front of player-facing messages.<\/p>\n
\nAll player-visible and console messages can be changed here.<\/p>\n
\nmessages:
\n kick-no-permission: “
\n“`<\/p>\n
\n– `
\n\/holywhitelistperm reload
\n“`<\/p>\n
\n\/holywhitelist reload
\n\/hwp reload
\n“`<\/p>\n
\nholywhitelist.reload
\n“`<\/p>\n
\nholywhitelist.join
\n“`<\/p>\n
\nholywhitelist.reload
\n“`<\/p>\n
\nGrant `holywhitelist.join` only to your internal member group.<\/p>\n
\nGrant the permission only to staff members and leave `allow-ops` enabled.<\/p>\n
\nRemove the join permission from normal groups until maintenance is finished.<\/p>\n
\n– the permission name in `config.yml` matches your permission setup
\n– the player is OP if you rely on `allow-ops: true`
\n– the server was restarted or the config was reloaded after changes<\/p>\n
\n– you have the `holywhitelist.reload` permission
\n– there are no syntax errors in `config.yml`<\/p>\n
\n– OP support is optional
\n– all messages are configurable
\n– config changes can be applied with a reload command<\/p>\n","protected":false},"excerpt":{"rendered":"