Discord Role Sync

插件

· 作者 NichoGX

一个用于将 Discord 角色同步到 Minecraft 权限组和白名单的插件

0 本站下载 0 关注 更新于 2 周前

最新 2.4.0 · 26.3 · Bukkit / Paper

一键开服(送7天)

Discord 角色同步

DiscordRoleSync 是一个 Minecraft 插件,用于同步 Discord 角色和 Minecraft 权限。此同步仅从 Discord 到 Minecraft,不支持双向同步。

可以配置并链接受管理的 Discord 角色列表到 Minecraft 用户组。如果 Discord 用户获得了某个角色,他们将被添加到对应的 Minecraft 用户组中;如果该用户失去了这个角色,他们将从 Minecraft 用户组中被移除。

本插件支持使用 SQLite(自动创建,无需设置)或 MySQL。建议在大型服务器上使用 MySQL 以保证稳定性。

本插件已在 Minecraft 1.8.8 至 26.3 版本上经过测试。

功能

部分功能是可选的,可以在配置文件中选择开启或关闭。

  • 将 Discord 角色同步到 Minecraft 用户组。用户将根据其在 Discord 中的角色被添加或移除出 Minecraft 用户组
  • 为已绑定的用户添加 Discord 角色
  • 使用 Discord 角色控制谁能访问你的服务器(白名单)
  • 根据用户的 Minecraft 用户名更新其 Discord 昵称
  • 与 PlaceholderAPI 集成

安装

首先你需要安装 Vault,因为没有它本插件将无法工作。你还应该安装一个权限插件,例如 LuckPerms 或其他兼容 Vault 的替代方案。

本插件需要 Java 17 或更高版本。

只需将 .jar 文件复制到 plugins 文件夹并运行一次服务器以生成配置文件。由于没有配置文件,插件在首次运行时会出现错误,这是预期的现象。进入 config.yml 文件并添加你的 Discord 机器人令牌 (token)。获取方法如下:

  1. 前往
  2. 点击“new application”并为你的机器人起个名字
  3. 在左侧边栏中,点击“Bot”
  4. 点击“add bot”并确认
  5. 在此页面上,你可以更改机器人的头像和用户名。
  6. 开启“Server Members Intent”(服务器成员意图)——如果不启用此项,机器人将无法正常工作,因为它需要处理成员列表
  7. 点击复制令牌并将其粘贴到配置文件中。任何拥有你令牌的人都可以登录为你的机器人,因此请像保管密码一样保密它。
  8. 返回 Discord 开发者网站,在左侧边栏中点击“OAuth2”
  9. 选择“bot”作为范围,然后复制链接
  10. 前往你刚刚复制的链接,将机器人添加到你的服务器

别忘了将所有角色放入配置中。你应该填入角色 ID,而不是角色名称。要获取 ID,你需要在 Discord 中启用开发者模式,然后右键点击角色并复制 ID(这是一串大约 18 位数字)。服务器 ID 和频道 ID 也是如此。

工作原理

非常简单:所有用户都应在 Discord 中使用 /link 命令来绑定他们的 Minecraft 账号:

/link myMCusername

一旦他们执行此操作,只要他们在服务器上,他们的角色就会保持同步。当你的用户获得 Discord 角色时,他们将自动获得权限插件的用户组。更新是实时的。

管理员还可以使用 /admlink 命令强制绑定用户:

/admlink discordID mcUsername

用户的 Discord ID 是一串 17 到 20 位的数字。

/info 和 /unlink 命令可供管理员使用。两者均接受 Discord ID 或 Minecraft 用户名。默认情况下,这三个管理命令对拥有 MANAGE ROLES(管理角色)Discord 权限的所有人开放。这可以在你的 Discord 服务器中进行修改。 用户必须留在 Discord 服务器中才能保持其角色。如果他们离开服务器或通过 /unlink 命令解除绑定,他们将被移出白名单,并且所有角色都会被移除。

如果启用了白名单管理(配置中 manageWhitelist: true),请使用 /whitelist off 或在 server.properties 中设置 white-list=false 来关闭原版白名单。否则,即使插件允许玩家进入,原版白名单仍会将他们踢出。自 Minecraft 26.3 起,新服务器的原版白名单默认处于开启状态。

如果启用了验证功能(配置中 requireVerification: true),用户在被白名单踢出时(如果启用了白名单管理)或在 Minecraft 聊天中输入 /drs verify 时会获得验证码。然后通过 Discord 中的 /verify <code> 发送此代码。

