Konfig
Konfig 是一个用于 Minecraft 模组的跨加载器配置库。
它允许模组在通用代码中声明类型化的配置值,将其保存为带注释的 TOML 文件,将选定的值同步到客户端,并为 Fabric、Forge 和 NeoForge 生成配置界面。
Konfig 专为共享通用代码而构建。加载器特定的集成保留在加载器根目录中,而配置声明、验证、迁移、同步元数据和界面元数据则可以与你的其他模组逻辑并列存放。
功能特性
- 支持布尔值、数字、枚举、字符串、字符串列表、RGB/ARGB 颜色以及自定义编解码器的类型化配置值
- 感知运行侧的配置作用域:
CLIENT(客户端)、COMMON(通用)和SERVER(服务器) - 自动生成带注释的 TOML 文件,位于
config/<modid>/<name>.toml - 内置同步模式:
NONE(不同步)、LOGIN(登录时同步)和LOGIN_AND_RELOAD(登录并重载时同步) - Schema 版本控制和逐步迁移机制
- 为已注册句柄生成配置界面
- 内联界面装饰元素:标题、图片、描述性文本和可点击的 URL
- 生成的界面行具有明确的工具提示
- 针对全局、分类和特定值的丰富悬停信息面板
- Fabric Mod Menu 集成
- Forge 和 NeoForge 配置按钮辅助功能
截图






支持的版本
Konfig 0.4.0 支持从 1.14.4 到 26.2 的所有 Minecraft 版本线。
- Fabric 最低支持
1.14.4 - Forge 最低支持
1.16.5 - NeoForge 最低支持
1.21.1
Konfig 在所有支持的 Minecraft 版本线上使用统一的语义化版本号。+<mc> 后缀表示该制品目标所针对的 Minecraft 版本,例如 0.4.0+1.21.11 或 0.4.0+26.2。
快速示例
import com.iamkaf.konfig.api.v1.ConfigBuilder;
import com.iamkaf.konfig.api.v1.ConfigHandle;
import com.iamkaf.konfig.api.v1.ConfigScope;
import com.iamkaf.konfig.api.v1.ConfigValue;
import com.iamkaf.konfig.api.v1.Konfig;
import com.iamkaf.konfig.api.v1.RestartRequirement;
import com.iamkaf.konfig.api.v1.SyncMode;
public final class ExampleConfig {
public static final ConfigHandle HANDLE;
public static final ConfigValue<Boolean> ENABLED;
public static final ConfigValue<Integer> RANGE;
static {
ConfigBuilder builder = Konfig.builder("examplemod", "common")
.scope(ConfigScope.COMMON)
.syncMode(SyncMode.LOGIN)
.comment("Example mod config")
.info(info -> info
.header("Example Mod")
.inlineText("These settings control shared gameplay behavior.")
.url("Documentation", "https://example.invalid/docs"));
builder.header("Example Mod Settings");
builder.inlineText("These entries are saved automatically.");
builder.url("Documentation", "https://example.invalid/docs");
builder.push("general");
builder.categoryComment("General gameplay tuning");
builder.categoryTooltip("General gameplay tuning");
builder.categoryInfo(info -> info
.header("General")
.inlineText("Values in this section affect the whole mod."));
ENABLED = builder.bool("enabled", true)
.comment("Master toggle")
.tooltip("Enable example mod features")
.sync(true)
.info(info -> info
.header("Master Toggle")
.inlineText("Turns the main feature set on or off."))
.build();
RANGE = builder.intRange("range", 8, 1, 64)
.comment("Effect radius")
.tooltip("Controls the effect radius in blocks")
.sync(true)
.restart(RestartRequirement.WORLD)
.build();
builder.pop();
HANDLE = builder.build();
}
}
读取值时使用 ConfigValue#get(),以编程方式更改值时使用 ConfigValue#set(value)。
注释会写入 TOML 文件。通过 tooltip(...) 和更丰富的 info(...) 内容,生成的界面悬停文本是明确的,因此当需要时,配置文件和 UI 帮助可以显示不同的内容。
依赖项
添加 Kaf Maven 仓库:
repositories {
maven { url = "https://maven.kaf.sh" }
}
使用针对你所目标 Minecraft 版本线的加载器制品:
modImplementation "com.iamkaf.konfig:konfig-fabric:<version>"
modImplementation "com.iamkaf.konfig:konfig-forge:<version>"
modImplementation "com.iamkaf.konfig:konfig-neoforge:<version>"
不要直接依赖 Konfig common 制品。请使用加载器特定的制品。
帮助翻译 Konfig
想要帮助将此模组翻译成你的语言?加入社区翻译项目:
?? ?? ?? ?? ?? ?? ?? ?? ?? ??
常见问题
Q: 如果我有这里未列出的问题,去哪里提问?
A: 在此处 提交 issue 或加入 Discord 并给我发消息。
Q: 你能移植到 [MC 版本/模组加载器] 吗?
A: 如果有足够多的人请求,我会分配时间处理,但这确实是一个单人团队的项目,所以可能需要一段时间。
问:我可以将它包含在我的整合包中吗?
答:可以,无需署名或征得同意。
我制作的其他模组
![]() Bonded |
![]() Kaf's Valentine Special |
![]() Liteminer |
![]() Mochila |
![]() Torch Toss |
你是这个资源的作者?登录后可认领此资源。
相似资源
显示你正在注视的方块的信息。(适用于 Minecraft 1.16+ 的 Hwyla/Waila 分支)
使用 JavaScript 编辑配方、添加自定义物品、编写世界事件!
查看物品与配方
在游戏画面角落显示附近世界地形、玩家、生物和实体的地图。可创建路径点,帮助你找到标记过的位置。
AE2:一款流行的自动化与存储模组
那是什么?一个 Waila/Hwyla 的分支。





评论 0
登录后参与评分
还没有评论,来抢沙发吧