Ratatouille

repositories {
    maven {
        name = 'Ladysnake Mods'
        url = 'https://maven.ladysnake.org/releases'
}

dependencies {
    modImplementation "dev.doctor4t:ratatouille:${project.ratatouille_version}"
}

此工具允许你通过一次方法调用（以及游戏需要知道你希望渲染什么的自定义模型）轻松注册使用自定义模型的新盔甲套装。

第 1 步：定义模型

在添加自定义盔甲之前，我们需要一个遵守一些规则的模型。你可以在仓库的 RESOURCES 文件夹中找到盔甲模板模型（Blockbench 模型文件）和纹理。虽然你可以自由编辑此模型和纹理来塑造梦想中的盔甲，但请注意现有的分组非常重要，虽然你可以向它们添加新的子组，但不能也不应删除任何现有分组，因为它们让库知道在玩家（或盔甲架或生物）穿上盔甲部件时应该显示什么：

• 装备头盔物品时显示 helmet
• 装备胸甲物品时显示 body_chestplate、right_arm_chestplate 和 left_arm_chestplate
• 装备护腿物品时显示 body_leggings、right_leg_leggings 和 left_leg_leggings
• 装备靴子物品时显示 right_leg_boot 和 left_leg_boot

模型完成后，你可以使用 Blockbench 导出：File -> Export -> Export Java Entity。打开生成的 Java 类，复制 getTexturedModelData() 中 ModelPartData modelPartData = modelData.getRoot(); 到 return 前一行（包括）之间的代码。Ratatouille 添加了一种简化盔甲模型定义的新模型类类型，称为 CustomArmorModelDefinition；扩展该类，并通过粘贴你从生成的模型类中复制的代码片段来实现 addModelParts 方法。然后实现 getTexture()；最简单的方式是在你的模型定义类中为盔甲纹理设置一个静态 Identifier 并返回它，但如果你希望使用特殊逻辑来改变返回的纹理，自然也可以这样做。

第 2 步：使用 Ratatouille 注册自定义盔甲

第二步也是最后一步，是在你的客户端初始化代码中注册自定义盔甲渲染。调用 CustomModelArmorUtil.registerCustomArmor 并提供所需参数：

• Identifier id：自定义盔甲的 id。它用于自动生成和注册你的盔甲模型层，因此应该是唯一的。
• ArmorDisplayConditions displayConditions：你的盔甲部件渲染所需满足的显示条件。如果你想要一个简单的盔甲，为每个装备的物品显示其部件，ItemSetDisplayConditions 允许你定义头盔、胸甲、护腿和靴子物品，并自动检查哪些盔甲物品已装备并需要显示，同时防止以缺失纹理的香草盔甲模型渲染。如果你希望有自定义逻辑来显示不同部件，而不仅仅是检查物品是否穿着，你可以实现 ArmorDisplayConditions 及其四个 shouldDisplay 方法。
• CustomArmorModelDefinition armorModelDefinition：我们在第 1 步中创建的模型定义，只需创建它的新实例即可。
• int textureWidth, int textureHeight：盔甲纹理的宽度和高度。

通过此方法调用注册你的盔甲将为你处理一切，例如创建带纹理的模型数据、模型层以及将特性附加到玩家 / 盔甲架 / 生物渲染器上。如果你需要访问盔甲的模型数据或模型层，可以在 CustomModelArmorUtil.CUSTOM_ARMOR_MODELS HashMap 中使用盔甲的 displayConditions 作为键找到它们。

注册背景环境音

要注册背景环境音，你只需在你的客户端初始化类中调用 AmbienceUtil.registerBackgroundAmbience 方法，并传入一个带有以下参数的新的 BackgroundAmbience 对象：

• SoundEvent soundEvent：要播放的环境循环音效。
• SoundCategory soundCategory：播放声音的音频类别。
• PlayPredicate predicate：决定是否允许播放声音的谓词。接收一个 ClientPlayerEntity 并必须返回一个布尔值。
• int fadeIn：环境循环开始播放时的淡入时间（以刻为单位）。
• int fadeOut：环境循环停止播放时的淡出时间（以刻为单位）。

注册方块实体环境音

要注册方块实体环境音，你只需在你的客户端初始化类中调用 AmbienceUtil.registerBlockEntityAmbience 方法，并传入应播放该环境音的 BlockEntityType<? extends BlockEntity> 和一个带有以下参数的新的 BlockEntityAmbience 对象：

• SoundEvent soundEvent：要播放的环境循环音效。
• SoundCategory soundCategory：播放声音的音频类别。
• PlayPredicate predicate：决定是否允许播放声音的谓词。接收一个 BlockEntity 并必须返回一个布尔值。
• int fadeIn：环境循环开始播放时的淡入时间（以刻为单位）。
• int fadeOut：环境循环停止播放时的淡出时间（以刻为单位）。