Discord Whitelister - 游戏白名单插件

💡Discord Whitelister Bot for Spigot

这是一个简单的 Spigot 插件，允许玩家通过 Discord 文字频道进行白名单申请。这为用户提供了一种便捷的方式，无需登录 Minecraft 服务器即可完成白名单操作。

如果您使用的是 1.3.7 或更低版本，并且插件导致服务器启动时卡住，请在 Discord 开发者门户启用 SERVER MEMBERS INTENT，并更新到 1.3.8 或更高版本。

🎮功能特性

角色权限组

插件提供三个独立的角色权限组，用于管理白名单操作权限：

• add-remove 组：允许用户无限次添加和移除白名单成员（推荐给服主和管理员使用）。
• add 组：允许用户无限次添加白名单成员（推荐给管理员使用）。
• limited-add 组：允许用户添加有限次数的白名单成员（推荐给普通用户使用，默认次数为 3 次）。此功能可在配置文件中禁用（默认启用）。

移除名单

此功能会限制 limited-add 组用户重新添加已被 add-remove 组管理员移除的玩家。例如，一个白名单用户无法添加被管理员移除的玩家。此功能可在配置文件中禁用（默认启用）。

自定义消息

支持编辑服务器响应消息。配置文件位于 (server-root)/plugins/DiscordWhitelister/custom-messages.yml。

• 此功能默认禁用，可在配置文件中启用 (use-custom-messages)。
• 注意：只有原始消息中的变量（例如 {Sender}）会被解析。在原本不包含该变量的消息字符串中使用新变量（例如 {MaxWhitelistAmount}）将不会生效。

使用 Discord 角色 ID

允许使用 Discord 角色的 ID 而非角色名称来配置权限组（例如：使用 445666895333687347 而不是 Admin）。

• 要启用此功能，请在配置中将 use-id-for-roles 设置为 true。
• 配置示例如下：

add-remove-roles:
  - 446223693887176704
add-roles:
  - 485463455940214794
limited-add-roles:
  - 639221397981233162
use-id-for-roles: true

自动管理 Discord 角色

此功能适用于允许用户自行添加白名单的场景。

• 如果将 whitelisted-role-auto-add 设置为 true（默认为 false），当用户成功将自己添加到白名单时，Discord 中名为 whitelisted-role（默认为 "Whitelisted"）的角色将自动赋予该用户。
• 如果将 whitelisted-role-auto-remove 设置为 true（默认为 false），当用户成功将自己从白名单移除时，该角色也将被移除。
• 启用此功能需要：
• 机器人在 Discord 中拥有“管理角色”权限。
• 在 Discord 中创建一个与配置中名称（区分大小写）完全相同的角色。
• 确保机器人的角色权限高于白名单角色。

其他特性

• 仅限指定的 Discord 角色可以通过机器人操作白名单。
• 机器人仅监听指定文字频道中的消息。
• 在控制台记录来自有效角色的白名单操作尝试。

🔧Discord 命令

自 1.4.9 版本起，命令前缀 ! 已被 / 取代，以利用 Discord 的斜杠命令功能。

• 使用 /whitelist add "minecraftUsername" 在有效频道中将玩家添加到您的 Minecraft 服务器白名单。
• 使用 /whitelist remove "minecraftUsername" 在有效频道中将玩家从服务器白名单中移除。
• 使用 /whitelist 在有效频道中获取机器人信息和使用说明。

✨重载命令

使用 dwreload 或 discordwhitelisterreload 命令可以重新加载配置文件并重新初始化机器人，无需重启 Minecraft 服务器。

❓设置指南

配置文件位于：(server-root)/plugins/DiscordWhitelister/discord-whitelister.yml。您需要提供有效的机器人令牌和频道 ID 才能使其工作。

• 要创建 Discord 应用和/或找到您的机器人令牌，请访问：https://discordapp.com/developers/applications/。
• 重要：请务必启用 SERVER MEMBERS 和 MESSAGE_CONTENT 意图，否则机器人将无法工作！这些选项位于：https://discord.com/developers/applications。点击您用于运行此机器人的应用程序，然后点击左侧的“Bot”按钮，即可找到所需选项。
• 有关如何配置机器人的最新信息，请查看 Wiki。

⭐向后兼容性说明

（仅适用于低于 v1.2.0 的版本）

• 1.2.0 及更高版本与 1.1.x 及更低版本不兼容。这是由于 user-list.yml 的布局发生了变化。
• 您需要手动删除旧的 user-list.yml 文件，并让插件生成一个新的。如果在升级时未执行此操作，注册功能将无法正常工作。

🔧需要帮助？

如果您在设置机器人时遇到困难，欢迎在讨论区留言求助。