Repository navigation
Home zh CN
这份 Wiki 面向希望为模组接入 Just Items Viewer(JIV) 的开发者,介绍如何显示自定义配方、扩展原料搜索、接入容器界面,以及调用运行时 API。
文档基于当前仓库:JIV 0.0.1-alpha-5 / Minecraft 26.1.2 / NeoForge 26.1.2.99 / Java 25。API 包名为 eakerzt.jiv.api,内置配置 API 位于 eakerzt.jiv.config.api。源码中的部分 @since 标记继承自上游,不能当作 JIV 的发行版本号。
| 目标 | 阅读页面 |
|---|---|
| 添加依赖、创建插件并跑通一个配方显示 | 快速开始 |
| 理解插件发现、注册回调与生命周期 | 插件与生命周期 |
| 创建配方类型、分类、槽位和工作站入口 | 配方 API |
| 添加物品变体、子类型、流体、自定义原料和别名 | 原料 API |
| 添加配方点击区、避让侧栏、接受幽灵原料拖拽 | 界面集成 |
| 把背包原料放入机器输入槽,监听转移结果 | 配方转移 |
| 打开配方、设置搜索、管理书签和动态内容 | 运行时 API |
| 替换搜索索引、扩展原版分类和高级行为 | 高级扩展 |
| 使用 JIV 内置配置系统 | 配置 API |
| 排查插件不加载、配方不显示、版本迁移问题 | 常见问题 |
一个集成插件实现 IModPlugin 并标注 @JivPlugin。JIV 发现插件后,将注册对象传入对应的回调方法。注册完成后,通过 onRuntimeAvailable 提供 IJivRuntime;离开世界时通过 onRuntimeUnavailable 通知插件清理引用。
分类负责配方布局,配方数据描述输入和输出,原料类型负责识别、搜索和渲染物品或其他对象。配方转移是额外的容器集成:显示配方本身不会让机器自动获得填充按钮。
优先使用公共 API。common、library、gui 中的实现类及 @ApiStatus.Internal 类型不作为这份教程的集成入口;@ApiStatus.NonExtendable 接口由 JIV 提供,插件应调用它们,而不是自行实现。
JIV 0.0.1-alpha-5 的发布坐标见 Maven Central,完整依赖配置见快速开始。
这些 Markdown 页面同时可在仓库中阅读和维护。发布到 GitHub Wiki 时,将页面文件复制到独立的 Wiki 仓库,并把页面间链接的 .md 后缀移除;_Sidebar.md 是 Wiki 侧栏文件。完整代码同时收录于完整示例页面,便于直接复制使用。