文档

教程和指南

通过我们详细的指南逐步学习如何配置KellyMaster。

1
简单
5 分钟

基本安装

逐步学习如何在您的Minecraft服务器上安装KellyMaster。

  1. 1 从我们的官方Discord下载KellyMaster.jar文件。
  2. 2 在安装插件之前完全停止您的Minecraft服务器。
  3. 3 将KellyMaster.jar文件放入服务器的/plugins文件夹。
  4. 4 启动服务器。插件将自动生成config.yml、whitelist.yml和messages.yml文件。
  5. 5 再次停止服务器以编辑配置文件。
  6. 6 根据您的安全偏好配置config.yml。
  7. 7 在whitelist.yml中配置授权管理员及其验证方式。
  8. 8 再次启动服务器。KellyMaster将激活并保护您的服务器。
2
中等
10 分钟

配置config.yml

配置config.yml文件所有选项的完整指南。

  1. 1 用文本编辑器打开plugins/KellyMaster/config.yml文件。
  2. 2 在settings部分,配置语言(lang: en/es/ru/zh)用于外部通知。
  3. 3 配置verification-timeout(验证时间,建议:60-120秒)。
  4. 4 配置code-length(验证码长度,建议:6-8位)。
  5. 5 启用deop-on-disconnect: true以在玩家断开连接时自动移除OP。
  6. 6 在security部分,配置unauthorized-action(BAN/KICK/DEOP)用于未授权玩家。
  7. 7 在blocked-commands中添加要阻止的命令。
  8. 8 保存文件并重启服务器以应用更改。
3
中等
8 分钟

配置whitelist.yml

如何添加授权管理员并配置其验证方式。

  1. 1 用文本编辑器打开plugins/KellyMaster/whitelist.yml文件。
  2. 2 在setup-verification部分,定义每个管理员的验证方式。
  3. 3 在authorized-operators中,添加每个管理员及其标识符。
  4. 4 获取Discord ID:启用开发者模式 > 右键点击个人资料 > 复制ID。
  5. 5 获取Telegram Chat ID:在Telegram上与@userinfobot对话。
  6. 6 您可以让多个管理员使用不同的验证方式。
  7. 7 未在列表中的玩家将被视为未授权。
  8. 8 保存文件并重启服务器以应用更改。
4
高级
15 分钟

配置Discord机器人

设置Discord机器人以通过私信接收验证码。

  1. 1 前往Discord Developer Portal(discord.com/developers/applications)并登录。
  2. 2 点击"New Application"并命名(例如:KellyMaster Bot)。
  3. 3 进入侧边菜单的"Bot"部分并点击"Add Bot"。
  4. 4 点击"Reset Token"并复制生成的令牌。切勿分享此令牌。
  5. 5 在"Privileged Gateway Intents"部分启用"Message Content Intent"。
  6. 6 前往"OAuth2" > "URL Generator",选择"bot"和权限:"Send Messages"。
  7. 7 复制生成的URL并在浏览器中打开以邀请机器人。
  8. 8 在whitelist.yml中,将令牌粘贴到discord.bot-token。
  9. 9 在setup-verification中,添加管理员格式:玩家名:Discord。
  10. 10 在authorized-operators中添加:玩家名:您的_DISCORD_ID。
  11. 11 重启Minecraft服务器。机器人将连接并准备发送验证码。
5
高级
12 分钟

配置Telegram机器人

使用BotFather设置Telegram作为验证方式。

  1. 1 打开Telegram并搜索@BotFather。
  2. 2 发送/newbot命令创建新机器人。
  3. 3 按照说明操作:先输入友好名称,然后输入唯一用户名。
  4. 4 BotFather会给您一个HTTP API令牌。复制此令牌。
  5. 5 在whitelist.yml中,将令牌粘贴到telegram.bot-token。
  6. 6 在Telegram上搜索您的新机器人并发送/start。
  7. 7 获取Chat ID,与@userinfobot或@RawDataBot对话。
  8. 8 在setup-verification中,添加管理员格式:玩家名:Telegram。
  9. 9 在authorized-operators中添加:玩家名:您的_CHAT_ID。
  10. 10 重启Minecraft服务器。需要验证时将通过Telegram收到验证码。
6
高级
12 分钟

配置邮箱SMTP

