Unnamed Common Library (UCL)

模组

· 作者 Discorde

一个非常简单、易于使用的配置库,完美融入你的模组!

0 本站下载 0 关注 更新于 10 个月前

最新 0.5.0+1.21.11-neoforge · 1.21.11 · NeoForge

一键开服(送7天)
English

❔ 了解更多详情

Unnamed Common Library (UCL) 是我尝试打造的一款简洁、实用(且尚未完全展现)的强大配置库。其目标是成为通用型工具,无论您开发的是何种模组或拥有何种偏好,都可以始终使用它。该库显然并非设计为独立使用的;若您单独使用它,它至多只能作为展示其能力的示例和测试。

? 为什么您应该喜欢它

  • 极其容易实现和使用
  • 可选的配置界面集成
  • 支持 JSON、TOML 和 YAML

?‍? 面向开发者

安装

将仓库添加到您的 build.gradle(.kts) 中:

repositories {
    maven {
        url = "https://maven.pkg.github.com/aurorarissime/unnamed-common-library"
    }
}

并在您的 buildscript 中添加依赖(Fabric 使用 modImplementation,NeoForge 使用 implementation):

dependencies {
    (mod)Implementation("from.discorde:ucl:${ucl_version}+${minecraft_version}-fabric")
}
用法

1. 创建您的配置模型

MyModConfig.java

import from.discorde.ucl.common.config.annotations.*;

@Configuration(
    name = "mymod"
)
public class MyModConfig {
    @Comment("启用这个超棒的功能")
    public boolean awesomeFeature = true;

    @Comment("最大功率等级 (0-100)")
    public int maxPower = 50;

    @Comment("向玩家显示的欢迎消息")
    public String welcomeMessage = "Hello!";
}

2. 在您的模组初始化器中加载配置

MyMod.java

public class MyMod implements ModInitializer {
    // 包装类会在编译时自动生成
    public static final MyModConfigWrapper CONFIG = MyModConfigWrapper.createAndLoad();

    @Override
    public void onInitialize() {
        if (CONFIG.awesomeFeature) {
            System.out.println("超棒功能已启用!");
        }
    }
}
参考文档

注解

@Configuration

将此注解添加在您配置类的正上方

参数 类型 默认值 描述
name String 必填 配置文件或文件夹名称
location ConfigurationLocation SUBDIRECTORY 保存配置的位置
format ConfigurationFormat JSON5 要使用的文件格式
screen boolean true 生成 YACL 配置界面

@Comment

将此注解添加在任意字段上方,以在配置文件中包含注释

@Comment("此注释将出现在配置文件中该字段的上方")
public boolean myOption = true;

枚举

ConfigurationLocation

值 描述
ROOT 直接保存在配置文件夹中,文件名为 {name}.{ext}
SUBDIRECTORY 保存在子文件夹中,文件名为 {name}/configuration.{ext}

ConfigurationFormat

值 扩展名 描述
JSON5 .json5 支持注释、尾随逗数和未加引号键的 JSON
TOML .toml Tom's Obvious Minimal Language
YAML .yaml YAML Ain't Markup Language
配置界面集成

如果您的 @Configuration 注解中设置了 screen = true(默认值),并且安装了 YetAnotherConfigLib (YACL),则会自动生成一个配置界面,并通过 Mod Menu 访问。
若要禁用配置界面,只需在 @Configuration 注解中将 screen 参数设置为 false 即可。

祝您使用愉快 ?

你是这个资源的作者?登录后可认领此资源。

评论 0

0.0
暂无评分
5 星
0
4 星
0
3 星
0
2 星
0
1 星
0
我的评分

登录后参与评分

还没有评论,来抢沙发吧

评论配图

相似资源