World Downloader API / WDLCompanion - 世界下载器官方API

💡World Downloader API / WDLCompanion

本插件允许服务器所有者通过 World Downloader 模组（常被称为 WorldDownloader、WorldDL 或 WDL）的插件通道 API 来控制其在服务器上的使用。它支持广泛的功能，从简单地禁用模组，到权限请求，再到仅允许在特定区域下载。

🎮功能特色

• 完整的 API 实现：与那些在玩家加入时立即踢出的插件不同，WDLCompanion 完全实现了 WDL 的插件通道 API，提供了更好的用户体验和更精细的控制。
• 灵活的配置：可以全局或针对特定世界设置是否允许下载、区块缓存、保存实体、保存方块实体等。
• 权限系统集成：使用标准的 Bukkit 权限系统为玩家授予权限。
• 自定义日志：插件生成的消息（如玩家登录、请求）会同时记录在全局服务器日志和一个独立的子文件夹日志中，此功能可关闭。
• 权限请求系统：玩家可以直接在模组内请求下载权限。管理员可以临时授予权限，并可配置过期时间。（此功能仍在完善中，但已可用）
• 强大的区块覆盖：允许指定玩家始终可以下载的区域。这些区域可以是静态坐标，也可以通过 API 由其他插件动态生成（例如，根据玩家所属的领地）。这为整合其他插件（如领地插件）提供了极大灵活性。
• 官方维护：插件开发者同时也是 World Downloader 模组的开发者，这是插件通道 API 的官方实现，能确保与模组更新同步。

🔧使用方法

主要使用方式是编辑其配置文件。

配置文件

默认的配置文件（可在此查看）带有完整注释，如果不确定某个设置的作用，请先查阅。配置错误会在游戏中生成警告或错误提示。

• 基本禁用：若想完全禁用 World Downloader，只需将 canDownloadInGeneral 设置为 false 即可。玩家仍可加入并请求权限。建议同时设置 requestMessage 以告知玩家相关规则。修改配置后需使用 /wdl reload 重载。
• 世界特定配置：编辑 per-world 部分。在其中先放入世界名称（与世界文件夹中的名称一致），然后放置来自通用配置的键值。若未在 per-world 中设置，则使用全局值。对于多维度世界，需要指定所有维度的世界名。
• 区块覆盖配置：配置稍复杂。默认有两种类型：ChunkRange（区块坐标）和 BlockRange（方块坐标，会四舍五入到最近区块）。两者都包含最小和最大的 x、z 坐标，并可选择通过 world 属性限定到特定世界。

- 每个覆盖区域有一个名称（配置部分的键名）和一个可选的 `tag`，主要用于日志记录和客户端通信。对于动态更新的区域，`tag` 有助于数据包优化。

示例配置：

region1:
  type: BlockRange
  world: world
  tag: Freebuild area
  x1: 1000
  z1: 1000
  x2: 1100
  z2: 1250
region2:
  type: ChunkRange
  tag: Spawn chunks
  x1: -5
  z1: -5
  x2: 5
  z2: 5

扩展插件可以定义其他类型的区块覆盖，具体结构需参考相应扩展的文档。

🔧命令列表

玩家可用命令

• /wdl updateme - 刷新客户端的权限信息（通常不需要，但在权限变更后可使用）。

管理员/ moderator 命令

• /wdl reload - 重载插件配置（使用 /reload 或 /restart 也可）。
• /wdl update <player> - 手动更新指定玩家的权限（通常不需要）。
• /wdl updateall - 手动更新所有在线玩家的权限（通常不需要）。
• /wdl requests list [page] - 列出所有当前权限请求。
• /wdl requests show <player> - 显示指定玩家的请求。
• /wdl requests accept <player> - 接受指定玩家的请求。
• /wdl requests reject <player> - 拒绝指定玩家的请求。
• /wdl requests revoke <player> - 撤销已接受的玩家请求。

❓关于 World Downloader 模组的说明

请不要仅因玩家安装了 World Downloader 模组就视其为违规。安装该模组存在许多正当理由：

• 备份自己建造的作品（这也是开发者开发此模组的主要原因）。
• 进入创造模式，在单人游戏中实验建筑想法，再回到多人服务器实际建造。
• 导出建筑的 3D 模型用于粉丝创作（这需要 WDL 以外的其他工具，但也是常见用途）。

此外，WDL 在加入服务器时就会发送权限数据包，以便在开始下载前获取准确的权限信息。因此，插件显示玩家安装了该模组，并不代表他们实际使用了它。

一般建议：

• 在玩家可以建设的服务器上，应允许玩家对自己的建筑使用该模组。
• 在小游戏服务器等场景下，默认禁用该模组是合理的。

✨扩展插件

WDLCompanion 拥有多个与其他插件集成的扩展，通常用于提供额外的区块覆盖类型：

• Skyblock 支持
• Factions 支持
• WorldGuard 支持
• RedProtect 支持
• GriefPrevention 支持

如果你编写了希望添加到此列表的扩展，请联系开发者！

⭐其他信息

• 开源贡献：本插件是开源的，你可以在 GitHub 上查看源代码。欢迎提交问题或拉取请求。

- 如果你想创建自己的区块覆盖类型，可以参考这里的各种示例。

- 基础的 World Downloader 模组也是开源的。

• API 文档：关于 WDL 插件通道 API 的详细信息，请参阅 wiki.vg 文章。
• 统计声明：本插件使用 MCStats (pluginmetrics) 收集匿名统计数据。你可以在此查看这些统计信息。