Simple Config

模组

· 作者 Tondoa

Simple Config 是一个基于 Kotlin 的 Fabric Minecraft 模组,可让你轻松管理模组的配置。它提供了一个简单直观的 API,用于读取和写入配置数据。数据将以 JSON 格式进行序列化。

0 本站下载 0 关注 更新于 2 年前

需要前置:Fabric API、Fabric Language Kotlin

最新 1.0.0 · 1.20.4 · Fabric

一键开服(送7天)

Simple Config

Simple Config 是一个基于 Kotlin 的 Fabric Minecraft 模组,允许你轻松管理你的模组的配置。它提供了一个简单直观的 API 来读取和写入配置数据。数据将以 JSON 格式进行序列化。

用法

以下是使用 Simple Config 的基本示例:

object TutorialMod : ModInitializer {
  private val logger = LoggerFactory.getLogger("tutorialmod")

  override fun onInitialize() {
  
    //访问数据
    MyConfig.data.someNestedObject.someData
    MyConfig.data.someString // 返回 "hello"
    
    //写入数据
    MyConfig.patch {
      someString = "Hello World!"
      someNumber = 0.07
    }
    
    MyConfig.data.someString // 返回 "Hello World!"
    
    logger.info("Hello I am using Simple Config!")
  }
}

当你使用 patch 方法写入数据时,它将自动被写入文件。

命令

你也可以通过 /simpleconfig [fileName] 命令重新加载配置,或者使用 /simpleconfig all 命令重新加载所有 Simple Config 的配置。

配置

要创建配置,你需要创建一个继承自 SimpleConfig<T> 的 object。T 可以是任何类,只要它具有 @Serializable 注解。你必须重写 fileName!

以下是一个示例:

object MyConfig: SimpleConfig<SomeDataClass>(defaultValue = SomeDataClass()) {
  override var fileName = "tutorialmod_config"
}

@Serializable
data class SomeDataClass(
  var someNumber: Double = 2.0,
  var someString: String = "hello",
  var someNestedObject: SomeNestedClass = SomeNestedClass()
)

@Serializable
class SomeNestedClass {
  var someData = LocalDate.parse("2024-01-01")
}

你可以重写的可选值:

选项 描述 默认值
fileEnding 应使用的文件扩展名 ".json"
path 配置将被写入的路径 FabricLoader.getInstance().configDir
createReloadCommand Simple Config 是否应注册重载命令 true
json 用于序列化的 Json 设置 Json { prettyPrint = true; encodeDefaults = true }

Gradle 设置

要通过 Gradle 设置 Simple Config,请将以下内容添加到你的 build.gradle 文件中:


plugins {
  [...]
  id 'org.jetbrains.kotlin.plugin.serialization' version '1.9.22'
}

repositories {
  [...]
  maven { url 'https://jitpack.io' }
}

dependencies {
  [...]
  modImplementation 'com.github.JonasSeifried:SimpleConfig:1623553e8f'
}

故障排除

如果在用 Simple Config 时遇到任何问题,请查看 GitHub issues 页面。如果那里没有列出你的问题,欢迎提交一个新的 issue。

许可证

Simple Config 遵循 MIT License。

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

评论 0

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

登录后参与评分

还没有评论,来抢沙发吧

评论配图

相似资源