不精确CIT

不精确CIT

为原版条件模型系统添加CIT风格的正则表达式匹配。

装饰

恢复基于模式的条件物品模型。

用途

自定义物品纹理(CIT)模组最初是 McPatcher 的一部分,后来成为 Optifine 的一部分,它允许替换元数据匹配不精确模式的物品纹理(和模型)。现在,标准 Minecraft 通过条件客户端物品类型提供了近乎等效的物品纹理替换,但不再支持不精确匹配。本模组将基于正则表达式的 CIT 替换添加到新的标准条件物品定义系统中。

兼容性与依赖

  • Minecraft: 1.21.8
  • 加载器: Fabric 0.136.1

不需要 Fabric API。

安装

将模组 JAR 添加到你的 Fabric mods 文件夹。

用法(玩家)

本模组为物品模型定义添加了一项功能,资源包设计者可以使用它。安装模组后,该功能始终处于激活状态。

资源包集成(资源包作者)

位于 assets/minecraft/item 的 JSON 文件是物品定义。它们不一定是用于渲染物品的模型文件(即物品模型),后者位于 assets/minecraft/models/item。

在物品定义文件中,"model" 字段中的 JSON 对象决定使用哪个模型文件来渲染物品。通常,单个物品类型总是使用相同的模型渲染,因此该对象的 "type" 设置为 minecraft:model。但通过使用其他类型的 "model" 对象(例如 minecraft:condition 和 minecraft:select),可以在不同上下文中为同一物品使用不同的模型。

本模组添加了 inexactcit:match 物品定义模型类型。它类似于内置的 select 类型,包含一个带有相关条件的模型列表,当某个条件匹配时,使用其关联的模型来渲染物品。与 Select 不同,Match 的条件是可能不精确的正则表达式。

Match 物品定义模型使用与 Select 相同的字段,特别是 "property"、"component"、"cases" 和 "fallback"。

带标签的字段结构

    { "model":
      { "type": "inexactcit:match"
      , "property":  ...     # 可能始终为 minecraft:component
      , "component": ...     # 要作为目标的组件名称
      , "cases":
        [ { "regex": ...     # 此案例的正则表达式
          , "model": { ... } # 正则表达式匹配时使用的物品定义模型
          }
        , ...                # 另一个案例,如上所述
        , ...                # 任意数量的附加案例
        ]
      , "fallback": { ... }  # 没有案例匹配时使用的物品定义模型
      }
    }

必需字段

正则表达式匹配旨在用于文本元数据,因此 "property" 字段将为 minecraft:component。当 "property" 不是 minecraft:component 时的行为尚未经过测试。

"component" 字段应设置为条件将要测试的组件的命名空间 ID,例如 minecraft:lore、minecraft:custom_name。

"cases" 字段必须包含一个 JSON 对象列表。每个对象应包含一个 "regex" 字段和相应的 "model" 字段。它们必须分别是(Java 风格的)正则表达式和物品定义模型。当正则表达式与 "component" 字段中指定的组件内容匹配时,该物品将使用相应的模型。

"fallback" 字段给出当没有任何 "case" 对象匹配时使用的模型,与标准 Select 相同。

示例

以下是 Match 物品定义的一个示例。它将所有名称中包含 "Quarterstaff" 一词的木锄替换为位于 pixelatedvolume:item/quarterstaff 的模型。

    { "model":
      { "type": "inexactcit:match"
      , "property": "minecraft:component"
      , "component": "minecraft:custom_name"
      , "cases":
        [ { "model":
            { "model": "pixelatedvolume:item/quarterstaff"
            , "type": "minecraft:model"
            }
          , "regex": ".*Quarterstaff.*"
          }
        ]
      , "fallback":
        { "model": "minecraft:item/wooden_hoe"
        , "type": "minecraft:model"
        }
      }
      , "oversized_in_gui": true
    }

文本比较

被检查字段的内容会通过 toString 序列化。文本组件(JSON)特性、章节代码格式等都会被推入这个比较字符串中,因此无法判断游戏中可见文本之前或之后可能有什么内容,也无法判断多行组件各行之间会发生什么。

正则表达式或模型错误

包含格式错误正则表达式的物品定义文件无法读取,因此物品将显示为默认模型(品红色和黑色方块)。失败(连同有问题的文件)会在资源包加载时记录为 Error。

多个目标组件

要为一个物品提供使用不同组件的多条替换规则(例如一组规则用于 lore,另一组用于 custom_name),请将回退模型设置为一个新的 Match 客户端物品模型,该模型选择第二个组件。

状态

匹配 minecraft:component 以外属性的能力最终将会添加。目前,此类匹配会被接受而不会报错,但不会产生任何效果。