BSCM (Ben's S#### Config Mod)
BSCM 是一个轻量级的 Fabric 模组 YAML 配置库。它简化了配置的创建、加载和编辑,让你可以专注于构建功能,而不是处理样板代码。
特性
- 基于注解的配置
直接在代码中通过简单的注解定义你的配置结构。
- 基于 YAML
人类可读、整洁且广泛支持的配置格式。
- 自动加载与保存 无需手动修改配置 YAML(服务器端仍需自行处理),BSCM 为你完成所有操作。
内置配置界面(支持 Mod Menu)使用 Mod Menu 轻松在游戏中编辑配置。
- 极简且对开发者友好
设计初衷是尽量不打扰你,同时赋予你完全的控制权。
用法
-
创建一个配置类
-
标注你想要暴露的字段
-
让 BSCM 处理其余部分
示例:
Gradle:
repositories{
maven {
name = "Modrinth"
url = "https://api.modrinth.com/maven"
}
maven {
name = "Terraformers"
url = "https://maven.terraformersmc.com/"
}
}
dependencies {
modImplementation "maven.modrinth:bscm:1.0.4"
modImplementation "com.terraformersmc:modmenu:${project.modmenu_version}"
}
配置类:
public class ExampleConfig {
@Comment("Enable the feature")
public boolean enabled = true:
@Comment("Maximum value")
public int maxValue = 10;
}
主类:
import ca.techgarage.bscm.Bscm;
public void onInitialize() {
Bscm.load(ExampleConfig.class, "ModID");
}
如何设置客户端
要设置必须依赖你所使用的版本的 ModMenu
ModMenu 集成类
public class MyModMenuIntegration extends BSCMModMenuIntegration {
public MyModMenuIntegration() {
super(ExampleConfig.class, "ModID");
}
}
在你的 fabric.mod.json 中
"entrypoints": {
"modmenu": [
"com.example.mymod.MyModMenuIntegration"
]
}
BSCM 将自动:
-
生成一个 YAML 文件
-
在启动时加载值
-
在更新时保存更改
游戏内配置
如果你安装了 Mod Menu,BSCM 提供了一个简单的配置 GUI,让用户无需离开游戏即可编辑设置。
依赖项
-
Fabric Loader ≥ 0.15.0
-
(可选)Mod Menu 用于游戏内配置 UI
为什么选择 BSCM?
大多数配置系统要么:
过于复杂
过于局限
或者需要大量的样板代码
BSCM 旨在找到那个甜蜜点:
简单、易读,且足以应对真实模组的强大需求。
你是这个资源的作者?登录后可认领此资源。
相似资源
一个用于收集生物掉落物的多区块模组。
显示你正在注视的方块的信息。(适用于 Minecraft 1.16+ 的 Hwyla/Waila 分支)
查看物品与配方
使用 JavaScript 编辑配方、添加自定义物品、编写世界事件!
适用于 MC 1.18+ 的 Effekseer 加载器
一个基于构建器的 Minecraft 配置库!
评论 0
登录后参与评分
还没有评论,来抢沙发吧