Fabric Wiki

This page is read only. You can view the source, but not change it. Ask your administrator if you think this is wrong.
====== Making a Custom Shield in Minecraft [1.19-1.21.5] ======
:!: The tutorial depends on third-party libraries.

Congrats! You just learned how to create your custom tools 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, 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!

The library source is available at https://github.com/StellarWind22/Fabric-Shield-Lib

Library compiled as a jar is available at https://www.curseforge.com/minecraft/mc-mods/fabric-shield-lib

===== Adding the library to your project =====

Add the following code to the files mentioned:

**gradle.properties**
<file properties gradle.properties>
fabric_shield_lib_version=1.8.3-1.21.5
mod_menu_version=14.0.0
midnightlib_version=1.7.3+1.21.4-fabric
fabricasm_version=2.3
</file>

Find the corresponding mod versions for your Minecraft version

**build.gradle** (under ''dependencies'' block) 
<file groovy build.gradle>
	modImplementation "com.github.StellarWind:Fabric-Shield-Lib:v${project.fabric_shield_lib_version}"
	modImplementation "com.terraformersmc:modmenu:${project.mod_menu_version}"
	modImplementation "maven.modrinth:midnightlib:${project.midnightlib_version}"
	modImplementation "com.github.Chocohead:Fabric-ASM:v${project.fabricasm_version}"
</file>

At the time of writing, these are the most up-to-date FabricShieldLib versions:
  * **1.21.5** (''1.8.3-1.21.5'')
  * **1.21.4** (''1.8.0-1.21.4'')
  * **1.21.2** - **1.21.3** (''1.8.0-pre1-1.21.3'')
  * **1.21** - **1.21.1** (''1.7.2-1.21.1'')
  * **1.20.5** - **1.20.6** (''1.7.2-1.20.6'')
  * **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'' block)
<file groovy build.gradle>
	maven {url = 'https://jitpack.io'}
	maven {url "https://maven.terraformersmc.com/releases/"}
	maven {url = "https://api.modrinth.com/maven"}
</file>\\ 