使用Gmail或其他SMTP服务器通过邮件发送验证码。

  1. 1 前往您的Google账户设置:myaccount.google.com。
  2. 2 进入"安全性"并启用"两步验证"(如未启用)。
  3. 3 在"两步验证"中,向下滚动到"应用密码"。
  4. 4 创建新的应用密码:选择"其他"并命名为"KellyMaster"。
  5. 5 Google会生成一个16位密码。复制它(只显示一次)。
  6. 6 在config.yml中,配置email部分:enabled: true, smtp.host: smtp.gmail.com, smtp.port: 587。
  7. 7 在smtp.user中填入您的Gmail邮箱,smtp.password中填入应用密码。
  8. 8 在whitelist.yml的setup-verification中添加:玩家名:Gmail。
  9. 9 在authorized-operators中添加:玩家名:您的邮箱@gmail.com。
  10. 10 重启服务器。需要验证时将通过邮件收到验证码。
7
简单
5 分钟

配置Discord Webhook

使用webhooks在Discord频道中接收安全警报。

  1. 1 在Discord中,前往您要接收警报的服务器。
  2. 2 右键点击要接收通知的频道 > "编辑频道"。
  3. 3 进入"整合" > "Webhooks" > "新建Webhook"。
  4. 4 给webhook命名(例如:KellyMaster Alerts)并可选择更改头像。
  5. 5 点击"复制Webhook URL"。
  6. 6 在config.yml中,将URL粘贴到webhook.url并启用webhook.enabled: true。
  7. 7 配置您想要的通知类型。
  8. 8 重启服务器。安全警报将发送到Discord频道。
8
简单
5 分钟

LuckPerms集成

使用自动LuckPerms集成保护危险权限。

  1. 1 确保您的服务器已安装LuckPerms(可选依赖)。
  2. 2 KellyMaster会在启动时自动检测LuckPerms。
  3. 3 该集成监控危险权限的分配,如:*, essentials.*, luckperms.*。
  4. 4 如果未授权玩家获得这些权限,将被自动封禁并移除权限。
  5. 5 要查看检测到的事件,请检查服务器日志或配置Discord webhook。
  6. 6 无需额外配置,集成会自动工作。
示例

配置示例

config.yml

# 通用配置
settings:
  lang: zh
  debug: false
  verification-timeout: 60
  code-length: 8
  deop-on-disconnect: true
  max-verification-attempts: 3

# 安全配置
security:
  unauthorized-action: BAN
  allow-non-whitelist-op: false
  log-ip-addresses: true

# Discord Webhook
webhook:
  enabled: true
  url: "https://discord.com/api/webhooks/..."
  notify-blocked-commands: true
  include-geolocation: true

whitelist.yml

# Discord机器人配置
discord:
  enabled: true
  bot-token: "MTIzNDU2Nzg5..."

# 验证方式
setup-verification:
  - "SrCodex:Discord"
  - "Admin:Gmail"
  - "Moderador:Telegram"

# 授权管理员
authorized-operators:
  - "SrCodex:123456789012345678"
  - "Admin:admin@example.com"
  - "Moderador:987654321"
FAQ

常见问题

KellyMaster兼容从1.8到1.21.x的所有Minecraft版本。适用于Spigot、Paper、Purpur和其他基于Bukkit的分支。

它们不是必需的。ProtocolLib和LuckPerms是可选依赖,提供额外功能,但插件没有它们也能完美运行。

如果管理员未在时间限制内(默认60秒)输入正确的验证码,将被自动断开连接并失去OP权限,直到正确验证。

是的,每个管理员可以在whitelist.yml中配置自己的验证方式。您可以根据每个管理员的偏好混合使用Email、Discord和Telegram。

在Discord中启用开发者模式:设置 > 高级 > 开发者模式。然后右键点击您的个人资料或用户名,选择"复制ID"。ID是一个18位数字。

影响不大。KellyMaster经过优化,对性能影响最小。验证和通知是异步的,不会阻塞服务器主线程。

可以,KellyMaster可以在online-mode=false的服务器上运行。但是,我们建议使用额外的身份验证插件如AuthMe以获得更好的安全性。

没有限制。您可以在whitelist.yml中添加任意数量的授权管理员,每个都有自己的验证方式。

需要帮助?

加入我们的Discord服务器,获得社区和开发者的直接支持。

在Discord上获得支持
KellyMaster KellyMaster