• 简体中文

      • 内置 Mod 与子模块

      Estimated reading time: 5 minutes

      ModLoader 将与核心功能无关的功能分离为独立的 Mod，并将常用 Mod 以预置的方式提供。这些 Mod 在 modList.json 中定义，作为 Git 子模块位于 mod/ 目录下，通过 insert2html 打包时作为 local 类型嵌入到游戏 HTML 中。本列表与 sugarcube-2-ModLoader README 保持一致。

      核心基础设施

      Mod状态功能
      ModLoaderGuiUsableMod 管理器界面，管理加载顺序、启用/禁用 Mod、查看加载日志
      ConflictCheckerStableMod 冲突检查器，提供附加约束条件检查 Mod 间的冲突
      SweetAlert2ModStable弹出提示框封装，基于 SweetAlert2
      ModSubUiAngularJsStable基于 AngularJS 的可复用 UI 组件框架

      Twee 内容操作

      Mod状态功能
      TweeReplacerStablePassage 替换，支持正则表达式和文件存储替换字符串
      I18nTweeReplacerStableTweeReplacer 的原生 i18n 支持版
      TweeReplacerLinkerStable链接 TweeReplacer 和 I18nTweeReplacer，共享替换顺序
      ReplacePatchStable提供对 JS/CSS/Passage 的简单字符串替换
      TweePrefixPostfixAddonDeveloping提供在 Passage/Widget 执行前后挂钩的能力
      Diff3WayMergeDeveloping基于 Git Diff3Way 算法的 Passage 合并功能

      图片与 UI

      Mod状态功能
      ImageLoaderHookStable拦截图片请求，从 Mod zip 中替换游戏图片
      BeautySelectorAddonStable同一 Mod 中内置多组美化图片并支持运行时切换
      ModuleCssReplacerDeprecatedCSS 替换器（有重大性能问题，请勿使用）

      i18n 国际化

      Mod状态功能
      I18nTweeListStable为 tweeFileList 提供 i18n 支持
      I18nScriptListStable为 scriptFileList 提供 i18n 支持

      DoL 专用钩子

      Mod状态功能
      CheckGameVersionStable为依赖检查中的游戏版本检查提供 DoL 适配
      CheckDoLCompressorDictionariesStable检查 DoL 数据压缩字典变更并警告用户
      DoLHookWidgetModStable给 DoL 自定义 Widget 打 TweePrefixPostfix 所需补丁
      DoLTimeWrapperAddon—DoL 时间包装器钩子
      DoLLinkButtonFilter—DoL 链接/按钮过滤器

      游戏内容插件

      Mod状态功能
      ModdedClothesAddonStableDoL 快速服装添加工具
      ModdedFeatsAddonStableDoL 快速成就添加工具
      ModdedHairAddonStableDoL 快速发型添加工具

      外部 Mod 与工具

      Mod类型状态功能
      PhoneDebugToolsErudaExternalStable手机调试工具，对 Eruda 的简单封装
      i18nExternalStablei18n 中文翻译 Mod
      CryptoI18nExampleDemov2.0.0 Mod 加密功能 Demo
      ExampleModModifyModExampleDemo演示如何用 Mod B 读取并修改 Mod A 的数据和行为
      SimpleCryptWrapperToolsStable简易 Mod 加密封装工具
      DoLModWebpackExampleTsTemplateDemo使用 Webpack + TypeScript 的 Mod 模板项目
      DoLModWebpackExampleJsTemplateDemo使用 Webpack + JavaScript 的 Mod 模板项目
      Info

      有关各个 Mod 的详细功能及用法，请参见对应 Mod 项目的 README.md 文件。

      常用 Addon 使用示例

      TweeReplacer

      替换游戏 Passage 内容。在 boot.json 中声明依赖：

      {
  "addonPlugin": [
    {
      "modName": "TweeReplacer",
      "addonName": "tweeReplacer",
      "modVersion": "1.0.0",
      "params": []
    }
  ]
}

      ReplacePatch

      对 JS/CSS/Passage 内容进行简单字符串替换：

      {
  "addonPlugin": [
    {
      "modName": "ReplacePatch",
      "addonName": "replacePatch",
      "modVersion": "1.0.0",
      "params": []
    }
  ]
}

      ImageLoaderHook

      替换游戏图片。将图片添加到 imgFileList，匹配原游戏路径的图片会自动替换：

      {
  "imgFileList": ["MyMod_Image/character/avatar.png", "MyMod_Image/backgrounds/room.jpg"],
  "addonPlugin": [
    {
      "modName": "ImageLoaderHook",
      "addonName": "imgLoaderHook",
      "modVersion": "1.0.0",
      "params": []
    }
  ]
}

      创建自定义 Addon

      如果内置 Addon 无法满足需求，可以创建自定义 Addon：

      // 在 inject_early 或 earlyload 阶段注册
(async () => {
  const addonInstance = {
    registerMod(modName, modZip, params) {
      console.log(`Mod ${modName} registered with my addon`);
    },
  };

  window.modAddonPluginManager.registerAddonPlugin("MyCustomAddon", "customPlugin", addonInstance);
})();

      消费方 Mod 在 boot.json 中声明依赖：

      {
  "addonPlugin": [
    {
      "modName": "MyCustomAddon",
      "addonName": "customPlugin",
      "modVersion": "1.0.0",
      "params": []
    }
  ]
}