Compat API

📖 关于

Compat API 是 fixerlink 为整个“Compat”生态打造的轻量通用兼容框架，涵盖 Compat Delight、即将推出的 Compat Artifacts、Compat Decor，以及任何希望轻松、自动地添加跨模组联动的第三方模组。

无需将兼容逻辑硬编码到模组中，也不用手动管理数据包，Compat API 会为你处理一切：
自动加载兼容代码、注入数据包、封装战利品修饰器、应用条件，并且仅在安装了所需模组时启用联动。

📃 功能

• 智能兼容扫描器：仅加载明确依赖 Compat API 的模组所提供的联动。
• 自动加载兼容代码：
  自动检测 net.<owner>.<moid>.compats.<target> 中的兼容模块，并自动执行其注册、初始化或引导钩子。
• 自动注入数据包：
  将 data/<owner>/<modid>/compats/<target> 中的内容作为内置数据包加载——仅当目标模组存在时才会加载。
• 通用战利品修饰器系统：
  自动添加兼容条件并生成全局战利品修饰器列表。
• 兼容条件：
  内置条件 compatapi:compat_enabled 可确保联动安全加载，并且只在适当时启用。
• 按目标单独配置开关：
  每个兼容模块都可以通过配置单独启用或禁用。
• 安全、可靠的系统：
  兼容功能出错时不会导致游戏崩溃——错误会被记录下来，相关功能也会安全跳过。

📝 描述

工作原理：

安装 Compat API。
就这么简单。

如果某个模组依赖 Compat API 并包含兼容模块，API 就会：

• 检测其兼容代码
• 注入其兼容数据包
• 封装其战利品修饰器
• 应用条件
• 并自动启用联动

如果目标模组未安装，对应兼容功能就不会加载。没有错误，不会崩溃，也无需手动设置。模组可以自由添加兼容文件夹和类——繁重的工作都由 Compat API 完成。当然，每项联动都可以通过配置开关控制。

🎁 补充信息

• 不依赖 Compat API 的模组会被完全忽略
• 仅当目标模组已安装时，才会加载相应联动
• 兼容代码出错不会影响游戏运行
• 全自动系统：代码、数据包、条件、战利品修饰器一应俱全
• 只需极少的样板代码，即可支持数千项联动

🧾 致谢

Compat API 由 fixerlink 开发，旨在为所有 Compat 系列模组以及希望实现简洁、模块化、自动化跨模组联动的开发者，提供通用标准。

欢迎反馈！