Fabric Wiki

User Tools

Site Tools

Trace:
tutorial:shield

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision		Previous revision
tutorial:shield [2023/12/17 01:07] – finally updated this page cringestar_boitutorial:shield [2024/01/14 18:05] (current) – fixed model cringestar_boi
Line 1: Line 1:
-====== Making a Custom Shield in Minecraft [1.20] ======+====== Making a Custom Shield in Minecraft [1.19-1.20] ======
  
 Congrats! You just learned how to create your custom sword in the last tutorial! Now imagine you want to shield yourself from that sword if your friend got it. If you made it too op, a regular shield won't do. So we will see how to make a custom shield.\\  Congrats! You just learned how to create your custom sword in the last tutorial! Now imagine you want to shield yourself from that sword if your friend got it. If you made it too op, a regular shield won't do. So we will see how to make a custom shield.\\ 
-Luckily, CrimsonDawn45 has already made a library to help with this! If he didn't, you probably would be sitting here for the next hour to follow this tutorial, so thanks CrimsonDawn45!+Luckily, StellarWind22 has already made a library to help with this! If she didn't, you probably would be sitting here for the next hour following this tutorial, so thanks StellarWind22!
  
-Library source is available at https://github.com/CrimsonDawn45/Fabric-Shield-Lib+The library source is available at https://github.com/CrimsonDawn45/Fabric-Shield-Lib
  
 Library compiled as a jar is available at https://www.curseforge.com/minecraft/mc-mods/fabric-shield-lib Library compiled as a jar is available at https://www.curseforge.com/minecraft/mc-mods/fabric-shield-lib
Line 29: Line 29:
 </code>\\  </code>\\ 
  
-At the time of writing, latest project.fabric_shield_lib_version should be 1.7.2-1.20.4. This page will be updated whenever a new update comes out.\\ \\ +At the time of writing, the latest project.fabric_shield_lib_version should be 1.7.2, which supports versions: 
 +  * **1.20.2** - **1.20.4** (''1.7.2-1.20.4'') 
 +  * **1.20** - **1.20.1** (''1.7.2-1.20.1'') 
 +  * **1.19.3** - **1.19.4** (''1.7.2-1.19.4'') 
 +  * **1.19** - **1.19.2** (''1.7.2-1.19.2'') 
 +  * **1.18.2** (''1.7.2-1.18.2'') 
 +  * **1.17.1** (''1.7.2-1.17.1'')\\ 
 **build.gradle** (inside repositories, the one above dependencies)\\  **build.gradle** (inside repositories, the one above dependencies)\\ 
 <code java> <code java>
Line 37: Line 43:
 </code>\\  </code>\\ 
  
-__//**Midnight Lib and FabricASM are included in FabricShieldLib release (.jar on Curseforge/Modrinth) but need to be used as dependencies when developing**//__+__//**Midnight Lib and FabricASM are included in the FabricShieldLib release (.jar on Curseforge/Modrinth) but need to be used as dependencies when developing**//__
  
 ===== Adding a custom shield ===== ===== Adding a custom shield =====
-**If you want your shield to support banner decoration on your shield, there are extra steps that will be covered after the main creation.(STILL BEING REMADE)**\\+**If you want your shield to support banner decoration on your shield, please skip to the next section**\\
 On to the non-boring steps! We will now make a custom shield!\\ \\  On to the non-boring steps! We will now make a custom shield!\\ \\ 
-If you have followed the above steps correctly and refreshed the project, then you will have the fabric shield api installed.\\ +If you have followed the above steps correctly and refreshed the project, then you will have the FabricShieldLib installed.\\ 
 If so, the first step to do is create a new instance of an Item like: If so, the first step to do is create a new instance of an Item like:
 <code java> <code java>
Line 89: Line 95:
 <code javascript> <code javascript>
 { {
-  "parent": "fabricshieldlib:item/fabric_shield_blocking"+  "parent": "fabricshieldlib:item/fabric_shield_blocking", 
 +  "textures":{ 
 +    "shield":"examplemod:item/netherite_shield" 
 +  }
 } }
 </code>\\  </code>\\ 
Line 109: Line 118:
 } }
 </code>\\  </code>\\ 
