User Tools

Site Tools


tutorial:items

Adding an Item

Introduction

One of the first things you'll want to do with Fabric is adding a new item.

You're going to need to create an Item object, register it, and give it a texture. To add additional behavior to the item you will need a custom Item class.

Registering an Item

First, create an instance of Item. We'll store it at the top of our initializer class. The constructor takes in an Item.Settings object, which is used to set item properties such as the inventory category, durability, and stack count.

  1. public class ExampleMod implements ModInitializer
  2. {
  3. // an instance of our new item
  4. public static final Item FABRIC_ITEM = new Item(new Item.Settings().itemGroup(ItemGroup.MISC));
  5. [...]
  6. }

To register an Item, you can call register on the static Registry object. This takes in a registry type, Identifier, and an instance of what you're registering. This can be called anywhere as long as it occurs during initialization.

  1. public class ExampleMod implements ModInitializer
  2. {
  3. // an instance of our new item
  4. public static final Item FABRIC_ITEM = new Item(new Item.Settings().itemGroup(ItemGroup.MISC));
  5.  
  6. @Override
  7. public void onInitialize()
  8. {
  9. Registry.register(Registry.ITEM, new Identifier("wikitut", "fabric_item"), FABRIC_ITEM);
  10. }
  11. }

Your new item has now been added to Minecraft. Run the `runClient` gradle task to see it in action.

Adding Item textures

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:

  Item model: .../resources/assets/wikitut/models/item/fabric_item.json
  Item texture: .../resources/assets/wikitut/textures/item/fabric_item.png

Note that wikitut is your modid. Our example texture can be found here.

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:

  [Server-Worker-1/WARN]: Unable to load model: 'wikitut:fabric_item#inventory' referenced from: wikitut:fabric_item#inventory: java.io.FileNotFoundException: wikitut:models/item/fabric_item.json

It conveniently tells you exactly where it expects your asset[s] to be found– when in doubt, check the log.

A basic item model template is:

{
  "parent": "item/generated",
  "textures": {
    "layer0": "wikitut:item/fabric_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. “item/handheld” is used for tools that are held from the bottom left of the texture. textures/layer0 is the location of your image file.

Final textured result:

Creating an Item class

To add additional behavior to the item you will need to create an Item class. The default constructor requires an Item.Settings object.

  1. public class FabricItem extends Item
  2. {
  3. public FabricItem(Settings settings)
  4. {
  5. super(settings);
  6. }
  7. }

An example application would be making the item play a sound when you click with it:

  1. public class FabricItem extends Item
  2. {
  3. public FabricItem(Settings settings)
  4. {
  5. super(settings);
  6. }
  7.  
  8. @Override
  9. public TypedActionResult<ItemStack> use(World world, PlayerEntity playerEntity, Hand hand)
  10. {
  11. playerEntity.playSound(SoundEvents.BLOCK_WOOL_BREAK, 1.0F, 1.0F);
  12. return new TypedActionResult<>(ActionResult.SUCCESS, playerEntity.getStackInHand(hand));
  13. }
  14. }

Replace the old Item object with an instance of your new Item:

  1. public class ExampleMod implements ModInitializer
  2. {
  3. // an instance of our new item
  4. public static final FabricItem FABRIC_ITEM = new FabricItem(new Item.Settings().itemGroup(ItemGroup.MISC));
  5. [...]
  6. }

If you did everything correctly, using the item should now play a sound.

tutorial/items.txt · Last modified: 2019/05/20 15:44 by draylar