BanAnnouncer [Discord] - BanAnnouncer - 封禁公告插件

简介

BanAnnouncer 是一款能将 Minecraft 服务器内的处罚信息同步到 Discord 频道的插件。它通过及时公布处罚信息，帮助您提升社区管理的透明度与公正性，让所有成员都能了解违规行为及其相应后果。

💡前置需求

• Spicord - 用于连接 Discord 的插件。
• 任意兼容的处罚管理插件 - 例如：
• AdvancedBan
• LiteBans
• LibertyBans

🎮支持的处罚类型

BanAnnouncer 支持同步以下类型的处罚与操作：

• 封禁类：ban, tempban, banip, tempbanip, unban, unbanip
• 禁言类：mute, tempmute, unmute
• 警告类：warn, tempwarn, unwarn
• 其他：kick, note (AdvancedBan), unnote (AdvancedBan), jail (Essentials/BetterJails), unjail (Essentials/BetterJails)

🔧安装与配置

第一步：安装 Spicord

首先，请确保已正确安装并配置好 Spicord 插件。

第二步：添加 BanAnnouncer 到 Spicord

打开 Spicord 的配置文件，找到 addons 部分，将 "ban_announcer" 添加到列表中。示例如下：

addons:
  - "ban_announcer"
  # ... 其他插件

注意：每个插件 ID 需用引号包裹，且除最后一个外，末尾都需要有逗号。

第三步：创建 Discord 频道

在您的 Discord 服务器中创建一个用于接收处罚公告的频道（例如命名为 #punishments）。

第四步：获取并配置频道 ID

• 在 Discord 用户设置中启用“开发者模式”。
• 右键点击您创建的公告频道，选择“复制 ID”。
• 打开 BanAnnouncer 的配置文件 (config.yml)，将复制的频道 ID 填入 channel-to-announce 项。

第五步：确保处罚插件已安装

请确保您的服务器已安装并运行着至少一个兼容的处罚管理插件（如 AdvancedBan）。BanAnnouncer 会自动检测，无需额外配置。

第六步：重启服务器

完成以上步骤后，重启您的 Minecraft 服务器，插件即可开始工作。

✨配置文件详解

以下是 BanAnnouncer 默认配置文件 (config.yml) 的核心部分说明：

# 用于发送公告的 Discord 频道 ID
channel-to-announce: 123456789012345678

# 各处罚类型对应的消息格式
# 若将值设为空字符串 ""，则禁用该类型的公告
messages:
  kick: "{embed:kick}"
  ban: "{embed:ban}"
  tempban: "{embed:tempban}"
  # ... 其他处罚类型格式类似

# 使用的处罚管理插件，通常设为 "auto" 自动检测即可
punishment-manager: auto

# 是否忽略 LiteBans 的静默处罚标记 (-s)
# 设为 false 时，即使静默处罚也会发送公告
ignore-silent: false

# 配置文件版本，请勿修改
config-version: 4

关于消息格式

• 默认使用嵌入消息 ({embed:type})，视觉效果更佳。
• 您也可以使用纯文本，例如：kick: "玩家 %player% 被 %staff% 踢出了服务器。"
• 将对应处罚类型的值设为 "" 即可完全禁用该公告。

❓提示与技巧

• 频道权限：建议为您创建的公告频道设置权限，禁止普通成员发送消息，以保持频道整洁。
• 自定义消息：您可以自由编辑配置文件中的消息内容。如需设计更美观的嵌入消息，推荐使用 Leovoel 的 Embed Visualizer 工具进行可视化编辑。
• 问题反馈：如遇问题，请在 BanAnnouncer 的 GitHub Issues 页面 提交报告，或通过其 Discord 频道联系开发者。