__//**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 =====
**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!

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'' (see [[https://docs.fabricmc.net/develop/items/first-item|items]] tutorial), like:
<code java TutorialItems>
public final class TutorialItems {
    // ...
    public static final Item NETHERITE_SHIELD = register("netherite_shield", settings -> new FabricShieldItem(settings,10, 13, Items.NETHERITE_INGOT), new Item.Settings().maxDamage(2500));
    //The constructor for the item takes in the following values: FabricBannerShieldItem(settings.maxDamage(durability), cooldownTicks, enchantability, repairItems)
    // ...
}
</code>

If you want to add your shield to a [[itemgroup|item groups]], for example, the "Combat" group, use:

<yarncode java ExampleMod>
public class ExampleMod implements ModInitializer {
    ...
    @Override
    public void onInitialize() {
        ...
        ItemGroupEvents.modifyEntriesEvent(ItemGroups.COMBAT).register(entries -> {
            entries.add(NETHERITE_SHIELD);
        });
        ...
    }
    ...
}
</yarncode>

And our shield is (code-wise) done!

Now, we have to create the textures and models of the shield.

For the texture, you can use anything. A good place to start is to look at Mojang's shield texture and change it. Put it in ''resources/assets/tutorial/textures/item/netherite_shield.png''

Now, for the models, we have to write a few .json files.

Inside ''resources/assets/tutorial/models/item/'', create a ''netherite_shield.json'' file and put this inside it:

<file javascript resources/assets/tutorial/models/item/netherite_shield.json>
{
  "parent":"fabricshieldlib:item/fabric_shield",
  "textures":{
    "shield":"tutorial:item/netherite_shield"
  }
}
</file> 

In the same folder, create another file, ''netherite_shield_blocking.json'', and put his inside it: 
<file javascript resources/assets/tutorial/models/item/netherite_shield_blocking.json>
{
  "parent": "fabricshieldlib:item/fabric_shield_blocking",
  "textures":{
    "shield":"tutorial:item/netherite_shield"
  }
}
</file>

Assuming you've made the Item correctly, you should've also made an Item Model Description. We need to add the conditional model format, so your ''item/netherite_shield.json'' should look like this:
<file javascript resources/assets/tutorial/item/netherite_shield.json>
{
  "model": {
    "type": "minecraft:condition",
    "property": "minecraft:using_item",
    "on_false": {
      "type": "minecraft:model",
      "model": "tutorial:item/netherite_shield"
    },
    "on_true": {
      "type": "minecraft:model",
      "model": "tutorial:item/netherite_shield_blocking"
    }
  }
}
</file>

Then, as a [[tags|conventional tag]], create a ''shield.json'' file in ''resources/data/c/tags/item/tools/shield.json'' and add your shield to it:
<code javascript resources/data/c/tags/item/shields.json>
{
  "replace": false,
  "values": [
    "tutorial:netherite_shield"
  ]
}
</code>

Lastly, to make it enchantable, create a ''durability.json'' file in ''resources/data/minecraft/tags/item/enchantable/durability.json'' and add your shield to it:
<code javascript resources/data/minecraft/tags/item/enchantable/durability.json>
{
  "replace": false,
  "values": [
    "tutorial:netherite_shield"
  ]
}
</code>

Don't forget to add it to **en_us.json** in ''resources/assets/tutorial/lang/en_us.json''
<code javascript resources/assets/tutorial/lang/en_us.json>
{
  "item.tutorial.netherite_shield": "Netherite Shield"
}
</code>\\ 
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 TutorialItems>
	public static final Item NETHERITE_BANNER_SHIELD = register("netherite_banner_shield", settings -> new FabricBannerShieldItem(settings, 10, 13, Items.NETHERITE_INGOT), new Item.Settings().maxDamage(2500));
</code>
If you want to add your shield to a [[itemgroup|item groups]], for example, the "Combat" group, use:	 
 
<yarncode java ExampleMod>	 
public class ExampleMod implements ModInitializer {	 
    @Override	 
    public void onInitialize() {	 
        ItemGroupEvents.modifyEntriesEvent(ItemGroups.COMBAT).register(entries -> {	 
            // ...	 
            entries.add(NETHERITE_BANNER_SHIELD);	 
        });	 
    }	 
}	 
</yarncode>

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>
@Environment(EnvType.CLIENT)
public class ExampleModClient implements ClientModInitializer {
    public static final EntityModelLayer NETHERITE_BANNER_SHIELD_MODEL_LAYER = new EntityModelLayer(Identifier.of("tutorial", "netherite_banner_shield"),"main");

    @Override
    public void onInitializeClient() {
    
    }
}
</code>

Next, we will register out ''EntityModelLayer'' that we made previously. 

<code java>
@Environment(EnvType.CLIENT)
public class ExampleModClient implements ClientModInitializer {

    public static final EntityModelLayer NETHERITE_SHIELD_MODEL_LAYER = new EntityModelLayer(Identifier.of("tutorial", "netherite_shield"),"main"); 

    @Override
    public void onInitializeClient() {
	EntityModelLayerRegistry.registerModelLayer(NETHERITE_BANNER_SHILED_MODEL_LAYER, ShieldEntityModel::getTexturedModelData);
    }
}
</code>

Then we will create our shield model,

<code java>
@Environment(EnvType.CLIENT)
public class ExampleModClient implements ClientModInitializer {
    public static final EntityModelLayer NETHERITE_SHIELD_MODEL_LAYER = new EntityModelLayer(Identifier.of("tutorial", "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>
@Environment(EnvType.CLIENT)
public class ExampleModClient implements ClientModInitializer {
    public static final EntityModelLayer NETHERITE_SHIELD_MODEL_LAYER = new EntityModelLayer(Identifier.of("tutorial", "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>
@Environment(EnvType.CLIENT)
public class ExampleModClient implements ClientModInitializer {

	public static final EntityModelLayer netherite_banner_shield_model_layer = new EntityModelLayer(Identifier.of("tutorial", "netherite_banner_shield"), "main");

	public static ShieldEntityModel modelNetheriteShield;

	public static final SpriteIdentifier NETHERITE_BANNER_SHIELD_BASE = new SpriteIdentifier(SpriteAtlasTexture.BLOCK_ATLAS_TEXTURE, Identifier.of("tutorial", "entity/netherite_banner_shield_base"));
	public static final SpriteIdentifier NETHERITE_BANNER_SHIELD_BASE_NO_PATTERN = new SpriteIdentifier(SpriteAtlasTexture.BLOCK_ATLAS_TEXTURE, Identifier.of("tutorial", "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 will want to go back to our item and add a component to it to store its model information like so:

<code java>
	public static final Item NETHERITE_BANNER_SHIELD = register("netherite_banner_shield",
			settings -> new FabricBannerShieldItem(settings,10, 13, Items.NETHERITE_INGOT), // FabricBannerShieldItem(settings.maxDamage(durability), cooldownTicks, enchantability, repairItem)
			new Item.Settings().maxDamage(2500).component(FabricShieldLib.MODEL_COMPONENT,
					new FabricShieldModelComponent(
							ExampleModClient.NETHERITE_BANNER_SHIELD_BASE.getTextureId(), //Your base texture, from the client initializer
							ExampleModClient.NETHERITE_BANNER_SHIELD_BASE_NO_PATTERN.getTextureId(), //Your no-pattern texture, from the client initializer
							ExampleModClient.netherite_banner_shield_model_layer.toString() // Your model layer, from the client initializer
					)));

</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 resources/assets/minecraft/atlases/blocks.json>
{
  "sources": [
    {
      "type": "single",
      "resource": "tutorial:entity/netherite_banner_shield_base"
    },
    {
      "type": "single",
      "resource": "tutorial:entity/netherite_banner_shield_base_nopattern"
    }
  ]
}
</code>

Next, inside ''resources/assets/tutorial/models/item/'', create a ''netherite_banner_shield.json'' file and put this inside it:
<code javascript resources/assets/tutorial/models/item/netherite_banner_shield.json>
{
  "parent":"fabricshieldlib:item/fabric_banner_shield"
}
</code>

In the same folder, create another file, ''netherite_banner_shield_blocking.json'', and put his inside it: 
<code javascript resources/assets/tutorial/models/item/netherite_banner_shield_blocking.json>
{
  "parent":"fabricshieldlib:item/fabric_banner_shield_blocking"
}
</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''.

Next, create a ''shields.json'' file in ''resources/data/c/tags/items/shields.json'' and add your shield to it:
<code javascript resources/data/c/tags/items/shields.json>
{
  "replace": false,
  "values": [
    "tutorial:netherite_banner_shield"
  ]
}
</code>

Finally create a ''durability.json'' file in ''resources/data/minecraft/tags/item/enchantable/durability.json'' and add your shield to it:
<code javascript resources/data/minecraft/tags/item/enchantable/durability.json>
{
  "replace": false,
  "values": [
    "tutorial: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.tutorial.netherite_banner_shield": "Netherite Banner Shield",
  "item.tutorial.netherite_banner_shield.red": "Red Netherite Banner Shield",
  "item.tutorial.netherite_banner_shield.orange": "Orange Netherite Banner Shield",
  "item.tutorial.netherite_banner_shield.yellow": "Yellow Netherite Banner Shield",
  "item.tutorial.netherite_banner_shield.lime": "Lime Netherite Banner Shield",
  "item.tutorial.netherite_banner_shield.green": "Green Netherite Banner Shield",
  "item.tutorial.netherite_banner_shield.light_blue": "Light Blue Banner Netherite Shield",
  "item.tutorial.netherite_banner_shield.cyan": "Cyan Netherite Banner Shield",
  "item.tutorial.netherite_banner_shield.blue": "Blue Netherite Banner Shield",
  "item.tutorial.netherite_banner_shield.purple": "Purple Netherite Banner Shield",
  "item.tutorial.netherite_banner_shield.magenta": "Magenta Netherite Banner Shield",
  "item.tutorial.netherite_banner_shield.pink": "Pink Netherite Banner Shield",
  "item.tutorial.netherite_banner_shield.brown": "Brown Netherite Banner Shield",
  "item.tutorial.netherite_banner_shield.white": "White Netherite Banner Shield",
  "item.tutorial.netherite_banner_shield.light_gray": "Light Gray Netherite Banner Shield",
  "item.tutorial.netherite_banner_shield.gray": "Gray Netherite Banner Shield",
  "item.tutorial.netherite_banner_shield.dark_gray": "Dark Gray Netherite Banner Shield",
  "item.tutorial.netherite_banner_shield.black": "Black Netherite Banner Shield"
}
</code>

And now your shield is fully completed and supports banner decoration!
===== Changes for 1.21.3 =====
If you are working in 1.21.3, **follow the changes for all higher versions first**, then change the FabricShieldLib and FAPI versions accordingly and change your other dependencies to these versions:\\

<file properties gradle.properties>
mod_menu_version=12.0.0-beta.1
midnightlib_version=1.6.4-fabric
</file>

Next, remove the ''FabricShieldLib.MODEL_COMPONENT'' from your shields. Then, you will want to register your shield with the ''BuiltinItemRendererRegistry'':

<code java>
...
import static com.github.crimsondawn45.fabricshieldlib.initializers.FabricShieldLibClient.renderBanner;
...
public class ExampleModClient implements ClientModInitializer {
	...
	@Override
	public void onInitializeClient() {
                ...
		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>

Finally, change the following models to these formats: (netherite_shield_blocking.json will be unchanged)

<file javascript resources/assets/tutorial/models/item/netherite_shield.json>
{
    "parent":"fabricshieldlib:item/fabric_shield",
    "textures":{
        "shield":"tutorial:item/netherite_shield"
    },
    "overrides": [
        {
            "predicate": {
                "blocking": 1
            },
            "model": "tutorial:item/netherite_shield_blocking"
        }
    ]
}
</file> 

<code javascript resources/assets/tutorial/models/item/etherite_banner_shield.json>
{
  "parent":"fabricshieldlib:item/fabric_banner_shield",
  "overrides": [
    {
      "predicate": {
        "blocking": 1
      },
      "model": "tutorial:item/netherite_banner_shield_blocking"
    }
  ]
}
</code>

<code javascript resources/assets/tutorial/models/item/etherite_banner_shield_blocking.json>
{
  "parent":"fabricshieldlib:item/fabric_banner_shield_blocking",
  "textures":{
    "shield":"tutorial:item/netherite_banner_shield"
  }
}
</code>

===== Changes for 1.21.1 =====
If you are working in 1.21.1, **follow the changes for all higher versions first**, then change the FabricShieldLib and FAPI versions accordingly and change your other dependencies to these versions:\\

<file properties gradle.properties>
mod_menu_version=11.0.1
midnightlib_version=1.5.8-fabric
</file>

Then, update your Item registries to match the old method at the [[items]] tutorial. Your item registry lines would look like this:

<code java>
public static final Item NETHERITE_SHIELD = register(new FabricShieldItem(new Item.Settings().maxDamage(2500),10, 13, Items.NETHERITE_INGOT),"netherite_shield");
</code>
or
<code java>
public static final Item NETHERITE_BANNER_SHIELD = register(new FabricBannerShieldItem(new Item.Settings().maxDamage(2500), 10, 13, Items.NETHERITE_INGOT), "netherite_banner_shield");
</code>

===== Changes for 1.20.6 =====
If you are working in 1.20.6, **follow the changes for all higher versions first**, then change the FabricShieldLib and FAPI versions accordingly and change your other dependencies to these versions:\\

<file properties gradle.properties>
mod_menu_version=10.0.0-beta.1
midnightlib_version=1.5.5-fabric
</file>

Next, change all instances of ''Identifier.of'' to ''new Identifier''; these are when you are registering your item, creating your ''EntityModelLayer'', and creating your ''SpriteIdentifiers''.

Then, change your ''shield.json'' in ''resources/data/c/tags/item/tools/shield.json'' to ''shields.json'' file in ''resources/data/c/tags/items/shields.json'' 

Finally, move your ''durability.json'' from ''resources/data/minecraft/tags/items/enchantable/durability.json'' to ''resources/data/minecraft/tags/item/enchantable/durability.json''

===== Changes for 1.20.4 =====
If you are working in 1.20.4, **follow the changes for all higher versions first**, then change the FabricShieldLib and FAPI versions accordingly and change your other dependencies to these versions:\\

**gradle.properties**
<file properties gradle.properties>
midnightlib_version=1.5.2-fabric
mod_menu_version=9.0.0-pre.1
</file>

Additionally, **remove the** ''durability.json'' **file** completely.

===== Changes for 1.20.1 =====
If you are working in 1.20.1, **follow the changes for all higher versions first**, then change the FabricShieldLib and FAPI versions accordingly and change your other dependencies to these versions:\\

**gradle.properties**
<file properties gradle.properties>
midnightlib_version=1.4.1-fabric
mod_menu_version=7.1.0
</file>

===== Changes for 1.19 =====
If you are working in 1.19, **follow the changes for all higher versions first**, then change the FabricShieldLib and FAPI versions accordingly and change your other dependencies to these versions:\\

**gradle.properties**
<file properties gradle.properties>
midnightlib_version=1.0.0-fabric
mod_menu_version=4.2.0-beta.2
</file>