
M4id
一个Kotlin库。M4id Studio模组的核心。
M4id Library
一个用于 Minecraft Fabric 与 NeoForge 模组的 Kotlin 工具库。
使用 Kotlin DSL 一次编写命令、网络通信、配置与注册,然后即可在两种模组加载器上使用。M4id 是我的模组共用的库依赖。
注意: M4id 目前处于 alpha 阶段。API 可能会在不同版本之间发生变化,在 1.0 版本之前预计会有破坏性变更。
功能
| 领域 | 功能 | 入口 |
|---|---|---|
| 命令 | 一个 Brigadier DSL,支持嵌套字面量、类型化参数、权限辅助函数和补全建议提供器。 | M4id.Command · dispatcher.addCommand(...) |
| 网络通信 | 可序列化的消息类,配有客户端和服务端处理器,无需手动编写数据包编解码器。 | M4id.Message · M4idMsg |
| 数据文件 | 配置和按服务器存储的数据以普通 Kotlin 属性表示,支持原子保存和损坏文件备份。 | DataFile.forClient · DataFile.forServer |
| 序列化 | 为 ResourceLocation、Vec3、AABB、CompoundTag 和 ItemStack 提供 kotlinx.serialization 支持。 |
M4id.Serial |
| 注册 | 使用简洁的注册器 API 注册物品、方块、实体、效果、组件等。 | M4idAutoRegistrar |
| 文本 | 用于构建样式化聊天组件的构建器 DSL,包含点击和悬停事件。 | textLiteral { ... } |
| 输入 | 支持修饰键以及按下/抬起回调的按键绑定。 | M4id.Input |
| 进度条件 | 在代码中注册并触发进度条件。 | M4id.Criterion |
| 日志 | 按模组划分的日志记录器和日志标记。 | M4id.Logging |
| Percale | Mojang Codec、NBT、Gson 与 kotlinx.serialization 之间的桥接。 |
dev.doctorm4id.percale |
安装
M4id 通过 JitPack 发布。
每个 Minecraft 版本与加载器的组合都会发布为单独的构件,命名格式为 <minecraft>-<loader>。例如 1.21.1-fabric。
Gradle(Kotlin DSL)
将 JitPack 添加到你的仓库:
repositories {
maven("https://jitpack.io")
}
然后添加相应的依赖。
Fabric
dependencies {
modImplementation(
"com.github.DoctorM4id.M4id:1.21.1-fabric:0.1.0-alpha.5"
)
}
NeoForge
dependencies {
implementation(
"com.github.DoctorM4id.M4id:1.21.1-neoforge:0.1.0-alpha.5"
)
}
JitPack 项目页面提供了可用的构件和构建信息。你也可以浏览 GitHub 标签查看已发布的版本。
加载器要求
- Fabric: Kotlin 标准库和
kotlinx.serialization已打包进 M4id 的 JAR 中。 - NeoForge: 运行时需要 Kotlin for Forge。
兼容性
| Minecraft 版本 | Fabric | NeoForge | 状态 |
|---|---|---|---|
| 1.21.1 | 是 | 是 | 已支持 |
| 1.20.1 | 计划中 | 不适用 | 计划中,视需要而定 |
| 26.1 及更新版本 | 计划中 | 计划中 | 计划中 |
上表中所列版本之间的 Minecraft 版本会被跳过。
有关完整的兼容性矩阵以及每个受支持版本的最新发布,请参阅 SECURITY.md。
Java 要求: Minecraft 1.20.5 及更新版本需要 Java 21。
项目结构
M4id/
├── build-logic/ # 约定插件、清单、发布、mixin
├── build.fabric.gradle.kts # Fabric 构建配置
├── build.neoforge.gradle.kts # NeoForge 构建配置
├── stonecutter.properties.toml # 模组元数据和各版本依赖
└── src/
├── fabric/ # Fabric 专用代码
├── neoforge/ # NeoForge 专用代码
└── main/
├── java/dev/doctorm4id/
│ ├── m4id/
│ │ ├── command/ # 命令 DSL
│ │ ├── message/ # 网络通信
│ │ ├── data/ # 配置和数据文件
│ │ ├── serial/ # 序列化器
│ │ ├── registration/ # 自动注册器
│ │ ├── text/ # 文本构建器
│ │ ├── input/ # 按键绑定
│ │ ├── ext/ # 扩展函数
│ │ ├── platform/ # 平台抽象与实现
│ │ ├── util/ # 通用工具
│ │ └── internal/ # 内部代码、mixin 和测试
│ └── percale/ # Codec、NBT 和 Gson 桥接
└── resources/ # Mixin、访问拓宽器和资源
支持
- 社区: 加入 Discord 服务器
- Bug 与功能请求: 提交 GitHub Issue
- 安全问题: GitHub Security
致谢
M4id 包含源自 Kambrik 和 Percale 的代码。感谢原作者的工作。
许可证
M4id 基于 Mozilla Public License 2.0 授权。
正在加载版本记录…
正在加载评论…
评论在新手盒子客户端中发表,这里同步展示。