tutorial:items
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:items [2019/02/17 23:08] – fixing formatting & image draylar | tutorial:items [2022/07/23 18:06] – external edit 127.0.0.1 | ||
---|---|---|---|
Line 3: | Line 3: | ||
==== Introduction ==== | ==== Introduction ==== | ||
- | One of the first things you'll want to do with Fabric is registering | + | Adding a basic item is one of the first steps in modding. You're going to need to create an ''< |
+ | ==== Registering an Item ==== | ||
- | You're going to need to create an Item object, register | + | First, |
+ | < | ||
+ | public class ExampleMod implements ModInitializer { | ||
- | ==== Creating | + | // an instance of our new item |
+ | public static final class_1792 CUSTOM_ITEM | ||
+ | [...] | ||
+ | } | ||
+ | </ | ||
+ | You'll use the vanilla registry system for registering new content. The basic syntax is ''< | ||
+ | < | ||
+ | public class ExampleMod implements ModInitializer { | ||
- | To create your first item, create a new class that overrides Item. We'll name our item class ' | + | // an instance of our new item |
+ | public static final class_1792 CUSTOM_ITEM = new class_1792(new FabricItemSettings().method_7892(class_1761.field_7932)); | ||
- | public class FabricItem extends Item | + | @Override |
- | { | + | public |
- | public | + | |
- | | + | |
- | | + | |
} | } | ||
- | | + | } |
+ | </ | ||
+ | Your new item has now been added to Minecraft. Run the '' | ||
- | Your super() call will require an Item.Settings object. This is used to set properties such as the creative inventory category, durability, and stack count. We're just going to tell our item to go in the Misc section: | + | {{: |
- | super(new Item.Settings().itemGroup(ItemGroup.MISC)); | + | ==== Adding |
- | + | ||
- | ==== Registering an Item ==== | + | |
- | Just like most additions you make in Fabric, you'll need to register | + | Registering a texture for an item requires an item model .json file and a texture image. You're going to need to add these to your resource directory. The direct path of each is: |
- | First, we'll create an instance of our item at the top of our main class. It's useful to keep an instance so you can reference and access it later from different classes: | + | Item model: .../ |
+ | Item texture: .../ | ||
- | public class ExampleMod implements ModInitializer | + | Our example texture can be found [[https://i.imgur.com/CqLSMEQ.png|here]]. |
- | { | + | |
- | | + | |
- | public static FabricItem fabricItem = new FabricItem(); | + | |
- | [...] | + | |
- | } | + | |
+ | If you registered your item properly in the first step, your game will complain about a missing texture file in a fashion similar to this: | ||
- | Second, register your item in your onInitialize method. You can also register | + | [Server-Worker-1/ |
+ | It conveniently tells you exactly where it expects | ||
- | public class ExampleMod implements ModInitializer | + | A basic item model template is: |
- | { | + | <code JavaScript> |
- | // an instance of our new item | + | { |
- | public static FabricItem fabricItem = new FabricItem(); | + | " |
- | @Override | + | " |
- | public void onInitialize() | + | " |
- | | + | |
- | Registry.register(Registry.ITEM, | + | |
- | } | + | |
} | } | ||
+ | } | ||
+ | </ | ||
+ | The parent of your item changes how it's rendered in the hand and comes in useful for things like block items in the inventory. " | ||
+ | Final textured result: | ||
- | At this point, if you start your Minecraft game, you will see your new item. Pretty easy! | + | {{: |
- | {{: | + | ==== Creating an Item class ==== |
- | ==== Adding | + | To add additional behavior to the item you will need to create an Item class. The default constructor requires an Item.Settings object. |
+ | < | ||
+ | public class CustomItem extends class_1792 { | ||
- | You're probably annoyed with the black & purple missing texture, so we'll fix that now. | + | public CustomItem(class_1793 settings) { |
+ | super(settings); | ||
+ | } | ||
+ | } | ||
+ | </ | ||
- | Registering a texture | + | A practical use-case |
+ | < | ||
+ | public class CustomItem extends class_1792 { | ||
- | | + | |
- | | + | super(settings); |
+ | | ||
- | Note that my-mod is your modid. If you registered your item properly in the first step, your game will also complain about a missing texture file in a fashion similar to this: | + | @Override |
+ | public class_1271< | ||
+ | playerEntity.method_5783(class_3417.field_14983, 1.0F, 1.0F); | ||
+ | return class_1271.method_22427(playerEntity.method_5998(hand)); | ||
+ | } | ||
+ | } | ||
+ | </ | ||
- | | + | Replace the old <yarn class_1792> |
- | + | < | |
- | It conveniently tells you exactly where to put your item model file, so this is good for when you can't figure it out yourself. | + | public class ExampleMod implements ModInitializer { |
- | As for the actual contents | + | // an instance |
+ | public static final CustomItem CUSTOM_ITEM = new CustomItem(new FabricItemSettings().method_7892(class_1761.field_7932)); | ||
+ | [...] | ||
+ | } | ||
+ | </ | ||
+ | If you did everything correctly, using the item should now play a sound. | ||
- | { | + | ==== What if I want to change the stack size of my item? ==== |
- | " | + | |
- | " | + | |
- | " | + | |
- | } | + | |
- | } | + | |
- | + | ||
- | The parent of your item changes how it's rendered in the hand and comes in useful for things like block items in the inventory. textures/ | + | |
- | If you set everything up correctly, | + | For this you would use ''< |
+ | < | ||
+ | public class ExampleMod implements ModInitializer { | ||
- | {{: | + | // An instance of our new item, where the maximum stack size is 16 |
+ | public static final CustomItem CUSTOM_ITEM = new CustomItem(new FabricItemSettings().method_7892(class_1761.field_7932).method_7889(16)); | ||
+ | [...] | ||
+ | } | ||
+ | </ | ||
+ | |||
+ | ==== Make your item become fuel, or compostable ==== | ||
+ | |||
+ | If you want to make it a fuel so that it can be used in a furnace, you can use '' | ||
+ | <code java> | ||
+ | public class ExampleMod implements ModInitializer | ||
+ | [...] | ||
+ | |||
+ | @Override | ||
+ | public void onInitialize() | ||
+ | [...] | ||
+ | FuelRegistry.INSTANCE.add(CUSTOM_ITEM, | ||
+ | | ||
+ | } | ||
+ | </ | ||
+ | Similarly, you can use a '' | ||
+ | ==== Next Steps ==== | ||
+ | [[tutorial: |
tutorial/items.txt · Last modified: 2024/04/20 08:05 by ryhon