Update documentation

This commit is contained in:
Sollace 2024-12-16 22:01:12 +01:00
parent 306567e5ff
commit 93354a6783
No known key found for this signature in database
GPG key ID: E52FACE7B5C773DB

View file

@ -20,17 +20,22 @@ import java.util.stream.Stream;
/** /**
* The default texture resolver used by Mine Little Pony. * The default texture resolver used by Mine Little Pony.
* <p> * <p>
* Textures found are of the format: * Textures are resolved by taking the original path and replacing "humanoid" with "ponified".
* <p> * <p>
* namespace:textures/models/armor/material_layer_[outer|1|inner|2](_overlay)(_custom_#)(_pony).png * For example:
* <p> *
* <p> * assets/minecraft/textures/entity/equipment/humanoid/iron.png
* - Textures ending _pony are returned first if found * Becomes: assets/minecraft/textures/entity/equipment/ponified/iron.png
* - _custom_# corresponds to a CustomModelData NBT integer value on the item passed, if available *
* - _overlay is used for the second layer of leather armour, or mods if they make use of it. Can be anything! Check your mod's documentation for values supported. * assets/minecraft/textures/entity/equipment/humanoid_leggings/iron.png
* - outer|1|inner|2 is the layer. outer is an alias for 1 and inner is an alias for 2. Named versions are used instead of numbers if available. * Becomes: assets/minecraft/textures/entity/equipment/ponified_leggings/iron.png
* - the "minecraft" namespace is always replaced with "minelittlepony"
* <p> * <p>
* In addition to the above, unlike in vanilla, all pony armour pieces make use of both the regular and leggings textures to show in two different layers.
* In general, the textures are distributed as follows:
* Helmet = ponified_leggings
* Chestplate = ponified (banner) + ponified_leggings (body plates)
* Leggings = ponified_leggings (leg chainmail)
* Boots = ponified (knee guards and boots)
*/ */
public class ArmourTextureResolver implements ArmourTextureLookup, IdentifiableResourceReloadListener { public class ArmourTextureResolver implements ArmourTextureLookup, IdentifiableResourceReloadListener {
public static final Identifier ID = MineLittlePony.id("armor_textures"); public static final Identifier ID = MineLittlePony.id("armor_textures");