Jauml

模组

· 作者 NAIZO

NightBeam 模组背后的共享库:支持注释的类型化 JSON 配置、服务器事件与刻调度器,以及适用于 Fabric、NeoForge 和 Forge(1.20.1、1.21.1、26.2 和 26.3)的统一平台 API。

1 本站下载 0 关注 更新于 3 周前

最新 3.0.0+neoforge-26.3 · 26.3 · NeoForge

一键开服(送7天)

Jauml 3.0

NightBeam 模组背后的公共库

Jauml (Just Another Utility Minecraft Library) 包含了我们多个模组共享的代码:带注释的类型化 JSON 配置文件、带有 tick 调度器的服务器事件,以及面向 Fabric、NeoForge 和 Forge 的统一平台 API。

正在游玩? 如果某个模组要求安装 Jauml,请将对应加载器和 Minecraft 版本的 jar 文件放入你的 mods 文件夹中。它本身不会为游戏添加任何内容。

3.0 版本适用于 Fabric、NeoForge 和 Forge,支持 1.20.1、1.21.1、26.2 和 26.3。基于 Jauml 2.x 构建的模组仍可正常运行。

divider

类型化配置

编写一个类。获取配置文件。

将设置项写为一个普通的 Java 类,并通过 JaumlConfig.bind("my_mod", "common", MyConfig.class) 进行绑定。

  • 文件中的注释。 @Comment 文本、@Range 范围限制、允许的枚举值和默认值会以 // 开头的行写在每个选项上方。玩家也可以添加自己的注释;文件仍能正常加载。
  • 安全加载。 缺失的选项会使用默认值,类型错误的值会被转换或重置,超出范围的数值会被钳制(clamp),并在日志中发出警告。
  • 嵌套结构。 支持来自嵌套类的嵌套部分,以及列表和映射。玩家删除的映射条目将保持删除状态。
  • 实时更新。 提供 reload()、reloadIfChanged()、update(...) 和变更监听器。运行期间损坏的文件会保留上一组有效值;启动前损坏的文件会被移至 .bak 并重设为默认值。
  • 迁移机制。 在绑定之前执行迁移逻辑,因此重命名或移动的选项会正确继承。

服务器事件

在所有加载器上挂钩服务器

  • ServerEvents: 包括服务器启动、已启动、停止中、已停止、tick 开始和 tick 结束事件,适用于专用服务器和单人游戏服务器。ServerEvents.currentServer() 返回当前运行的服务器实例。
  • PlayerEvents: 玩家加入和离开事件。
  • Scheduler: runLater、runRepeating 和 queueServerWork(即 MCreator 工作队列,含义相同),始终在服务端线程上执行。当服务器停止时,待处理的任务会被丢弃。
  • 单个监听器即可兼容 Fabric、NeoForge 和 Forge。启动服务器时使用 -Djauml.selfTest=true 可在日志中查看所有事件;上方的卡片展示了 NeoForge 26.3 启动时的日志示例。

平台适配

一套 API。三种加载器。

  • Services.load(IMyHelper.class) 可加载你针对特定加载器实现的服务类,从而允许你从模组中删除多加载器版本的 Services 类副本。
  • Platform: 提供加载器类型、物理客户端或专用服务器标识、开发环境信息、游戏目录与配置目录路径、Minecraft 版本号,以及任何已加载模组的版本和名称。
  • 感知版本的集成: Platform.isModLoaded("geckolib", ">=4.4") 和 Platform.isMinecraft(">=26.2")。

JSON 工具包

你已有的所有配置

2.x 的配置 API 全部保留在此处:

  • ConfigFile 通过 JaumlConfig.open(...) 提供:类型安全的 getter、点路径访问(如 server.port 或 users[0].name)、列表支持、原子保存、更改时重载以及损坏文件的备份功能。
  • JsonSchema 用于类型、范围、枚举、长度和必填键的检查,JsonMigrator 用于版本升级迁移,JsonLib 用于安全解析、深度合并、标准化和稳定输出。
  • JaumlConfigLib 是旧版模组调用的静态辅助方法集合,保留了整个 3.x 系列的所有方法和签名。

实用工具

你反复重写的辅助方法

  • Cooldowns: 支持按玩家(或任意对象)计算的冷却时间,基于真实世界时钟时间或服务器 tick 数。
  • Version 和 VersionRange: 支持比较 1.20.1、26.3.0.95-beta 或 0.165.0+26.3,并检查以 [2.1,3)、>=2.1 <3、~2.3、^2、1.x 或 a || b 等形式编写的版本范围。
  • Event: 一个小型监听器列表,支持为你自定义的事件设置优先级。

下载与兼容性

每个版本。每种加载器。

Minecraft Loaders Java 还需安装
1.20.1 Fabric, Forge 17 Fabric API (Fabric, 推荐)
1.21.1 Fabric, NeoForge 21 Fabric API (Fabric, 推荐)
26.2 · 26.3 Fabric, NeoForge 25 Fabric API (Fabric, 推荐)
  • 下载与你的加载器和 Minecraft 版本匹配的文件,例如 jauml-fabric-26.3-3.0.0.jar。
  • 将其安装在需要它的模组所在的目录:客户端、服务器或两者皆可。
  • 在 Fabric 上,配置文件无需 Fabric API 即可工作;服务器事件和调度器需要 Fabric API,若缺失 Jauml 会记录警告。1.20.1 的 Fabric 需要 Fabric Loader 0.16.10 或更高版本。
  • 从 2.x 更新: 替换旧的 jar 文件即可。你的配置文件及依赖它们的模组将继续正常工作。
  • Minecraft 1.21.11 或 26.1.2? 请继续使用 Jauml 2.3.1;3.0 未针对这些版本构建。

入门指南

Jauml 托管在 Modrinth Maven 上。请使用「版本」选项卡中显示的版本号,该版本号以你的加载器名称和 Minecraft 版本号结尾:

repositories {
    maven { url = "https://api.modrinth.com/maven" }
}

dependencies {
    // Fabric 1.20.1 / 1.21.1 以及 Forge 1.20.1 的 remap 模组 jar 包:
    modImplementation "maven.modrinth:jauml:3.0.0+fabric-1.21.1"
    // NeoForge,以及 26.x 版本的 Fabric(未混淆):
    implementation "maven.modrinth:jauml:3.0.0+neoforge-26.3"
}

然后在 fabric.mod.json("jauml": ">=3.0.0")或 neoforge.mods.toml / mods.toml(versionRange = "[3.0.0,)")中声明它。迁移指南 提供了每个 API 的详细示例。

常见问题

Jauml 会独立运行吗? 不会。它是一个库:仅在开发环境中加载、写入一个小型演示配置文件,并等待使用它的模组。

服务端和客户端都需要安装它吗? 在安装依赖它的模组的位置安装即可。Jauml 本身不会通过网络发送任何数据。

我为 Jauml 2.x 构建的模组还能正常工作吗? 可以。3.0 版没有移除 2.x 版的任何内容,也没有改变任何签名;构建过程中的一项测试会锁定所有已发布模组调用的方法。

配置文件在哪里? 在你的 config 文件夹下,位于各个模组选择的子文件夹中,例如 config/my_mod/common.json。

文档在哪里? 源码与说明 · 迁移指南 · 更新日志 · 路线图 · 问题反馈

我可以联系你吗? Discord · YouTube · Modrinth 上的更多 NightBeam 模组 和 CurseForge · 支持我们


Jauml 采用 Apache-2.0 许可证授权。由 NightBeam Studio 制作。

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

评论 0

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

登录后参与评分

还没有评论,来抢沙发吧

评论配图

相似资源