tutorial:shield
Differences
This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revisionNext revision | Previous revisionNext revisionBoth sides next revision | ||
tutorial:shield [2021/11/26 22:23] – added 1.16 section for banner support cringestar_boi | tutorial:shield [2023/12/22 04:12] – almost done cringestar_boi | ||
---|---|---|---|
Line 1: | Line 1: | ||
- | ====== Making a Custom Shield in Minecraft ====== | + | ====== Making a Custom Shield in Minecraft |
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.\\ | ||
Line 13: | Line 13: | ||
**gradle.properties**\\ | **gradle.properties**\\ | ||
<code java> | <code java> | ||
- | fabric_shield_lib_version=1.4.5-1.17 | + | fabric_shield_lib_version=1.7.2-1.20.4 |
+ | midnightlib_version=1.5.2-fabric | ||
+ | mod_menu_version=9.0.0-pre.1 | ||
+ | fabricasm_version=2.3 | ||
</ | </ | ||
**build.gradle** (under dependencies)\\ | **build.gradle** (under dependencies)\\ | ||
<code java> | <code java> | ||
- | modImplementation " | + | modImplementation " |
+ | |||
+ | modImplementation " | ||
+ | |||
+ | modImplementation " | ||
+ | |||
+ | modImplementation " | ||
</ | </ | ||
- | At the time of writing, latest project.fabric_shield_lib_version should be 1.4.5, and latest project.minecraft_version should be 1.17.1. This page will be updated whenever a new update comes out.\\ \\ | + | |
- | **build.gradle** (under repositories)\\ | + | 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.\\ \\ |
+ | **build.gradle** (inside | ||
<code java> | <code java> | ||
- | allprojects { repositories { maven { url ' | + | maven {url = ' |
+ | maven {url " | ||
+ | maven {url = " | ||
</ | </ | ||
+ | |||
+ | __// | ||
===== Adding a custom shield ===== | ===== Adding a custom shield ===== | ||
- | **If you want your shield to support banner decoration, | + | **If you want your shield to support banner decoration |
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 fabric shield api 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> | ||
- | public static final Item NETHERITE_SHIELD = new FabricShieldItem(new FabricItemSettings().maxDamage(2500).group(ItemGroup.COMBAT), 10, 13, Items.NETHERITE_INGOT); | + | public static final Item NETHERITE_SHIELD = new FabricShieldItem(new FabricItemSettings().maxDamage(2500), |
</ | </ | ||
Line 37: | Line 51: | ||
<code java> | <code java> | ||
- | Registry.register(Registry.ITEM, new Identifier(" | + | Registry.register(Registries.ITEM, new Identifier(" |
</ | </ | ||
- | And our shield is done!\\ | + | If you want to add your shield to a creative tab, add this into your '' |
+ | <code java> | ||
+ | ItemGroupEvents.modifyEntriesEvent(ItemGroups.COMBAT).register(entries -> { | ||
+ | entries.add(NETHERITE_SHIELD); | ||
+ | }); | ||
+ | </ | ||
+ | |||
+ | And our shield is (code-wise) | ||
Now, we have to create the textures and models of the shield.\\ | 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 looking | + | For the texture, you can use anything. A good place to start is to look at Mojang's shield |
Now, for the models, we have to write a few .json files.\\ | Now, for the models, we have to write a few .json files.\\ | ||
- | For the model file without blocking, we use: \\ | + | |
+ | |||
+ | Inside '' | ||
<code javascript> | <code javascript> | ||
{ | { | ||
Line 61: | Line 85: | ||
} | } | ||
</ | </ | ||
- | Put it in resources/ | + | |
- | For the blocking model, use this: \\ | + | In the same folder, create another file, '' |
<code javascript> | <code javascript> | ||
{ | { | ||
- | " | + | " |
+ | " | ||
+ | " | ||
+ | } | ||
} | } | ||
</ | </ | ||
- | Plop it in resources/models/item/netherite_shield_blocking.json\\ | + | |
- | Don't forget to add it to **en_us.json**\\ | + | Lastly, create a '' |
+ | <code javascript> | ||
+ | { | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | ] | ||
+ | } | ||
+ | </ | ||
+ | |||
+ | Don't forget to add it to **en_us.json** | ||
<code javascript> | <code javascript> | ||
{ | { | ||
Line 75: | Line 112: | ||
} | } | ||
</ | </ | ||
- | And with that, your shield is done! | + | And with that, your non-decorateable |
+ | ===== Adding a custom shield with banner support ===== | ||
+ | If you want to make your shield accept banners and decorateable like a vanilla shield, the process is slightly different. | ||
- | ===== Adding banner support to your shield | + | We still make the item in the same way, just make it a FabricBannerShieldItem: |
+ | <code java> | ||
+ | public static final Item NETHERITE_BANNER_SHIELD | ||
+ | </ | ||
- | This is where mixins get involved. | + | Then, we have to register it: |
- | + | ||
- | First thing you will want to do is to change | + | <code java> |
+ | Registry.register(Registries.ITEM, | ||
+ | </code> | ||
+ | If you want to add your shield to a creative tab, add this into your '' | ||
<code java> | <code java> | ||
- | public static final Item NETHERITE_SHIELD = new FabricBannerShieldItem(new FabricItemSettings().maxDamage(2500).group(ItemGroup.COMBAT), 10, 13, Items.NETHERITE_INGOT); // FabricBannerShieldItem(settings.maxDamage(durability), | + | ItemGroupEvents.modifyEntriesEvent(ItemGroups.COMBAT).register(entries -> { |
+ | entries.addAfter(Items.SHIELD,NETHERITE_BANNER_SHIELD); | ||
+ | }); | ||
</ | </ | ||
- | Now, we have to register a few things | + | Now the item is created, we need to set up its rendering. For these steps, we are going to be working |
- | To create our '' | ||
+ | First, we will need to create an '' | ||
<code java> | <code java> | ||
public class ExampleModClient implements ClientModInitializer { | public class ExampleModClient implements ClientModInitializer { | ||
+ | |||
+ | public static final EntityModelLayer netherite_banner_shield_model_layer = new EntityModelLayer(new Identifier(" | ||
+ | |||
@Override | @Override | ||
public void onInitializeClient() { | public void onInitializeClient() { | ||
Line 101: | Line 151: | ||
</ | </ | ||
- | Before we do any work in our client mod initializer, we need to register | + | Next, we will register |
- | <code javascript> | ||
- | { | ||
- | [...] | ||
- | " | ||
- | " | ||
- | " | ||
- | ], | ||
- | " | ||
- | " | ||
- | ] | ||
- | } | ||
- | [...] | ||
- | } | ||
- | </ | ||
- | |||
- | Ok, so now that is done, we can work in our client initializer. | ||
- | |||
- | First, we will need to create an '' | ||
<code java> | <code java> | ||
public class ExampleModClient implements ClientModInitializer { | public class ExampleModClient implements ClientModInitializer { | ||
Line 128: | Line 160: | ||
@Override | @Override | ||
public void onInitializeClient() { | public void onInitializeClient() { | ||
- | | + | EntityModelLayerRegistry.registerModelLayer(netherite_banner_shield_model_layer, |
} | } | ||
} | } | ||
</ | </ | ||
- | Next, we will register out '' | + | Then we will create our shield model, |
<code java> | <code java> | ||
Line 139: | Line 171: | ||
public static final EntityModelLayer NETHERITE_SHIELD_MODEL_LAYER = new EntityModelLayer(new Identifier(" | public static final EntityModelLayer NETHERITE_SHIELD_MODEL_LAYER = new EntityModelLayer(new Identifier(" | ||
+ | | ||
+ | public static ShieldEntityModel modelNetheriteShield; | ||
@Override | @Override | ||
Line 147: | Line 181: | ||
</ | </ | ||
- | Then we will register | + | And then register |
<code java> | <code java> | ||
Line 153: | Line 187: | ||
public static final EntityModelLayer NETHERITE_SHIELD_MODEL_LAYER = new EntityModelLayer(new Identifier(" | public static final EntityModelLayer NETHERITE_SHIELD_MODEL_LAYER = new EntityModelLayer(new Identifier(" | ||
+ | | ||
+ | public static ShieldEntityModel modelNetheriteShield; | ||
@Override | @Override | ||
public void onInitializeClient() { | public void onInitializeClient() { | ||
EntityModelLayerRegistry.registerModelLayer(NETHERITE_SHIELD_MODEL_LAYER, | EntityModelLayerRegistry.registerModelLayer(NETHERITE_SHIELD_MODEL_LAYER, | ||
- | | + | |
- | | + | ShieldSetModelCallback.EVENT.register((loader) -> { |
- | | + | modelNetheriteShield = new ShieldEntityModel(loader.getModelPart(netherite_banner_shield_model_layer)); |
- | }); | + | return ActionResult.PASS; |
+ | }); | ||
} | } | ||
} | } | ||
</ | </ | ||
- | And now we get to the mixin. Don't worry, its an easy one. | + | Next, we have to create our two '' |
+ | <code java> | ||
+ | public class ExampleModClient implements ClientModInitializer { | ||
- | If this is your first time, [[tutorial: | + | public static final EntityModelLayer netherite_banner_shield_model_layer = new EntityModelLayer(new Identifier(" |
- | We will make a class called '' | + | public |
- | <code java> | + | |
- | @Mixin (BuiltinModelItemRenderer.class) | + | |
- | public | + | |
- | } | + | public static final SpriteIdentifier NETHERITE_BANNER_SHIELD_BASE = new SpriteIdentifier(SpriteAtlasTexture.BLOCK_ATLAS_TEXTURE, |
- | </code> | + | public static final SpriteIdentifier NETHERITE_BANNER_SHIELD_BASE_NO_PATTERN = new SpriteIdentifier(SpriteAtlasTexture.BLOCK_ATLAS_TEXTURE, |
- | Then we will make the necessary '' | + | @Override |
- | <code java> | + | public void onInitializeClient() { |
- | @Mixin | + | |
- | public class RendererMixin | + | |
- | | + | ShieldSetModelCallback.EVENT.register((loader) -> { |
- | | + | modelNetheriteShield |
- | | + | return ActionResult.PASS; |
+ | }); | ||
+ | } | ||
} | } | ||
</ | </ | ||
- | Next, we need to @Shadow | + | Finally, we are going to register our shield with the '' |
<code java> | <code java> | ||
- | @Mixin (BuiltinModelItemRenderer.class) | + | public class ExampleModClient implements ClientModInitializer |
- | public class RendererMixin | + | |
- | private ShieldEntityModel modelNetheriteShield; | + | |
- | private static final SpriteIdentifier NETHERITE_SHIELD_BASE = new SpriteIdentifier(SpriteAtlasTexture.BLOCK_ATLAS_TEXTURE, | + | |
- | private static final SpriteIdentifier NETHERITE_SHIELD_BASE_NO_PATTERN = new SpriteIdentifier(SpriteAtlasTexture.BLOCK_ATLAS_TEXTURE, | + | |
- | @Final | + | public static final EntityModelLayer netherite_banner_shield_model_layer = new EntityModelLayer(new Identifier(" |
- | @Shadow | + | |
- | private EntityModelLoader entityModelLoader; | + | |
- | } | + | |
- | </ | + | |
- | Now we will inject into the '' | + | public |
- | <code java> | + | |
- | @Mixin (BuiltinModelItemRenderer.class) | + | |
- | public | + | |
- | | + | |
- | private static final SpriteIdentifier NETHERITE_SHIELD_BASE = new SpriteIdentifier(SpriteAtlasTexture.BLOCK_ATLAS_TEXTURE, | + | |
- | private static final SpriteIdentifier NETHERITE_SHIELD_BASE_NO_PATTERN = new SpriteIdentifier(SpriteAtlasTexture.BLOCK_ATLAS_TEXTURE, | + | |
- | @Final | + | public static final SpriteIdentifier NETHERITE_BANNER_SHIELD_BASE = new SpriteIdentifier(SpriteAtlasTexture.BLOCK_ATLAS_TEXTURE, |
- | | + | public static final SpriteIdentifier NETHERITE_BANNER_SHIELD_BASE_NO_PATTERN = new SpriteIdentifier(SpriteAtlasTexture.BLOCK_ATLAS_TEXTURE, |
- | private EntityModelLoader entityModelLoader; | + | |
- | + | @Override | |
- | | + | public void onInitializeClient() { |
- | | + | EntityModelLayerRegistry.registerModelLayer(NETHERITE_SHIELD_MODEL_LAYER, |
- | modelNetheriteShield = new ShieldEntityModel(this.entityModelLoader.getModelPart(ExampleModClient.NETHERITE_SHIELD_MODEL_LAYER)); | + | |
- | } | + | ShieldSetModelCallback.EVENT.register((loader) -> { |
+ | | ||
+ | return ActionResult.PASS; | ||
+ | }); | ||
+ | |||
+ | BuiltinItemRendererRegistry.INSTANCE.register(ExampleMod.NETHERITE_BANNER_SHIELD, | ||
+ | renderBanner(stack, | ||
+ | //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. | ||
+ | }); | ||
+ | } | ||
} | } | ||
- | </ | + | </ |
- | + | ||
- | Now we get to the most important part of the mixin. We will inject a method to render a banner on our shield. | + | |
- | + | ||
- | <code java> | + | |
- | @Mixin (BuiltinModelItemRenderer.class) | + | |
- | public class RendererMixin { | + | |
- | | + | |
- | private static final SpriteIdentifier NETHERITE_SHIELD_BASE = new SpriteIdentifier(SpriteAtlasTexture.BLOCK_ATLAS_TEXTURE, | + | |
- | private static final SpriteIdentifier NETHERITE_SHIELD_BASE_NO_PATTERN = new SpriteIdentifier(SpriteAtlasTexture.BLOCK_ATLAS_TEXTURE, | + | |
- | @Final | + | That is all of our code done, we only have a few .json files to make. \\ |
- | @Shadow | + | |
- | private EntityModelLoader entityModelLoader; | + | |
- | + | ||
- | + | ||
- | @Inject(method = " | + | |
- | private void setModelNetheriteShield(CallbackInfo ci){ | + | |
- | this.modelNetheriteShield = new ShieldEntityModel(this.entityModelLoader.getModelPart(ExampleModClient.NETHERITE_SHIELD_MODEL_LAYER)); | + | |
- | } | + | |
- | + | ||
- | @Inject(method = " | + | |
- | private void mainRender(ItemStack stack, ModelTransformation.Mode mode, MatrixStack matrices, VertexConsumerProvider vertexConsumers, | + | |
- | if (stack.isOf(ExampleMod.NETHERITE_SHIELD)) { | + | |
- | FabricShieldLibClient.renderBanner(stack, | + | |
- | //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 ''// | + | |
- | '' | + | |
- | } | + | |
- | } | + | |
- | + | ||
- | + | ||
- | } | + | |
- | </ | + | |
- | That is now all of the complicated things done! We now only need to change our existing model, add a '' | + | Firstly, inside |
- | In your shield model, '' | ||
<code javascript> | <code javascript> | ||
{ | { | ||
" | " | ||
- | | + | |
- | { | + | { |
- | " | + | " |
- | " | + | " |
- | }, | + | }, |
- | " | + | " |
- | } | + | } |
- | ] | + | ] |
} | } | ||
- | </ | + | </ |
- | + | ||
- | You also have to change your blocking model for your shield, '' | + | |
+ | In the same folder, create another file, '' | ||
<code javascript> | <code javascript> | ||
{ | { | ||
" | " | ||
} | } | ||
- | </ | + | </ |
- | For this next step, you will add '' | + | For this next step, you will add a '' |
- | Then, you will need to make a '' | + | Then, you will need to make a '' |
Then, you will move both of these textures into '' | Then, you will move both of these textures into '' | ||
- | For one last thing, you will need to add names for each of your shield color variants in '' | + | Lastly, create a '' |
<code javascript> | <code javascript> | ||
{ | { | ||
- | | + | |
- | "item.examplemod.netherite_shield.red": | + | "values": |
- | "item.examplemod.netherite_shield.orange" | + | " |
- | " | + | ] |
- | " | + | |
- | " | + | |
- | " | + | |
- | " | + | |
- | " | + | |
- | " | + | |
- | " | + | |
- | " | + | |
- | " | + | |
- | " | + | |
- | " | + | |
- | " | + | |
- | " | + | |
- | " | + | |
} | } | ||
- | </ | + | </ |
- | + | ||
- | ===== Adding banner support to your shield (1.16.x) ===== | + | |
- | + | ||
- | This is where mixins get involved. | + | |
- | + | ||
- | First thing you will want to do is to change // | + | |
- | + | ||
- | <code java> | + | |
- | public static final Item NETHERITE_SHIELD = new FabricBannerShieldItem(new FabricItemSettings().maxDamage(2500).group(ItemGroup.COMBAT), | + | |
- | </ | + | |
- | + | ||
- | Now, we have to register a few things in our '' | + | |
- | + | ||
- | To create our '' | + | |
- | + | ||
- | <code java> | + | |
- | public class ExampleModClient implements ClientModInitializer { | + | |
- | @Override | + | |
- | public void onInitializeClient() { | + | |
- | + | ||
- | } | + | |
- | } | + | |
- | </ | + | |
- | + | ||
- | Before we do any work in our client mod initializer, | + | |
+ | Don't forget to add it to **en_us.json** in '' | ||
<code javascript> | <code javascript> | ||
{ | { | ||
- | | + | |
- | "entrypoints": | + | "item.examplemod.netherite_banner_shield.red": |
- | "main": | + | "item.examplemod.netherite_banner_shield.orange": |
- | "net.fabricmc.ExampleMod" | + | "item.examplemod.netherite_banner_shield.yellow": |
- | ], | + | "item.examplemod.netherite_banner_shield.lime": "Lime Netherite Shield", |
- | "client": | + | " |
- | "net.fabricmc.ExampleModClient" | + | "item.examplemod.netherite_banner_shield.light_blue": |
- | ] | + | "item.examplemod.netherite_banner_shield.cyan": "Cyan Netherite Shield", |
- | | + | " |
- | | + | |
+ | | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
} | } | ||
- | </ | ||
- | |||
- | Ok, so now that is done, we can work in our client initializer. | ||
- | |||
- | The only thing that we will need to do is register our 2 '' | ||
- | |||
- | <code java> | ||
- | public class ExampleModClient implements ClientModInitializer { | ||
- | |||
- | @Override | ||
- | public void onInitializeClient() { | ||
- | ClientSpriteRegistryCallback.event(SpriteAtlasTexture.BLOCK_ATLAS_TEXTURE).register((atlasTexture, | ||
- | registry.register(new Identifier(" | ||
- | registry.register(new Identifier(" | ||
- | }); | ||
- | } | ||
- | } | ||
- | </ | ||
- | |||
- | And now we get to the mixin. Don't worry, its an easy one. | ||
- | |||
- | If this is your first time, [[tutorial: | ||
- | |||
- | We will make a class called '' | ||
- | <code java> | ||
- | @Mixin (BuiltinModelItemRenderer.class) | ||
- | public class RendererMixin { | ||
- | |||
- | } | ||
- | </ | ||
- | |||
- | Then we will make the necessary '' | ||
- | <code java> | ||
- | @Mixin (BuiltinModelItemRenderer.class) | ||
- | public class RendererMixin { | ||
- | private ShieldEntityModel modelNetheriteShield = new ShieldEntityModel; | ||
- | private static final SpriteIdentifier NETHERITE_SHIELD_BASE = new SpriteIdentifier(SpriteAtlasTexture.BLOCK_ATLAS_TEXTURE, | ||
- | private static final SpriteIdentifier NETHERITE_SHIELD_BASE_NO_PATTERN = new SpriteIdentifier(SpriteAtlasTexture.BLOCK_ATLAS_TEXTURE, | ||
- | } | ||
- | </ | ||
- | </ | ||
- | |||
- | Now we get to the most important part of the mixin. We will inject a method to render a banner on our shield. | ||
- | | ||
- | <code java> | ||
- | @Mixin (BuiltinModelItemRenderer.class) | ||
- | public class RendererMixin { | ||
- | private ShieldEntityModel modelNetheriteShield = new ShieldEntityModel; | ||
- | private static final SpriteIdentifier NETHERITE_SHIELD_BASE = new SpriteIdentifier(SpriteAtlasTexture.BLOCK_ATLAS_TEXTURE, | ||
- | private static final SpriteIdentifier NETHERITE_SHIELD_BASE_NO_PATTERN = new SpriteIdentifier(SpriteAtlasTexture.BLOCK_ATLAS_TEXTURE, | ||
- | | ||
- | @Inject(method = " | ||
- | private void mainRender(ItemStack stack, ModelTransformation.Mode mode, MatrixStack matrices, VertexConsumerProvider vertexConsumers, | ||
- | if (stack.getItem() == ExampleMod.NETHERITE_SHIELD)) { | ||
- | FabricShieldLibClient.renderBanner(stack, | ||
- | //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 ''// | ||
- | '' | ||
- | } | ||
- | } | ||
- | |||
- | | ||
- | } | ||
- | </ | ||
- | |||
- | That is now all of the complicated things done! We now only need to change our existing model, add a '' | ||
- | |||
- | In your shield model, '' | ||
- | <code javascript> | ||
- | { | ||
- | " | ||
- | " | ||
- | { | ||
- | " | ||
- | " | ||
- | }, | ||
- | " | ||
- | } | ||
- | ] | ||
- | } | ||
- | </ | ||
- | |||
- | You also have to change your blocking model for your shield, '' | ||
- | |||
- | <code javascript> | ||
- | { | ||
- | " | ||
- | } | ||
- | </ | ||
- | |||
- | For this next step, you will add '' | ||
- | Then, you will need to make a '' | ||
- | |||
- | Then, you will move both of these textures into '' | ||
- | |||
- | For one last thing, you will need to add names for each of your shield color variants in '' | ||
- | <code javascript> | ||
- | { | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | } | ||
- | </ | ||
- | |||
- | |||
- | Now your shield is done and has banner support! |
tutorial/shield.txt · Last modified: 2024/07/03 07:08 by solidblock