Mod（模组系统）

ll/api/mod/ · 通用

概述

Mod 模块管理模组生命周期、元数据（清单）、目录结构，并提供对模组特定资源的访问，如日志器、配置目录和数据目录。

头文件

头文件	说明
`ll/api/mod/Mod.h`	模组实例和生命周期
`ll/api/mod/Manifest.h`	模组元数据结构
`ll/api/mod/ModManager.h`	模组管理器基类
`ll/api/mod/ModManagerRegistry.h`	所有模组管理器的注册表
`ll/api/mod/NativeMod.h`	原生（DLL）模组实现

核心类

Mod

表示已加载的模组，包含生命周期回调和资源访问。

C++

namespace ll::mod {
class Mod {
public:
    enum class State { Enabled, Disabled };

    State getState() const;
    Manifest const& getManifest() const;
    std::string const& getName() const;
    std::string const& getType() const;

    std::filesystem::path const& getModDir() const;
    std::filesystem::path const& getDataDir() const;
    std::filesystem::path const& getConfigDir() const;
    std::optional<std::filesystem::path> getWorldDataDir() const;
    std::optional<std::filesystem::path> getWorldConfigDir() const;
    std::filesystem::path const& getLangDir() const;
    std::filesystem::path const& getResourceDir() const;
    std::filesystem::path const& getBehaviorDir() const;

    io::Logger& getLogger() const;

    bool isEnabled() const;
    bool isDisabled() const;

    void onLoad(CallbackFn func) noexcept;
    void onUnload(CallbackFn func) noexcept;
    void onEnable(CallbackFn func) noexcept;
    void onDisable(CallbackFn func) noexcept;
};

std::filesystem::path const& getModsRoot();
}

Manifest

从 manifest.json 加载的模组元数据。

C++

namespace ll::mod {
struct Dependency {
    std::string                             name;
    std::optional<data::VersionRequirement> version;
};

struct Manifest {
    std::string                                entry;
    std::string                                name;
    std::string                                type;
    std::optional<std::string>                 platform;
    std::optional<bool>                        passive;
    std::optional<data::Version>               version;
    std::optional<std::string>                 author;
    std::optional<std::string>                 description;
    std::optional<SmallStringMap<std::string>> extraInfo;
    std::optional<SmallDenseSet<Dependency>>   dependencies;
    std::optional<SmallDenseSet<Dependency>>   optionalDependencies;
    std::optional<SmallDenseSet<Dependency>>   conflicts;
    std::optional<SmallDenseSet<Dependency>>   loadBefore;
};
}

依赖项沿用现有的清单 JSON 结构：

JSON

{
  "dependencies": [
    { "name": "RequiredMod", "version": "^1.2.3" }
  ],
  "optionalDependencies": [
    { "name": "OptionalIntegration", "version": ">=2.0.0 <3.0.0" }
  ],
  "loadBefore": [
    { "name": "LateInitializer" }
  ]
}

依赖项省略 version 时可匹配任意版本，也可匹配未声明版本的目标；一旦写出范围，目标必须声明匹配的版本。完整语法见 Data（数据结构）。裸完整版本 1.2.3 暂时保留旧语义 >=1.2.3 <2.0.0，并会输出迁移警告；精确匹配请使用 =1.2.3。

模组类型

清单中的 type 字段决定由谁加载该模组：

`type`	加载者	加载时机
`native`	LeviLamina 的原生模组管理器（`NativeModManagerName`）	LeviLamina 启动后，与其他 LeviLamina 模组一起加载。普通的 C++ 模组使用此类型。
`preload-native`	PreLoader	游戏启动前、LeviLamina 的模组之前加载。LeviLamina 本身就使用此类型。LeviLamina 的模组注册表会跳过这类清单，因此它们不属于 LeviLamina 模组。

其他 type 由通过 ModManagerRegistry 为该类型注册的模组管理器加载（例如脚本引擎）。如果没有为该类型注册管理器，加载会失败并提示 "Unrecognized mod type"。

无论哪种类型，将 passive 设为 true 后，只有当其他模组依赖它时才会加载该模组。

依赖语义

清单字段	加载顺序	依赖加载失败	disable/unload 保护
`dependencies`	依赖先加载	阻止依赖方加载	有
`optionalDependencies`	可用且版本匹配的依赖先加载	不阻止使用方加载	加载时成功绑定后有
`loadBefore`	声明方先加载	不建立依赖关系	无

loadBefore 只约束启动加载和批量操作顺序，绝不会阻止任一方单独 disable 或 unload。动态加载不会重排已经加载的模组；若新模组要求在已加载目标之前加载，LeviLamina 会记录警告并继续。可选依赖只在使用方加载时绑定，因此之后才动态加载的可选依赖提供方不会被追溯加入生命周期保护。

使用方法

访问模组实例

C++

#include "ll/api/mod/NativeMod.h"

ll::mod::NativeMod& getSelfMod() {
    return ll::mod::NativeMod::current();
}

使用模组资源

C++

#include "ll/api/mod/Mod.h"

void setupMod(ll::mod::Mod& mod) {
    auto& logger = mod.getLogger();
    logger.info("模组名称: {}", mod.getName());

    auto configPath = mod.getConfigDir() / "config.json";
    auto dataPath = mod.getDataDir() / "database.db";
    auto langPath = mod.getLangDir() / "zh_CN.json";
}

生命周期回调

C++

#include "ll/api/mod/Mod.h"

void registerCallbacks(ll::mod::Mod& mod) {
    mod.onLoad([](ll::mod::Mod& self) -> bool {
        self.getLogger().info("模组加载中");
        return true;  // 返回 false 中止加载
    });

    mod.onEnable([](ll::mod::Mod& self) -> bool {
        self.getLogger().info("模组已启用");
        return true;
    });

    mod.onDisable([](ll::mod::Mod& self) -> bool {
        self.getLogger().info("模组已禁用");
        return true;
    });

    mod.onUnload([](ll::mod::Mod& self) -> bool {
        self.getLogger().info("模组卸载中");
        return true;
    });
}

目录结构

模组位于模组根目录（getModsRoot()）中：服务端为 plugins/，客户端为 mods/。（plugins/ 目录存在时 PreLoader 使用它，否则使用 mods/；PreLoaderConfig.json 中的 modsPath 可以覆盖该设置。）每个模组具有以下目录结构：

Text Only

plugins/                       # 客户端为 mods/
└── MyMod/
    ├── manifest.json          # 模组元数据
    ├── MyMod.dll              # 模组二进制文件
    ├── config/                # 配置文件 (getConfigDir())
    ├── data/                  # 持久化数据 (getDataDir())
    ├── lang/                  # 翻译文件 (getLangDir())
    ├── resource_packs/        # 资源包 (getResourceDir())
    └── behavior_packs/        # 行为包 (getBehaviorDir())

worlds/
└── Bedrock level/             # 当前世界的文件夹
    ├── ll_config/
    │   └── MyMod/             # 世界特定配置 (getWorldConfigDir())
    └── ll_data/
        └── MyMod/             # 世界特定数据 (getWorldDataDir())

未加载世界时，getWorldConfigDir() 和 getWorldDataDir() 返回 std::nullopt。在客户端连接远程服务器时，它们分别是游戏目录下的 ll_config/<host>_<port>/MyMod/ 和 ll_data/<host>_<port>/MyMod/。