Ratatouille

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

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

This util allows you to easily register new armor sets that use a custom model with a single method call (and that custom model as the game does need to know what you wish to render).

Step 1: Defining the model

Before we can add our custom armor, we need a model that respects a few rules. You can find an armor template model (Blockbench model file) and texture in the RESOURCES folder of the repository. While you can edit this model and texture freely in order to shape up the armor of your dreams, please note that the existing groups are very important and while you can add new sub-groups to them, you cannot and should not delete any existing group as they allow the library to know what should be displayed when a player (or armor stand or mob) dons armor pieces:

• helmet displays when the helmet item is equipped
• body_chestplate, right_arm_chestplate and left_arm_chestplate display when the chestplate item is equipped
• body_leggings, right_leg_leggings and left_leg_leggings display when the leggings item is equipped
• right_leg_boot and left_leg_boot display when the boots item is equipped

Once you have finalized your model, you can export it with Blockbench: File -> Export -> Export Java Entity. Open the generated Java class and copy the lines between ModelPartData modelPartData = modelData.getRoot(); and the line right before the return (included) in getTexturedModelData(). Ratatouille adds a new model class type that simplifies armor model definition called CustomArmorModelDefinition; extend that class and implement the addModelParts method by pasting the snippet you copied from the generated model class. Then implement getTexture(); the simplest way to do so is to have a static Identifier for your armor texture in your Model Definition class and return that, but if you wish to do a special logic that varies the returned texture you can naturally do so as well.

Step 2: Registering the custom armor with Ratatouille

The second - and last - step is to register your custom armor rendering in your client initialization. Call CustomModelArmorUtil.registerCustomArmor and give it the required parameters:

• Identifier id: The id of the custom armor. This is used in order to automatically generate and register the model layer of your armor, it should therefore be unique.
• ArmorDisplayConditions displayConditions: The display conditions that need to be met for your armor parts to render. If you want a simple armor that displays its parts for each item you equip, the ItemSetDisplayConditions allows you to define the helmet, chestplate, leggings and boots items and will automatically check which armor items are equipped and need to be displayed, as well as prevent the rendering of the vanilla armor model with a missing texture. If you wish to have a custom logic for displaying different pieces that is not just checking whether the item is being worn, you can implement the ArmorDisplayConditions and its four shouldDisplay methods.
• CustomArmorModelDefinition armorModelDefinition: The model definition we created in Step 1, simply create a new instance of it.
• int textureWidth, int textureHeight: The armor's texture width and height.

Registering your armor through this method call will take care of everything for you, like creating the textured model data, model layer and appending the feature to the player / armor stand / mob renderers. If you need to access the model data or model layer of the armor, you can find them in the CustomModelArmorUtil.CUSTOM_ARMOR_MODELS HashMap by using the armor's displayConditions as the key.

Registering background ambience

To register a background ambience, all you need to do is call the AmbienceUtil.registerBackgroundAmbience method in your client initializer class and give it a new BackgroundAmbience object with the required parameters:

• SoundEvent soundEvent: The ambient loop sound to play.
• SoundCategory soundCategory: The audio category to play the sound in.
• PlayPredicate predicate: The predicate determining whether the sound is allowed to play or not. Takes a ClientPlayerEntity and must return a boolean.
• int fadeIn: The fade-in time of the ambient loop when it starts playing (in ticks).
• int fadeOut: The fade-out time of the ambient loop when it stops playing (in ticks).

Registering Block entity ambience

To register a block entity ambience, all you need to do is call the AmbienceUtil.registerBlockEntityAmbience method in your client initializer class and give it the BlockEntityType<? extends BlockEntity> that should play said ambience and a new BlockEntityAmbience object with the required parameters:

• SoundEvent soundEvent: The ambient loop sound to play.
• SoundCategory soundCategory: The audio category to play the sound in.
• PlayPredicate predicate: The predicate determining whether the sound is allowed to play or not. Takes a BlockEntity and must return a boolean.
• int fadeIn: The fade-in time of the ambient loop when it starts playing (in ticks).
• int fadeOut: The fade-out time of the ambient loop when it stops playing (in ticks).