# IDoTheBlacklist
## 概述
IDoTheBlacklist 是一个 Minecraft 服务器端的模组，通过与集中的黑名单 API 集成来增强服务器安全。 此模组会自动检查连接的玩家是否在已知问题用户列表中，从而阻止他们加入服务器。 它是 IDoTheBot 和 IDoTheAPI 管理的更广泛生态系统的一部分，后者用于管理和维护多个 Minecraft 社区和相关 Discord 服务器的社区完整性。
## 黑名单系统
黑名单是维护与 IDoTheBot 相关的 Minecraft 社区积极和安全环境的关键工具。 它运作方式如下：
* **集中的 API：** 黑名单数据存储和管理在集中的 API 端点上。 这确保了所有参与服务器都可以访问最新的信息。
* **IDoTheAPI 集成：** IDoTheAPI 用于管理此黑名单。 授权用户可以通过 Discord 服务器中的特定命令添加或删除黑名单条目。
* **Minecraft 模组集成：** IDoTheBlacklist 模组读取此黑名单数据并拒绝在列表中的任何玩家的访问。
### 透明度和协作管理
IDoTheBlacklist 系统背后的关键原则之一是透明度和协作管理。
* **开源代码：** 由于此代码是开源的，因此黑名单系统的运作对公众可见。 这允许社区进行审查和改进。
* **授权用户：** 一组特定的 Discord 用户被授权修改黑名单。 授权用户列表也透明，提供可追溯性。
* **社区审查：** 对此模组的任何拟议更改，特别是与黑名单功能相关的更改，在实施之前必须由 Discord 上的 `@IDoTheHax` 审查和批准。 这确保了更改经过仔细考虑并符合社区标准。
## 特性
- **自动黑名单检查：** 加入服务器时，自动检查连接的玩家是否在集中的黑名单上。
- **集中的禁令管理：** 使用外部 API 检索黑名单数据，从而实现网络范围内的禁令系统。
- **操作员通知：** 通知服务器操作员有关黑名单检查以及任何结果操作。
- **配置：** 可以设置和安全地存储 API 密钥以访问黑名单 API。
- **可定制的断开连接消息：** 向黑名单中的玩家显示清晰且信息丰富的断开连接消息，包括原因和时间戳。
- **日志记录：** 记录黑名单检查、API 响应以及任何遇到的错误，以用于调试目的。
## 设置
### 先决条件
- 运行 Fabric 的 Minecraft 服务器。
- 已安装 Fabric Loader。
- 从 IDoTheHax Discord 服务器获得的 API 密钥。
### 安装
1. **下载模组：** 从您的分发源（例如 Modrinth、GitHub Releases）获取 IDoTheBlacklist 的最新版本。
2. **放置模组：** 将下载的 `.jar` 文件放入 Minecraft 服务器的 `mods` 文件夹中。
* 如果不存在 `mods` 文件夹，请在与 `minecraft_server.jar` 文件相同的目录中创建一个。
3. **启动服务器：** 启动您的 Minecraft 服务器。 Fabric Loader 将加载 IDoTheBlacklist 模组。
## 使用方法
### 设置 API 密钥
IDoTheBlacklist 模组需要 API 密钥才能与黑名单 API 进行通信。 要设置 API 密钥：
1. **以操作员身份登录：** 作为操作员加入您的 Minecraft 服务器。 您必须具有 4 级权限才能执行 `/setapikey` 命令。
2. **使用命令：** 使用后跟您的 API 密钥的 `/setapikey` 命令：
```
/setapikey
```
* 将 `` 替换为您从 IDoTheHax Discord 服务器获得的 API 密钥。
3. **确认：** 服务器将显示一条消息，确认 API 密钥已成功设置。
* API 密钥存储在服务器上的 `config/idotheblacklist.json` 文件中。
### 黑名单检查
- 设置完 API 密钥后，模组将在玩家加入服务器时自动检查他们是否在黑名单上。
- 如果玩家在黑名单上，他们将收到一条消息，说明原因和禁令的时间戳，然后被断开连接。
- 服务器操作员将收到有关黑名单检查和任何断开连接的通知。
## 配置
IDoTheBlacklist 的配置文件位于 `config/idotheblacklist.json`。
### `idotheblacklist.json`
- `api_key`: 您从 IDoTheHax Discord 服务器获得的 API 密钥。 使用 `/setapikey` 命令或通过编辑文件来设置此值。 务必安全地保护此密钥！
## 故障排除
### API 密钥未设置
- 如果 API 密钥未设置，模组将跳过黑名单检查并允许玩家加入。
- 服务器操作员将收到一条指示 API 密钥未设置的警告消息。
- 使用 `/setapikey` 命令设置 API 密钥，如使用方法部分所述。
### API 连接错误
- 如果模组在连接到黑名单 API 时遇到错误，它将跳过检查并允许玩家加入。
- 服务器操作员将收到一条指示黑名单检查失败的警告消息。
- 检查服务器日志以获取有关错误的更多信息。 确保服务器可以连接到互联网且 API 端点可访问。
### 无效的 API 密钥
- 如果 API 密钥无效，API 将拒绝请求，模组将跳过黑名单检查并允许玩家加入。
- 服务器操作员将收到一条指示 API 密钥无效的警告消息。
- 验证您是否已从 Discord 创建了 API 密钥并使用 `/setapikey` 命令输入了正确的 API 密钥。
### 黑名单中的玩家仍然可以加入
- 如果玩家在黑名单上但仍然能够加入服务器，请确保 API 正常运行，并且玩家的 UUID 出现在黑名单中。
- 检查服务器日志以获取与黑名单检查相关的任何错误或警告。
## 支持
如有支持、问题或错误报告，请访问 IDoTheHax Discord 服务器。
[IDoTheHax Discord](https://discord.com/faPd8MQ3Ke)
## 许可
保留所有权利 © IDoTheHax 2025