-And with that, your shield is done!+And with that, your non-decorateable shield is done! 
 + 
 +===== Adding a custom shield with banner support ===== 
 +The process is slightly different if you want to make your shield accept banners and decorateable like a vanilla shield. 
 + 
 +We still make the item in the same way, just make it a FabricBannerShieldItem: 
 +<code java> 
 +public static final Item NETHERITE_BANNER_SHIELD = new FabricBannerShieldItem(new FabricItemSettings().maxDamage(2500), 10, 13, Items.NETHERITE_INGOT); // FabricBannerShieldItem(settings.maxDamage(durability), cooldownTicks, enchantability, repairItems) 
 +</code> 
 + 
 +Then, we have to register it: 
 +  
 +<code java> 
 +Registry.register(Registries.ITEM, new Identifier("examplemod", "netherite_banner_shield"), NETHERITE_BANNER_SHIELD); 
 +</code> 
 + 
 +If you want to add your shield to a creative tab, add this into your ''onInitialize()'' method: 
 +<code java> 
 +ItemGroupEvents.modifyEntriesEvent(ItemGroups.COMBAT).register(entries -> { 
 + entries.addAfter(Items.SHIELD,NETHERITE_BANNER_SHIELD); 
 +}); 
 +</code> 
 + 
 +Now the item is created, we need to set up its rendering. For these steps, we are going to be working in our client mod initializer, which should already be set up for you in the fabric example mod. 
 + 
 + 
 +First, we will need to create an ''EntityModelLayer'' to use later. 
 +<code java> 
 +public class ExampleModClient implements ClientModInitializer { 
 + 
 +    public static final EntityModelLayer netherite_banner_shield_model_layer = new EntityModelLayer(new Identifier("examplemod", "netherite_banner_shield"),"main"); 
 + 
 +    @Override 
 +    public void onInitializeClient() { 
 +     
 +    } 
 +} 
 +</code> 
 + 
 +Next, we will register out ''EntityModelLayer'' that we made previously.  
 + 
 +<code java> 
 +public class ExampleModClient implements ClientModInitializer { 
 + 
 +    public static final EntityModelLayer NETHERITE_SHIELD_MODEL_LAYER = new EntityModelLayer(new Identifier("examplemod", "netherite_shield"),"main"); ​ 
 + 
 +    @Override 
 +    public void onInitializeClient() { 
 + EntityModelLayerRegistry.registerModelLayer(netherite_banner_shield_model_layer, ShieldEntityModel::getTexturedModelData); 
 +    } 
 +} 
 +</code> 
 + 
 +Then we will create our shield model, 
 + 
 +<code java> 
 +public class ExampleModClient implements ClientModInitializer { 
 + 
 +    public static final EntityModelLayer NETHERITE_SHIELD_MODEL_LAYER = new EntityModelLayer(new Identifier("examplemod", "netherite_shield"),"main"); ​ 
 +     
 +    public static ShieldEntityModel modelNetheriteShield; 
 + 
 +    @Override 
 +    public void onInitializeClient() { 
 +        EntityModelLayerRegistry.registerModelLayer(NETHERITE_SHIELD_MODEL_LAYER, ShieldEntityModel::getTexturedModelData); 
 +    } 
 +} 
 +</code> 
 + 
 +And then register that shield model, 
 + 
 +<code java> 
 +public class ExampleModClient implements ClientModInitializer { 
 + 
 +    public static final EntityModelLayer NETHERITE_SHIELD_MODEL_LAYER = new EntityModelLayer(new Identifier("examplemod", "netherite_shield"),"main"); ​ 
 +     
 +    public static ShieldEntityModel modelNetheriteShield; 
 + 
 +    @Override 
 +    public void onInitializeClient() { 
 +        EntityModelLayerRegistry.registerModelLayer(NETHERITE_SHIELD_MODEL_LAYER, ShieldEntityModel::getTexturedModelData); 
 +         
 +        ShieldSetModelCallback.EVENT.register((loader) -> { 
 +     modelNetheriteShield = new ShieldEntityModel(loader.getModelPart(netherite_banner_shield_model_layer)); 
 +     return ActionResult.PASS; 
 + }); 
 +    } 
 +} 
 +</code> 
 + 
 +Next, we have to create our two ''SpriteIdentifiers'', 
 +<code java> 
 +public class ExampleModClient implements ClientModInitializer { 
 + 
 + public static final EntityModelLayer netherite_banner_shield_model_layer = new EntityModelLayer(new Identifier("examplemod", "netherite_banner_shield"),"main"); 
 + 
 + public static ShieldEntityModel modelNetheriteShield; 
 + 
 + public static final SpriteIdentifier NETHERITE_BANNER_SHIELD_BASE = new SpriteIdentifier(SpriteAtlasTexture.BLOCK_ATLAS_TEXTURE, new Identifier("examplemod", "entity/netherite_banner_shield_base")); 
 + public static final SpriteIdentifier NETHERITE_BANNER_SHIELD_BASE_NO_PATTERN = new SpriteIdentifier(SpriteAtlasTexture.BLOCK_ATLAS_TEXTURE, new Identifier("examplemod", "entity/netherite_banner_shield_base_nopattern")); 
 + 
 + @Override 
 + public void onInitializeClient() { 
 +            EntityModelLayerRegistry.registerModelLayer(NETHERITE_SHIELD_MODEL_LAYER, ShieldEntityModel::getTexturedModelData); 
 +         
 +            ShieldSetModelCallback.EVENT.register((loader) -> { 
 +         modelNetheriteShield = new ShieldEntityModel(loader.getModelPart(netherite_banner_shield_model_layer)); 
 +         return ActionResult.PASS; 
 +     }); 
 + } 
 +} 
 +</code> 
 + 
 +Finally, we are going to register our shield with the ''BuiltinItemRendererRegistry'', 
 +<code java> 
 +public class ExampleModClient implements ClientModInitializer { 
 + 
 + public static final EntityModelLayer netherite_banner_shield_model_layer = new EntityModelLayer(new Identifier("examplemod", "netherite_banner_shield"),"main"); 
 + 
 + public static ShieldEntityModel modelNetheriteShield; 
 + 
 + public static final SpriteIdentifier NETHERITE_BANNER_SHIELD_BASE = new SpriteIdentifier(SpriteAtlasTexture.BLOCK_ATLAS_TEXTURE, new Identifier("examplemod", "entity/netherite_banner_shield_base")); 
 + public static final SpriteIdentifier NETHERITE_BANNER_SHIELD_BASE_NO_PATTERN = new SpriteIdentifier(SpriteAtlasTexture.BLOCK_ATLAS_TEXTURE, new Identifier("examplemod", "entity/netherite_banner_shield_base_nopattern")); 
 + 
 + @Override 
 + public void onInitializeClient() { 
 +            EntityModelLayerRegistry.registerModelLayer(NETHERITE_SHIELD_MODEL_LAYER, ShieldEntityModel::getTexturedModelData); 
 +         
 +            ShieldSetModelCallback.EVENT.register((loader) -> { 
 +         modelNetheriteShield = new ShieldEntityModel(loader.getModelPart(netherite_banner_shield_model_layer)); 
 +         return ActionResult.PASS; 
 +     }); 
 +  
 +            BuiltinItemRendererRegistry.INSTANCE.register(ExampleMod.NETHERITE_BANNER_SHIELD, (stack, mode, matrices, vertexConsumers, light, overlay) -> { 
 + renderBanner(stack, matrices, vertexConsumers, light, overlay, modelNetheriteShield, NETHERITE_BANNER_SHIELD_BASE, NETHERITE_BANNER_SHIELD_BASE_NO_PATTERN); 
 +                //The first five parameters are taken from the method, while the last 3 you provide yourself. You will provide the model, and then your 2 sprite identifiers in the order of SHIELD_NAME_BASE and then SHIELD_NAME_BASE_NOPATTERN. 
 +     }); 
 + } 
 +} 
 +</code>\\ 
 + 
 +That is all of our code done, we only have a few .json files to make. \\ 
 + 
 +First, create a ''blocks.json'' file inside of ''resources/assets/minecraft/atlases/''. 
 + 
 +Inside of it, you will have to list your ''SpriteIdentifiers'' from your client mod initializer like this: 
 +<code javascript> 
 +{ 
 +  "sources": [ 
 +    { 
 +      "type": "single", 
 +      "resource": "examplemod:entity/netherite_banner_shield_base" 
 +    }, 
 +    { 
 +      "type": "single", 
 +      "resource": "examplemod:entity/netherite_banner_shield_base_nopattern" 
 +    } 
 +  ] 
 +} 
 +</code> 
 + 
 +Next, inside ''resources/assets/examplemod/models/item/'', create a ''netherite_banner_shield.json'' file and put this inside it:\\  
 + 
 +<code javascript> 
 +{ 
 +  "parent":"fabricshieldlib:item/fabric_banner_shield", 
 +  "overrides": [ 
 +    { 
 +      "predicate": { 
 +        "blocking": 1 
 +      }, 
 +      "model": "examplemod:item/netherite_banner_shield_blocking" 
 +    } 
 +  ] 
 +} 
 +</code>\\  
 + 
 +In the same folder, create another file, ''netherite_banner_shield_blocking.json'', and put his inside it:  
 +<code javascript> 
 +{ 
 +  "parent":"fabricshieldlib:item/fabric_banner_shield_blocking", 
 +  "textures":{ 
 +    "shield":"examplemod:item/netherite_shield" 
 +  } 
 +} 
 +</code>\\  
 + 
 +For this next step, you will add a ''netherite_shield_base_nopattern'' texture, which will be a standard shield texture. 
 +Then, you will need to make a ''base'' version for your shield texture, so ''netherite_shield_base''. I recommend looking at the vanilla shield's ''base'' texture. 
 + 
 +Then, you will move both of these textures into ''resources/assets/<modid>/textures/entity''. 
 + 
 +Lastly, create a ''shields.json'' file in ''resources/data/c/tags/items/shields.json'' and add your shield to it: 
 +<code javascript> 
 +{ 
 +  "replace": false, 
 +  "values": [ 
 +    "examplemod:netherite_banner_shield" 
 +  ] 
 +} 
 +</code>\\  
 + 
 +Don't forget to add it to **en_us.json** in ''resources/assets/lang/en_us.json'' along with the color variants,\\  
 +<code javascript> 
 +{ 
 +  "item.examplemod.netherite_banner_shield": "Netherite Banner Shield", 
 +  "item.examplemod.netherite_banner_shield.red": "Red Netherite Banner Shield", 
 +  "item.examplemod.netherite_banner_shield.orange": "Orange Netherite Banner Shield", 
 +  "item.examplemod.netherite_banner_shield.yellow": "Yellow Netherite Banner Shield", 
 +  "item.examplemod.netherite_banner_shield.lime": "Lime Netherite Banner Shield", 
 +  "item.examplemod.netherite_banner_shield.green": "Green Netherite Banner Shield", 
 +  "item.examplemod.netherite_banner_shield.light_blue": "Light Blue Banner Netherite Shield", 
 +  "item.examplemod.netherite_banner_shield.cyan": "Cyan Netherite Banner Shield", 
 +  "item.examplemod.netherite_banner_shield.blue": "Blue Netherite Banner Shield", 
 +  "item.examplemod.netherite_banner_shield.purple": "Purple Netherite Banner Shield", 
 +  "item.examplemod.netherite_banner_shield.magenta": "Magenta Netherite Banner Shield", 
 +  "item.examplemod.netherite_banner_shield.pink": "Pink Netherite Banner Shield", 
 +  "item.examplemod.netherite_banner_shield.brown": "Brown Netherite Banner Shield", 
 +  "item.examplemod.netherite_banner_shield.white": "White Netherite Banner Shield", 
 +  "item.examplemod.netherite_banner_shield.light_gray": "Light Gray Netherite Banner Shield", 
 +  "item.examplemod.netherite_banner_shield.gray": "Gray Netherite Banner Shield", 
 +  "item.examplemod.netherite_banner_shield.dark_gray": "Dark Gray Netherite Banner Shield", 
 +  "item.examplemod.netherite_banner_shield.black": "Black Netherite Banner Shield" 
 +} 
 +</code> 
 + 
 +And now your shield is fully completed and supports banner decoration! 
 + 
 +===== Changes for 1.19 ===== 
 +If you are working in 1.19, make sure to change the FabricShieldLib and FAPI versions accordingly as well as changing your Midnight Lib and Mod Menu dependencies to these versions:\\ 
 +**gradle.properties** 
 +<code java> 
 +midnightlib_version=1.0.0-fabric 
 +mod_menu_version=4.2.0-beta.2 
 +</code>
tutorial/shield.1702775249.txt.gz · Last modified: 2023/12/17 01:07 by cringestar_boi