HolyWhitelistPerm 用户指南
本指南面向希望在 Paper 或 Folia 服务器上安装并使用 HolyWhitelistPerm 的服务器所有者、管理员和版主。
插件功能
HolyWhitelistPerm 的功能类似于基于权限的白名单。
玩家只有在满足以下任一条件时才能加入服务器:
- 他们拥有配置的加入权限
- 他们是 OP(管理员),且配置中启用了
allow-ops
这使得你能够通过权限系统而非原版白名单来控制服务器访问。
该插件也支持 Folia。
安装步骤
- 将插件 JAR 文件放入服务器的
plugins/ 文件夹中。
- 启动服务器一次。
- 打开
plugins/HolyWhitelistPerm/config.yml。
- 根据需要调整权限名称或消息内容。
- 重启服务器或使用重载命令。
Folia 服务器的设置方式相同。
默认加入权限
默认情况下,插件检查的是:
holywhitelist.join
只有拥有此权限的玩家才能加入。
推荐设置
如果你使用 LuckPerms 等权限插件,可以创建一个允许加入的组并在此组中授予该权限。
LuckPerms 示例:
/lp group default permission set holywhitelist.join false
/lp group member permission set holywhitelist.join true
如果你希望使用不同的权限节点,也可以在 config.yml 中更改权限名称。
配置概览
示例配置:
settings:
required-permission: "holywhitelist.join"
allow-ops: true
format:
prefix: "<gradient:#148217:#6F32A8><bold>HolyWhitelist</bold></gradient><dark_gray>»</dark_gray><white> "
messages:
kick-no-permission: "<gray>You do not have permission to join this server!"
reload-success: "<green>Configuration reloaded successfully."
reload-no-permission: "<red>You do not have permission to use this command."
reload-usage: "<yellow>Usage: /holywhitelistperm reload"
settings.required-permission
玩家需要拥有的加入权限节点。
settings.allow-ops
如果设置为 true,即使没有该权限,服务器操作员(OP)也可以随时加入。
format.prefix
此前缀会添加在面向玩家的消息之前。
messages.*
所有面向玩家和控制台可见的消息均可在此处修改。
MiniMessage 支持
玩家消息支持 MiniMessage 格式。
示例:
messages:
kick-no-permission: "<red><bold>Access denied!</bold></red> <gray>You need <permission>."
支持的占位符:
命令
重载配置
/holywhitelistperm reload
别名:
/holywhitelist reload
/hwp reload
所需权限:
holywhitelist.reload
这将无需重启服务器即可重载 config.yml。
权限
加入权限
holywhitelist.join
授予服务器访问权限。
重载权限
holywhitelist.reload
允许使用重载命令。
常见用例
私人服务器访问
仅向你的内部成员组授予 holywhitelist.join。
仅限员工使用的开发服务器
仅向员工成员授予该权限,并保持 allow-ops 启用状态。
临时关闭的服务器
在维护完成之前,从普通组中移除加入权限。
故障排除
玩家无法加入,尽管他们应该可以
请检查以下内容:
- 玩家确实拥有配置的权限
config.yml 中的权限名称与你的权限设置匹配
- 如果你依赖
allow-ops: true,请确保玩家是 OP
- 更改后是否重启了服务器或重载了配置
重载命令不起作用
请检查以下内容:
- 你是否使用了
/holywhitelistperm reload
- 你是否拥有
holywhitelist.reload 权限
config.yml 中是否存在语法错误
消息显示不正确
如果你使用 MiniMessage 格式,请确保所有标签有效且正确闭合。
总结
HolyWhitelistPerm 旨在保持简单:
- 一个权限控制访问
- OP 支持为可选
- 所有消息均可配置
- 配置更改可通过重载命令应用
HolyWhitelistPerm User Guide
This guide is intended for server owners, admins, and moderators who want to install and use HolyWhitelistPerm on a Paper or Folia server.
What the Plugin Does
HolyWhitelistPerm works like a permission-based whitelist.
Players can only join your server when at least one of the following is true:
- they have the configured join permission
- they are OP and
allow-ops is enabled in the config
This lets you control server access with your permission system instead of the vanilla whitelist.
The plugin also supports Folia.
Installation
- Put the plugin JAR into your server's
plugins/ folder.
- Start the server once.
- Open
plugins/HolyWhitelistPerm/config.yml.
- Adjust the permission name or messages if needed.
- Restart the server or use the reload command.
The same setup works on Folia servers.
Default Join Permission
By default, the plugin checks for:
holywhitelist.join
Only players with this permission can join.
Recommended Setup
If you use a permission plugin such as LuckPerms, create one group that is allowed to join and grant the permission there.
Example with LuckPerms:
/lp group default permission set holywhitelist.join false
/lp group member permission set holywhitelist.join true
You can also change the permission name in config.yml if you want to use a different node.
Configuration Overview
Example configuration:
settings:
required-permission: "holywhitelist.join"
allow-ops: true
format:
prefix: "<gradient:#148217:#6F32A8><bold>HolyWhitelist</bold></gradient><dark_gray>»</dark_gray><white> "
messages:
kick-no-permission: "<gray>You do not have permission to join this server!"
reload-success: "<green>Configuration reloaded successfully."
reload-no-permission: "<red>You do not have permission to use this command."
reload-usage: "<yellow>Usage: /holywhitelistperm reload"
settings.required-permission
The permission node a player needs to join.
settings.allow-ops
If set to true, server operators can always join even without the permission.
format.prefix
This prefix is added in front of player-facing messages.
messages.*
All player-visible and console messages can be changed here.
MiniMessage Support
Player messages support MiniMessage formatting.
Example:
messages:
kick-no-permission: "<red><bold>Access denied!</bold></red> <gray>You need <permission>."
Supported placeholders:
Commands
Reload the Config
/holywhitelistperm reload
Aliases:
/holywhitelist reload
/hwp reload
Required permission:
holywhitelist.reload
This reloads config.yml without restarting the server.
Permissions
Join Permission
holywhitelist.join
Grants access to the server.
Reload Permission
holywhitelist.reload
Allows use of the reload command.
Common Use Cases
Private Server Access
Grant holywhitelist.join only to your internal member group.
Staff-Only Development Server
Grant the permission only to staff members and leave allow-ops enabled.
Temporary Closed Server
Remove the join permission from normal groups until maintenance is finished.
Troubleshooting
Players cannot join even though they should
Check the following:
- the player really has the configured permission
- the permission name in
config.yml matches your permission setup
- the player is OP if you rely on
allow-ops: true
- the server was restarted or the config was reloaded after changes
The reload command does not work
Check the following:
- you used
/holywhitelistperm reload
- you have the
holywhitelist.reload permission
- there are no syntax errors in
config.yml
Messages look wrong
If you use MiniMessage formatting, make sure all tags are valid and properly closed.
Summary
HolyWhitelistPerm is meant to be simple:
- one permission controls access
- OP support is optional
- all messages are configurable
- config changes can be applied with a reload command
评论 0
登录后参与评分
还没有评论,来抢沙发吧