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。
你是这个资源的作者?登录后可认领此资源。
相似资源
显示你正在注视的方块的信息。(适用于 Minecraft 1.16+ 的 Hwyla/Waila 分支)
查看物品与配方
在游戏画面角落显示附近世界地形、玩家、生物和实体的地图。可创建路径点,帮助你找到标记过的位置。
使用 JavaScript 编辑配方、添加自定义物品、编写世界事件!
添加区块认领和玩家组队功能,并与 Xaero's Minimap 和 World Map 集成
添加全屏世界地图,显示你在世界中已探索的区域。与 Xaero's Minimap 搭配使用效果极佳。
评论 0
登录后参与评分
还没有评论,来抢沙发吧