QoLib

QoLib

用于 Quantum8060 的 Fabric 模组的共享工具库。

客户端配置 API

QoLib 的第一个 API 是一个仅限客户端的 JSON 配置存储。其公开类型不暴露 Minecraft 类，因此使用方模组可以使用 Mojang 或 Yarn 映射。

private static final ConfigValue<Boolean> ENABLED = ConfigValue.booleanValue("enabled", false);
private static final ClientConfig CONFIG = ClientConfig.builder("viewer-mod")
    .add(ENABLED)
    .build();
// 在 ClientModInitializer#onInitializeClient 中：
CONFIG.load();
ENABLED.set(true);
CONFIG.save();

支持的值类型包括布尔值、范围整数、范围小数、字符串和枚举。配置文件存储在 config/<mod-id>.json 中。无效或缺失的字段使用其声明的默认值。保存时使用临时文件，并在可用时进行原子替换。

该 API 将持久化与设置界面分离，因此值也可以通过按键绑定或其他客户端逻辑进行更改。

设置界面

使用 config.screen("Title") 来定义类别、开关、滑块、数字字段和操作按钮。build(parent) 返回一个 Screen，用于 Mod Menu 的配置界面工厂。界面会将更改暂存，直到点击 保存；取消 则保持配置不变。搜索框会在所有类别中搜索标签和描述。

return CONFIG.screen("Viewer Mod")
    .category("general", "General", menu -> menu
        .toggle("Enabled", "Save received chunks", ENABLED)
        .integerSlider("Radius", "Chunks to capture", RADIUS, 1, 16)
        .integerField("Maximum files", "Archive limit", MAX_FILES))
    .category("tools", "Tools", menu -> menu
        .button("Clear cache", "Deletes the local cache", ViewerCache::clear))
    .build(parent);