ChaEngine 简介
当前版本:1.5.4
ChaEngine 是一套由服务端插件与客户端 Mod 共同工作的模型能力。服务端负责保存配置、判断目标和下发操作,客户端负责读取资源并完成渲染。安装时两端缺一不可。
ChaEngine 能做什么
| 能力 | 适合用来做什么 |
|---|---|
| 方块模型 | 把带有模型数据的载体方块显示成自定义模型,并支持放置、破坏、掉落与动画 |
| 物品模型 | 制作不可放置的自定义物品,可选择直接渲染三维模型或使用带厚度的平面贴图 |
| 物品背景 | 按物品名称或 Lore 匹配品质框、稀有度底图等物品槽背景 |
| 实体模型 | 按实体类型、名称、标签或 NBT 等条件匹配模型,并随实体状态切换动画 |
| 玩家时装 | 把模型绑定到玩家的头部、身体、手臂或腿部,也可临时预览 |
| 模型动画 | 为方块、物品、实体和玩家时装指定默认动画或触发特殊动画 |
| 粒子 | 使用粒子程序组合原版粒子,或加载受支持的基岩版粒子定义 |
| 按键 | 注册客户端按键,并把按下、松开动作交给服务端处理 |
| 相机 | 强制第一/第三人称、调整肩位和距离、限制输入,并播放关键帧场景镜头 |
ChaEngine 提供的是这些基础能力,不预设具体玩法。菜单、任务、技能或活动应由使用 ChaEngine 的插件按自己的业务规则组织。
服务端与客户端如何配合
一次完整运行大致经过以下过程:
- 服务端从
plugins/ChaEngine/读取模型、物品背景、按键、相机预设与场景等 YAML 配置。 - 玩家连接后,服务端把当前可用配置同步给已安装 ChaEngineMod 的客户端。
- 客户端从
resourcepacks/ChaEngine/model/等约定目录读取模型、动画、纹理和粒子资源。 - 服务端发送模型、粒子或相机操作,客户端按已同步的配置渲染或播放镜头。
服务端配置只描述资源路径和运行规则,不会把模型、纹理或动画文件直接传给客户端。因此,加入服务器的每位玩家都需要安装正确版本的 Mod,并提前取得相同的资源。
与 ChaAssets、ChaUI 的关系
- ChaAssets 是可选的资源保护底座。安装对应服务端与客户端组件后,ChaEngine 可以从
.chaassets加密包读取模型和粒子资源;模型配置中的相对路径不需要改变。 - ChaUI 是独立的界面能力。它可以在 ChaEngineMod 存在时调用可选的玩家时装模型预览桥,但不参与 ChaEngine 的模型配置与渲染规则。
只需要普通模型文件时,可以不安装 ChaAssets;不需要模型预览时,也可以不安装 ChaUI。
推荐学习顺序
第一次使用时,建议按下面的顺序阅读:
- 阅读版本兼容,为服务器和客户端选择正确文件。
- 完成服务端安装与客户端安装。
- 了解资源目录,确认配置路径与客户端文件一一对应。
- 从第一个方块模型、第一个物品模型或第一个实体模型中选择一个完成闭环。
- 再按需要阅读物品背景、相机系统、粒子、按键或 Java API 参考。
已经准备好后从哪里开始
如果你已经准备好服务端、客户端和一个模型资源,直接从安装服务端插件开始。遇到模型不显示、连接不同步或资源加载失败时,按故障排查给出的顺序检查。
猹件开发组