自定义物品模型

自定义物品模型

现在支持物品的自定义模型和动画

装饰

CIM | 自定义物品模型

English

使用简单的原版风格“JSON”为完全自定义的动画物品模型添加支持


需要的前置模组

工作原理
#1 模型注册

在你的资源包命名空间中创建文件 cim_models.json,路径为 assets/<namespace>/cim_models.json(不要使用 cim 命名空间!)

然后写入以下内容:

{
    "entries": [
        // 条目列表
    ]
}

向 entries 中添加一个新元素,结构如下:

{
    "items": [ /* `item_id` 列表 */ ],
    "components": { /* 组件过滤器 */ },
    "mode": /* 组件过滤模式:any | all | only */,
    "model": /* 模型 ID */
}

其中:

  • items — 用于过滤物品的物品 ID 列表。
    • 要将模型应用到所有物品,请使用“all”。
  • components — 用于按组件过滤物品的 JSON 对象。
    • 要不考虑组件直接应用模型,请省略此字段。
  • mode — 控制组件过滤器的应用方式。
    • any — 物品必须包含所列组件中的至少一个。
    • all — 物品必须包含所有所列组件。其他组件会被忽略。
    • only — 物品必须只包含所列组件,不能包含其他组件。
  • model — 模型位置。
    • 格式:namespace:folder_name,其中 folder_name 是 cim_models 内的目录。
#2 模型属性设置

如果你只需要替换模型和/或动画,folder_name 目录中必须存在以下文件:

/cim_models/<model_id>/
|- model.geo.json  | 物品模型文件
|- texture.png     | 模型纹理
|- animations.json | 模型动画(可选)
\- display.json    | 模型显示变换(可选)

你必须使用这些确切的文件名。

否则,如果你需要更详细的模型配置,必须在 /cim_models/<model_id>/properties.json 创建 properties.json 文件,内容如下:

{
    "name": /* 模型名称(当前未使用) */,
    "authors": /* 作者列表(当前未使用) */,

    "disable_ground_bobbing": true,   // 禁用物品漂浮(上下移动)
    "disable_ground_spinning": true,  // 禁用物品在地面上的旋转

    "display_context": {
        /* item_display_context 与 cim_profile 之间的映射 */
    }
}

display_context 字段为等于 none 的 item_display_context 定义默认 profile:

"none": { // 你可以覆盖它
    "model": "./model.geo.json",
    "texture": "./texture.png",
    "animations": "./animations.json",
    "display": "./display.json"
}

其中:

  • model — 模型资源路径。本地资源请使用 ./ 前缀。
  • texture — 模型纹理路径。本地资源请使用 ./ 前缀。
  • animations — 动画文件路径。可选。本地资源请使用 ./ 前缀。
  • display — 显示变换文件路径。可选。本地资源请使用 ./ 前缀。

对于其他上下文,不必完整重写 profile,只需在 profile 中指定必要参数即可。其余参数将从 none 上下文获取。




Русский

通过普通“JSON”为完整自定义且可动画的物品模型添加支持


模组依赖

工作原理
#1 模型注册

在你的资源包中按路径 assets/<mod_id>/cim_models.json 创建文件 cim_models.json(不要使用 cim 作为 mod_id)

然后写入以下内容:

{
    "entries": [
        // 条目列表
    ]
}

向 entries 列表中添加一个新元素,结构如下:

{
    "items": [ /* `item_id` 列表 */ ],
    "components": { /* 组件过滤器 */ },
    "mode": /* 组件过滤模式:any | all | only */,
    "model": /* `model_id` */
}

其中:

  • items — 用于过滤的物品(item_id)列表。
    • 指定“all”可替换所有物品的模型。
  • components — 用于按组件过滤物品的 JSON 对象。
    • 如果需要在无论是否存在组件的情况下替换模型,请不要指定此参数。
    • mode — 组件过滤模式。
    • any — 物品必须包含所列组件中的任意一个。
    • all — 物品必须包含所有所列组件。其余组件会被忽略。
    • only — 物品必须只包含所列组件。如果缺少至少一个或存在多余组件—— 物品会被忽略。
  • model — 模型标识符。
    • 格式:<namespace/mod_id>:<folder_name>,其中 folder_name 是 cim_models/ 内目录的名称。
#2 模型属性设置

如果只需要替换模型和/或动画,folder_name 目录中必须存在以下文件:

/cim_models/<model_id>/
|- model.geo.json   | 物品模型文件
|- texture.png      | 模型纹理
|- animations.json  | 模型动画(可选)
\- display.json     | 显示变换(可选)

必须使用这些确切的文件名。

否则,如果需要更详细的模型配置,必须按路径 /cim_models/<model_id>/properties.json 创建 properties.json 文件,内容如下:

{
    "name": /* 模型名称(当前未使用) */,
    "authors": /* 作者列表(当前未使用) */,

    "disable_ground_bobbing": true,   // 禁用物品“悬浮”(上下移动)
    "disable_ground_spinning": true,  // 禁用地面上物品的旋转

    "display_context": {
        /* item_display_context 与 cim_profile 之间的映射 */
    }
}

display_context 字段为等于 none 的 item_display_context 设置默认 profile:

"none": { // 你可以覆盖它
    "model": "./model.geo.json",
    "texture": "./texture.png",
    "animations": "./animations.json",
    "display": "./display.json"
}

其中:

  • model — 模型资源路径。对于本地资源请使用前缀 ./。
  • texture — 模型纹理路径。对于本地资源请使用前缀 ./。
  • animations — 动画文件路径。可选参数。本地资源请使用 ./。
  • display — 显示变换文件路径。可选参数。本地资源请使用 ./。

对于其他上下文,不必完全逐字重写 profile,只需在 profile 中指定所需参数即可。其余参数将从 none 上下文获取。