模组兼容性守卫

模组兼容性守卫

在启动时检查服务器上的每个模组,并报告哪些会失败及原因:重复项、缺失依赖以及对已不存在的服务器代码的调用。

实用

Mod Compat Guard

检查你服务器上的每一个模组,告诉你哪些会失败、以及失败原因,让你不必把一晚上耗在启动循环上。仅服务端。

检查内容

检查项 报告中的代码 服务器对此的处理
两个文件具有相同的插件 id,例如同一个模组的两个版本 duplicate-id 以 MOD_ERROR 停止。报告中会指出较旧的文件
manifest.json 缺失或无法读取 bad-manifest 跳过该文件
必需依赖缺失或版本错误 dependency 丢弃该插件。依赖它的任何内容也会失败,报告会沿依赖链追踪
依赖循环 dependency-cycle 无法确定加载顺序
主类缺失,或缺少公有的 JavaPluginInit 构造函数 main-class 以 MOD_ERROR 停止
模组调用了此版本上不存在的服务器代码 missing-api 会加载,但在该代码运行时以 NoSuchMethodError 或 NoClassDefFoundError 崩溃
ServerVersion 排除了正在运行的服务器 server-version 发出警告,但仍会加载
没有 ServerVersion no-server-version 发出警告;服务器表示这将成为硬错误
可选依赖缺失 optional-dependency 无影响;仅作为备注显示

清单检查使用服务器自带的解码器和版本规则,因此模组在此处的通过或失败情况与在服务器上一致。missing-api 是版本号无法告诉你的部分:它读取每个模组的字节码,并在实际正在运行的服务器类中查找模组使用的每一个类、方法和字段,包括继承的成员。

在服务器配置中被关闭、或被 DisabledByDefault 关闭的模组会被计入并跳过。

使用方法

报告会在每次启动时写入服务器日志,并写入模组数据目录中的 report.txt。

/modcheck 会再次扫描并打印报告(仅限管理员和控制台)。它显示前 20 条发现;其余内容在 report.txt 中。它从不移动文件。

服务器无法启动时

扫描在插件构造期间、setup() 之前运行,因此即使启动即将因重复 id 或损坏的模组而停止,报告仍能写入日志。更早发生的失败(例如依赖循环)会在任何模组运行之前使服务器停止。对于这些情况,请在服务器停止时使用独立检查:

java -jar mods/mod-compat-guard-1.0.0.jar --mods mods

当 HytaleServer.jar 位于 mods 上一级文件夹中,或位于其中的 Server/ 中时,该形式可用。选项:--mods <folder>、--strict、--no-bytecode、--move-failing。它会针对类路径上的任意服务器 jar 进行检查,因此你可以在更新前将其指向新的服务器 jar。

设置

模组数据目录中的 modcompatguard.properties(首次启动时创建):

键 默认值 含义
bytecodeCheck true 运行 missing-api 和 main-class 检查
strictServerVersion false 将排除服务器的 ServerVersion 视为错误
moveFailing false 将有错误的文件移动到模组文件夹旁的 mods-disabled/

当 moveFailing=true 时,有错误的文件会在下次启动时移出。在 Windows 上,已加载的 jar 无法移动,因此报告会显示 NOT MOVED 并指向独立检查。如果超过一半的文件失败,则不会移动任何文件。开启此功能前请先阅读报告:缺少一个调用的模组可能仍然大部分可用。

限制

  • 预发布版上的 ServerVersion:诸如 0.x 的范围不会匹配 0.8.0-pre.3。如果该范围覆盖正式版,报告会显示备注而不是警告。
  • missing-api 仅覆盖服务器类。它不检查从一个模组到另一个模组的调用。
  • 不检查资源内容,只检查包清单。

安装:将 jar 放入服务器的 mods/ 文件夹并重启。许可证:MIT。

需要定制内容? 我按需构建小型服务器插件,修复 $35 起,全新单功能插件 $90 起:https://ko-fi.com/molonlav3/commissions 。如果这个模组为你节省了时间,请我喝杯咖啡有助于持续更新:https://ko-fi.com/molonlav3