ModLoader
SugarCube-2 Mod 加载框架

为 SugarCube2 互动小说引擎设计的模组加载与管理框架

📦

多来源 Mod 加载

支持从 HTML 内嵌、远程服务器、localStorage 和 IndexedDB 四种来源加载 Mod,后加载的同名 Mod 自动覆盖先加载的。

四阶段脚本加载

提供 inject_early、earlyload、preload 和 scriptFileList 四个脚本加载阶段,让 Mod 作者在不同时机精确控制游戏数据。

🔀

Passage / 样式 / 脚本合并

Mod 的 tweeFileList、styleFileList 和 scriptFileList 在 SugarCube2 读取数据前合并到 tw-storydata 节点中。

🔗

Mod 间通信

通过 AddonPlugin 系统和 ModInfo.modRef 机制,Mod 之间可以相互暴露 API 并进行交互。

依赖检查

Mod 可在 boot.json 中声明对其他 Mod、ModLoader 版本和游戏版本的依赖约束,加载时自动校验。

🛡️

安全模式

连续三次加载失败后自动进入安全模式,禁用所有 Mod 以便恢复,防止故障 Mod 导致游戏无法启动。