语言和翻译

目前支持(并随插件捆绑)的语言有:

  • 英语 (en_US)
  • 葡萄牙语 (pt_BR)
  • 意大利语 (it_IT)
  • 法语 (fr_FR)
  • 西班牙语 (es_ES)
  • 土耳其语 (tr_TR)
  • 德语 (de_DE)
  • 日语 (ja_JP)
  • 俄语 (ru_RU)

如果你想添加自己的语言,可以复制 en_US.yml 文件并根据你的语言进行编辑。如果你希望你的翻译被捆绑到插件中,请通过 Discord 联系我或在 GitLab 上发起合并请求,我很乐意将其包含在内 :D

随着本插件更新的发布,只有英语和葡萄牙语会进行更新(因为这是我使用的语言)。其他语言可能会过时,并将默认使用英语。如果你愿意帮助更新这些语言,请告诉我!

权限插件

本插件应与所有支持 Vault 的权限插件兼容。

已测试并确认可用:

关于 PermissionsEx 的说明:我不推荐使用 PermissionsEx,因为它已被弃用且不支持异步权限添加。在大型服务器上使用它可能会导致性能下降。

权限节点

  • discordrolesync.reload:使用 /drs reload 命令
  • discordrolesync.botrestart:使用 /drs botrestart 命令
  • discordrolesync.notifyupdates:拥有此权限的用户在登录时,如果有可用更新,将会收到通知。
  • discordrolesync.bypasswhitelist:当白名单启用时,拥有此权限的用户将始终被允许加入,即使他们尚未关联。请注意,对于大多数权限插件而言,要向用户添加权限,该用户必须首先尝试加入服务器。

所有用户均被允许使用 /drs verify 命令

集成

PlaceholderAPI

通过在配置文件中将 integrations.plugins.PlaceholderAPI 设置为 true,可以启用 PlaceholderAPI 集成。

这将允许机器人状态消息读取占位符变量。

它还为本插件启用了占位符扩展,支持以下占位符:

  • %drs_linked_users%:已关联用户的数量
  • %drs_link_status%:用户是否已关联
  • %drs_discord_username%:用户的 Discord 用户名(如果已关联)。如果未关联则为空。
  • %drs_discord_display_name%:用户的 Discord 昵称(如果已关联)。如果未关联则为空。

PlaceholderAPI 集成为新功能,可能仍需进一步完善。如果您有需求或遇到 bug,请告知我。

Geyser

通过在配置文件中将 experimental.geyser.enableGeyserSupport 设置为 true,可以启用 Geyser 集成。

启用后,关联以点号开头(如 .exampleuser)的用户名将被视为 Geyser 用户。

这是一个实验性功能。如果您有需求或遇到 bug,请告知我。

功能请求、Bug 报告与贡献

本插件为开源项目!源代码可在 GitLab 找到。请参阅 CONTRIBUTING.md 获取更多信息。

非常欢迎贡献!我最近重新接手了本插件的支持工作,并正在整理代码。我不是 Java 专家,因此如果您愿意,可以自由进行代码清理和主观性改进方面的贡献。

如有需要,您可以通过 GitLab 或 Discord 联系我。如需报告 bug 或请求功能,您可以在 GitLab 上创建 Issue,或通过 Discord 联系我。

已知问题与限制

离线服务器模式

请注意,在离线模式服务器中,用户名的关联是区分大小写的。

虽然本插件可与离线服务器配合使用,但它可能会与您使用的“登录插件”发生冲突,这些插件会在用户加入后更改其 UUID。如果您使用了登录插件,请尝试使用 userUUIDMode 的 FALLBACK 或 MANUAL 选项。

如果您通过 UUID 模式配置或服务器模式切换在离线和在线模式之间来回切换,则需要删除数据库。如果您使用的是 SQLite,只需删除 database.db 文件即可。如果您使用的是 MySQL,请执行 DROP TABLE syncbot_discordmcusers;,如果在 config.yml 文件中更改了前缀,请将 syncbot 替换为您的自定义前缀。

你是这个资源的作者?登录后可认领此资源。

评论 0

0.0
暂无评分
5 星
0
4 星
0
3 星
0
2 星
0
1 星
0
我的评分

登录后参与评分

还没有评论,来抢沙发吧

评论配图

相似资源