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.
====== Tag Generation ======

The ''[[https://github.com/FabricMC/fabric/blob/1.19.2/fabric-data-generation-api-v1/src/main/java/net/fabricmc/fabric/api/datagen/v1/provider/FabricTagProvider.java|FabricTagProvider<T>]]'' class allows you to generate tag json files.

This page will follow you through all aspects of this provider.

To create a tag generator, create a class that extends ''FabricTagProvider<T>'', where ''T'' is the type of tag you want to generate, and register it at your datagen entrypoint like so:

<yarncode java>
private static class MyTagGenerator extends FabricTagProvider<Item> {
   public MyTagGenerator(FabricDataOutput output, CompletableFuture<class_7225.class_7874> registriesFuture) {
        super(output, class_7924.field_41197, registriesFuture);
   }

   @Override
   protected void configure(class_7225.class_7874 lookup) {
   
   }
}

// ...

@Override
public void onInitializeDataGenerator(FabricDataGenerator fabricDataGenerator) {
    FabricDataGenerator.Pack pack = fabricDataGenerator.createPack();
    // ...
    pack.add(MyTagGenerator::new);
    // ...
}
</yarncode>

The ''FabricTagProvider<T>'' class supports all supported tags, make sure to change the ''Registry'' in the constructor to the type you are generating your tags for.

===== Adding a tag =====

To add a tag, simply call the ''getOrCreateTagBuilder'' method with your supplied ''TagKey<T>'' in the ''configure(RegistryWrapper.WrapperLookup lookup)'' method like so:

<yarncode java>
public static final class_6862<class_1792> SMELLY_ITEMS = class_6862.method_40092(class_7924.field_41197, class_2960.of("mymod", "smelly_items"));
 
@Override
protected void configure(class_7225.class_7874 lookup) {
     // This creates a tag builder, where we add slime balls, rotten flesh and everything in the minecraft:dirt item tag.
     getOrCreateTagBuilder(SMELLY_ITEMS)
              .add(class_1802.field_8777)
              .add(class_1802.field_8511)
              .addOptionalTag(class_3489.field_36269);
     // This will automatically generate "data/mymod/tags/item/smelly_items.json" in the "generated" folder.
}
</yarncode>

Output from the example above:

<file javascript smelly_items.json>
{
  "replace": false,
  "values": [
    "minecraft:slime_ball",
    "minecraft:rotten_flesh",
    {
      "id": "#minecraft:dirt",
      "required": false
    }
  ]
}
</file>

===== Adding stuff to the builder =====

To add an item to your tag builder, simply call ''add(Item item)''.

If you want to add a tag to your builder, make sure to call ''addOptionalTag(TagKey<T> tag)'', as the tag's contents may not be loaded during data generation. If you are certain the tag is loaded, call ''addTag(TagKey<T> tag)''

Various overloads exist for ''addTag'', ''addOptionalTag'' and ''addItem'' that accepts ''Identifier''s, ''String''s and ''RegistryKey<T>''s

If you want to forcefully add a tag, ignoring the broken format, you can use ''forceAddTag(TagKey<T> tag)''

Finally, if you want your tag to replace pre-existing tags, you can use ''setReplace(boolean replace)''

An example that uses all of these methods can be found here:

<yarncode java>
public static final class_6862<class_1792> SMELLY_ITEMS = class_6862.method_40092(class_7924.field_41197, class_2960.of("mymod", "smelly_items"));

@Override
protected void configure(class_7225.class_7874 lookup) {
     getOrCreateTagBuilder(SMELLY_ITEMS)
                    .add(class_1802.field_8777)
                    .add(class_1802.field_8511)
                    .addOptionalTag(class_3489.field_36269)
                    .add(class_2960.of("minecraft", "wooden_planks"))
                    .forceAddTag(class_3489.field_15556)
                    .setReplace(true)
                    .add(class_1802.field_8511.method_40131().method_40237());
}
</yarncode>