User Tools

Site Tools


Item Groups (1.19)

So far, you have used /give @s tutorial:custom_item to obtain your item. To make obtaining your item easier, you can add it to item groups within the creative inventory. You can also add your own item group. All items added to any group will also be searchable within the creative inventory.

Adding to Item Groups

First, choose the item group that the item should be added to. For this example, that item group will be the building blocks group. The vanilla item groups are stored in the ItemGroups class.

Next, you can simply use group method in FabricItemSettings with Fabric API. This will locate your custom item on last of item group.

But if you want to put your custom item in other location(eg. after of OAK_DOOR) or other advanced modification, you can register the event handler for each item group that you would like to modify in your onInitialize method. Each item group that you would like to modify requires its own event handler, but the same event handler can be used to add multiple items to one item group.

Items can be positioned relative to the existing vanilla items. Think carefully about where your mod's users would expect the item to be. For example, if you are adding a new type of wood, placing your item after the existing types of wood would make the most sense.

For example, this event handler will place your mod's item after the oak door in the building blocks item group:

  1. ItemGroupEvents.modifyEntriesEvent(ItemGroups.BUILDING_BLOCKS).register(content -> {
  2. content.addAfter(Items.OAK_DOOR, CUSTOM_ITEM);
  3. });

Creating an Item Group

Before you create an item group, determine whether it would have enough content to warrant its own group. Your item group will be placed on a separate page of tabs, impacting its discoverability, and users may be confused if the item is not where similar items are in the creative inventory.

If you think that your own item group is needed, you can use the FabricItemGroup.builder method to create a builder for an item group. Make sure to call the build method as well:

  1. private static final ItemGroup ITEM_GROUP = FabricItemGroup.builder(new Identifier("tutorial", "test_group"))
  2. .icon(() -> new ItemStack(CUSTOM_ITEM))
  3. .build();

You can use ITEM_GROUP to modify entries just like a vanilla item group. Note that you must add the items in order since there are no vanilla items to position them relative to:

  1. ItemGroupEvents.modifyEntriesEvent(ITEM_GROUP).register(content -> {
  2. content.add(CUSTOM_ITEM);
  3. });

tutorial/1.19/itemgroup.txt · Last modified: 2023/06/11 08:31 by mcrafterzz