How to generate a block's model with datagen in a Minecraft mod
Data generation writes a mod’s JSON (models, blockstates, recipes, loot tables, tags) from code, so it stays right as the mod grows. Fabric API runs DataGeneratorEntrypoints (the fabric-datagen entrypoint, with fabricApi { configureDataGeneration() } in build.gradle) through runDatagen into src/main/generated; Forge and NeoForge run GatherDataEvent listeners through runData into src/generated/resources. Here a model provider writes a cube block’s blockstate and models.
Works on Minecraft 1.20.1 to 26.3 on NeoForge; Minecraft 1.18.2 to 26.3 on Fabric; Minecraft 1.16.5 to 1.20.1 on Forge. Each example was compiled against its loader and version before it shipped in Linen.
- Set up datagen for the loader.
- Write a model provider that makes the block’s models (createTrivialCube, or simpleBlockWithItem in a BlockStateProvider).
- Register the provider.
- Run runDatagen (Fabric) or runData (Forge and NeoForge) and commit what it writes.
For each loader and version
Section titled “For each loader and version”The example mod is examplemod in the package com.example.examplemod. Use your own mod id and package.
Fabric 1.19.3 to 1.21.1
Section titled “Fabric 1.19.3 to 1.21.1”Uses:
DataGeneratorEntrypointFabricDataGenerator.createPackFabricModelProviderBlockModelGenerators.createTrivialCube
Run ./gradlew runDatagen: the blockstate and models are written to src/main/generated.
src/main/java/com/example/examplemod/datagen/ExampleModDataGenerator.java
package com.example.examplemod.datagen;
import net.fabricmc.fabric.api.datagen.v1.DataGeneratorEntrypoint;import net.fabricmc.fabric.api.datagen.v1.FabricDataGenerator;
// Fabric API's datagen entrypoint ("fabric-datagen" in fabric.mod.json): ./gradlew runDatagen runs the providers added here.public class ExampleModDataGenerator implements DataGeneratorEntrypoint { @Override public void onInitializeDataGenerator(FabricDataGenerator generator) { FabricDataGenerator.Pack pack = generator.createPack(); }}src/main/java/com/example/examplemod/datagen/MarbleModelProvider.java
package com.example.examplemod.datagen;
import com.example.examplemod.registry.ModBlocks;import net.fabricmc.fabric.api.datagen.v1.FabricDataOutput;import net.fabricmc.fabric.api.datagen.v1.provider.FabricModelProvider;import net.minecraft.data.models.BlockModelGenerators;import net.minecraft.data.models.ItemModelGenerators;
// Writes Marble's blockstate and models (a cube with its texture on every side) when datagen runs.public class MarbleModelProvider extends FabricModelProvider { public MarbleModelProvider(FabricDataOutput output) { super(output); }
@Override public void generateBlockStateModels(BlockModelGenerators generators) { generators.createTrivialCube(ModBlocks.MARBLE); }
@Override public void generateItemModels(ItemModelGenerators generators) { }}In src/main/java/com/example/examplemod/datagen/ExampleModDataGenerator.java, inside onInitializeDataGenerator:
pack.addProvider(MarbleModelProvider::new);In src/main/resources/fabric.mod.json, add this to the list at /entrypoints/fabric-datagen:
"com.example.examplemod.datagen.ExampleModDataGenerator"Add this line to build.gradle:
fabricApi { configureDataGeneration() { client = true } }It’s registered like any other block: see a new block.
NeoForge 1.20.2 to 1.21.1, NeoForge 1.21.2 to 1.21.3
Section titled “NeoForge 1.20.2 to 1.21.1, NeoForge 1.21.2 to 1.21.3”Uses:
GatherDataEventBlockStateProvider.simpleBlockWithItemBlockStateProvider.cubeAllDataGenerator.addProvider
Run ./gradlew runData: the blockstate and models are written to src/generated/resources.
src/main/java/com/example/examplemod/datagen/MarbleBlockStateProvider.java
package com.example.examplemod.datagen;
import com.example.examplemod.ExampleMod;import com.example.examplemod.registry.ModBlocks;import net.minecraft.data.PackOutput;import net.neoforged.neoforge.client.model.generators.BlockStateProvider;import net.neoforged.neoforge.common.data.ExistingFileHelper;import net.neoforged.neoforge.data.event.GatherDataEvent;
// Writes Marble's blockstate, block model and item model (a cube with its texture on every side) when ./gradlew runData runs.public class MarbleBlockStateProvider extends BlockStateProvider { public MarbleBlockStateProvider(PackOutput output, ExistingFileHelper existingFileHelper) { super(output, ExampleMod.MOD_ID, existingFileHelper); }
@Override protected void registerStatesAndModels() { simpleBlockWithItem(ModBlocks.MARBLE.get(), cubeAll(ModBlocks.MARBLE.get())); }
// Listens on the mod event bus (the mod's constructor) when datagen runs. public static void gather(GatherDataEvent event) { event.getGenerator().addProvider(event.includeClient(), new MarbleBlockStateProvider(event.getGenerator().getPackOutput(), event.getExistingFileHelper())); }}In your main mod class, inside <init>:
modEventBus.addListener(MarbleBlockStateProvider::gather);It’s registered like any other block: see a new block.
Fabric 1.21.2 to 1.21.3
Section titled “Fabric 1.21.2 to 1.21.3”Uses:
DataGeneratorEntrypointFabricDataGenerator.createPackFabricModelProviderBlockModelGenerators.createTrivialCube
Run ./gradlew runDatagen: the blockstate and models are written to src/main/generated. This is the pre-1.21.4 datagen API (net.minecraft.data.models); 1.21.4 moved it to net.minecraft.client.data.models.
src/main/java/com/example/examplemod/datagen/ExampleModDataGenerator.java
package com.example.examplemod.datagen;
import net.fabricmc.fabric.api.datagen.v1.DataGeneratorEntrypoint;import net.fabricmc.fabric.api.datagen.v1.FabricDataGenerator;
// Fabric API's datagen entrypoint ("fabric-datagen" in fabric.mod.json): ./gradlew runDatagen runs the providers added here.public class ExampleModDataGenerator implements DataGeneratorEntrypoint { @Override public void onInitializeDataGenerator(FabricDataGenerator generator) { FabricDataGenerator.Pack pack = generator.createPack(); }}src/main/java/com/example/examplemod/datagen/MarbleModelProvider.java
package com.example.examplemod.datagen;
import com.example.examplemod.registry.ModBlocks;import net.fabricmc.fabric.api.datagen.v1.FabricDataOutput;import net.fabricmc.fabric.api.datagen.v1.provider.FabricModelProvider;import net.minecraft.data.models.BlockModelGenerators;import net.minecraft.data.models.ItemModelGenerators;
// Writes Marble's blockstate and models (a cube with its texture on every side) when datagen runs.public class MarbleModelProvider extends FabricModelProvider { public MarbleModelProvider(FabricDataOutput output) { super(output); }
@Override public void generateBlockStateModels(BlockModelGenerators generators) { generators.createTrivialCube(ModBlocks.MARBLE); }
@Override public void generateItemModels(ItemModelGenerators generators) { }}In src/main/java/com/example/examplemod/datagen/ExampleModDataGenerator.java, inside onInitializeDataGenerator:
pack.addProvider(MarbleModelProvider::new);In src/main/resources/fabric.mod.json, add this to the list at /entrypoints/fabric-datagen:
"com.example.examplemod.datagen.ExampleModDataGenerator"Add this line to build.gradle:
fabricApi { configureDataGeneration() { client = true } }It’s registered like any other block: see a new block.
Fabric 1.21.4 to 1.21.11
Section titled “Fabric 1.21.4 to 1.21.11”Uses:
DataGeneratorEntrypointFabricDataGenerator.createPackFabricModelProviderBlockModelGenerators.createTrivialCube
Run ./gradlew runDatagen: the blockstate and models are written to src/main/generated.
src/main/java/com/example/examplemod/datagen/ExampleModDataGenerator.java
package com.example.examplemod.datagen;
import net.fabricmc.fabric.api.datagen.v1.DataGeneratorEntrypoint;import net.fabricmc.fabric.api.datagen.v1.FabricDataGenerator;
// Fabric API's datagen entrypoint ("fabric-datagen" in fabric.mod.json): ./gradlew runDatagen runs the providers added here.public class ExampleModDataGenerator implements DataGeneratorEntrypoint { @Override public void onInitializeDataGenerator(FabricDataGenerator generator) { FabricDataGenerator.Pack pack = generator.createPack(); }}src/main/java/com/example/examplemod/datagen/MarbleModelProvider.java
package com.example.examplemod.datagen;
import com.example.examplemod.registry.ModBlocks;import net.fabricmc.fabric.api.datagen.v1.FabricDataOutput;import net.fabricmc.fabric.api.client.datagen.v1.provider.FabricModelProvider;import net.minecraft.client.data.models.BlockModelGenerators;import net.minecraft.client.data.models.ItemModelGenerators;
// Writes Marble's blockstate and models (a cube with its texture on every side) when datagen runs.public class MarbleModelProvider extends FabricModelProvider { public MarbleModelProvider(FabricDataOutput output) { super(output); }
@Override public void generateBlockStateModels(BlockModelGenerators generators) { generators.createTrivialCube(ModBlocks.MARBLE); }
@Override public void generateItemModels(ItemModelGenerators generators) { }}In src/main/java/com/example/examplemod/datagen/ExampleModDataGenerator.java, inside onInitializeDataGenerator:
pack.addProvider(MarbleModelProvider::new);In src/main/resources/fabric.mod.json, add this to the list at /entrypoints/fabric-datagen:
"com.example.examplemod.datagen.ExampleModDataGenerator"Add this line to build.gradle:
fabricApi { configureDataGeneration() { client = true } }It’s registered like any other block: see a new block.
NeoForge 1.21.4 to 26.3
Section titled “NeoForge 1.21.4 to 26.3”Uses:
GatherDataEvent.Client.createProviderModelProviderBlockModelGenerators.createTrivialCube
Run ./gradlew runData: the blockstate and models are written to src/generated/resources.
src/main/java/com/example/examplemod/datagen/MarbleBlockStateProvider.java
package com.example.examplemod.datagen;
import com.example.examplemod.ExampleMod;import net.minecraft.client.data.models.BlockModelGenerators;import net.minecraft.client.data.models.ItemModelGenerators;import net.minecraft.client.data.models.ModelProvider;import net.minecraft.data.PackOutput;import net.neoforged.neoforge.data.event.GatherDataEvent;import com.example.examplemod.registry.ModBlocks;
// Writes Marble's blockstate, block model and item model (a cube with its texture on every side) when ./gradlew runData runs.public class MarbleBlockStateProvider extends ModelProvider { public MarbleBlockStateProvider(PackOutput output) { super(output, ExampleMod.MOD_ID); }
@Override protected void registerModels(BlockModelGenerators blockModels, ItemModelGenerators itemModels) { blockModels.createTrivialCube(ModBlocks.MARBLE.get()); }
// Listens on the mod event bus (the mod's constructor) when datagen runs; models are client data. public static void gather(GatherDataEvent.Client event) { event.createProvider(MarbleBlockStateProvider::new); }}In your main mod class, inside <init>:
modEventBus.addListener(MarbleBlockStateProvider::gather);It’s registered like any other block: see a new block.
Fabric 26.1 to 26.3
Section titled “Fabric 26.1 to 26.3”Uses:
DataGeneratorEntrypointFabricDataGenerator.createPackFabricModelProviderBlockModelGenerators.createTrivialCube
Run ./gradlew runDatagen: the blockstate and models are written to src/main/generated.
src/main/java/com/example/examplemod/datagen/ExampleModDataGenerator.java
package com.example.examplemod.datagen;
import net.fabricmc.fabric.api.datagen.v1.DataGeneratorEntrypoint;import net.fabricmc.fabric.api.datagen.v1.FabricDataGenerator;
// Fabric API's datagen entrypoint ("fabric-datagen" in fabric.mod.json): ./gradlew runDatagen runs the providers added here.public class ExampleModDataGenerator implements DataGeneratorEntrypoint { @Override public void onInitializeDataGenerator(FabricDataGenerator generator) { FabricDataGenerator.Pack pack = generator.createPack(); }}src/main/java/com/example/examplemod/datagen/MarbleModelProvider.java
package com.example.examplemod.datagen;
import com.example.examplemod.registry.ModBlocks;import net.fabricmc.fabric.api.datagen.v1.FabricPackOutput;import net.fabricmc.fabric.api.client.datagen.v1.provider.FabricModelProvider;import net.minecraft.client.data.models.BlockModelGenerators;import net.minecraft.client.data.models.ItemModelGenerators;
// Writes Marble's blockstate and models (a cube with its texture on every side) when datagen runs.public class MarbleModelProvider extends FabricModelProvider { public MarbleModelProvider(FabricPackOutput output) { super(output); }
@Override public void generateBlockStateModels(BlockModelGenerators generators) { generators.createTrivialCube(ModBlocks.MARBLE); }
@Override public void generateItemModels(ItemModelGenerators generators) { }}In src/main/java/com/example/examplemod/datagen/ExampleModDataGenerator.java, inside onInitializeDataGenerator:
pack.addProvider(MarbleModelProvider::new);In src/main/resources/fabric.mod.json, add this to the list at /entrypoints/fabric-datagen:
"com.example.examplemod.datagen.ExampleModDataGenerator"Add this line to build.gradle:
fabricApi { configureDataGeneration() { client = true } }It’s registered like any other block: see a new block.
Forge 1.17.1 to 1.18.2
Section titled “Forge 1.17.1 to 1.18.2”Uses:
GatherDataEventBlockStateProvider.simpleBlockWithItemBlockStateProvider.cubeAllDataGenerator.addProvider
Run ./gradlew runData: the blockstate and models are written to src/generated/resources.
src/main/java/com/example/examplemod/datagen/MarbleBlockStateProvider.java
package com.example.examplemod.datagen;
import com.example.examplemod.ExampleMod;import com.example.examplemod.registry.ModBlocks;import net.minecraft.data.DataGenerator;import net.minecraftforge.client.model.generators.BlockStateProvider;import net.minecraftforge.common.data.ExistingFileHelper;import net.minecraftforge.forge.event.lifecycle.GatherDataEvent;
// Writes Marble's blockstate, block model and item model (a cube with its texture on every side) when ./gradlew runData runs.public class MarbleBlockStateProvider extends BlockStateProvider { public MarbleBlockStateProvider(DataGenerator generator, ExistingFileHelper existingFileHelper) { super(generator, ExampleMod.MOD_ID, existingFileHelper); }
@Override protected void registerStatesAndModels() { simpleBlock(ModBlocks.MARBLE.get()); simpleBlockItem(ModBlocks.MARBLE.get(), cubeAll(ModBlocks.MARBLE.get())); }
// Listens on the mod event bus (the mod's constructor) when datagen runs. public static void gather(GatherDataEvent event) { if (event.includeClient()) { event.getGenerator().addProvider(new MarbleBlockStateProvider(event.getGenerator(), event.getExistingFileHelper())); } }}In your main mod class, inside <init>:
modEventBus.addListener(MarbleBlockStateProvider::gather);It’s registered like any other block: see a new block.
Forge 1.19 to 1.19.2
Section titled “Forge 1.19 to 1.19.2”Uses:
GatherDataEventBlockStateProvider.simpleBlockWithItemBlockStateProvider.cubeAllDataGenerator.addProvider
Run ./gradlew runData: the blockstate and models are written to src/generated/resources.
src/main/java/com/example/examplemod/datagen/MarbleBlockStateProvider.java
package com.example.examplemod.datagen;
import com.example.examplemod.ExampleMod;import com.example.examplemod.registry.ModBlocks;import net.minecraft.data.DataGenerator;import net.minecraftforge.client.model.generators.BlockStateProvider;import net.minecraftforge.common.data.ExistingFileHelper;import net.minecraftforge.data.event.GatherDataEvent;
// Writes Marble's blockstate, block model and item model (a cube with its texture on every side) when ./gradlew runData runs.public class MarbleBlockStateProvider extends BlockStateProvider { public MarbleBlockStateProvider(DataGenerator generator, ExistingFileHelper existingFileHelper) { super(generator, ExampleMod.MOD_ID, existingFileHelper); }
@Override protected void registerStatesAndModels() { simpleBlock(ModBlocks.MARBLE.get()); simpleBlockItem(ModBlocks.MARBLE.get(), cubeAll(ModBlocks.MARBLE.get())); }
// Listens on the mod event bus (the mod's constructor) when datagen runs. public static void gather(GatherDataEvent event) { event.getGenerator().addProvider(event.includeClient(), new MarbleBlockStateProvider(event.getGenerator(), event.getExistingFileHelper())); }}In your main mod class, inside <init>:
modEventBus.addListener(MarbleBlockStateProvider::gather);It’s registered like any other block: see a new block.
Forge 1.19.3 to 1.20.1, NeoForge 1.20.1
Section titled “Forge 1.19.3 to 1.20.1, NeoForge 1.20.1”Uses:
GatherDataEventBlockStateProvider.simpleBlockWithItemBlockStateProvider.cubeAllDataGenerator.addProvider
Run ./gradlew runData: the blockstate and models are written to src/generated/resources.
src/main/java/com/example/examplemod/datagen/MarbleBlockStateProvider.java
package com.example.examplemod.datagen;
import com.example.examplemod.ExampleMod;import com.example.examplemod.registry.ModBlocks;import net.minecraft.data.PackOutput;import net.minecraftforge.client.model.generators.BlockStateProvider;import net.minecraftforge.common.data.ExistingFileHelper;import net.minecraftforge.data.event.GatherDataEvent;
// Writes Marble's blockstate, block model and item model (a cube with its texture on every side) when ./gradlew runData runs.public class MarbleBlockStateProvider extends BlockStateProvider { public MarbleBlockStateProvider(PackOutput output, ExistingFileHelper existingFileHelper) { super(output, ExampleMod.MOD_ID, existingFileHelper); }
@Override protected void registerStatesAndModels() { simpleBlockWithItem(ModBlocks.MARBLE.get(), cubeAll(ModBlocks.MARBLE.get())); }
// Listens on the mod event bus (the mod's constructor) when datagen runs. public static void gather(GatherDataEvent event) { event.getGenerator().addProvider(event.includeClient(), new MarbleBlockStateProvider(event.getGenerator().getPackOutput(), event.getExistingFileHelper())); }}In your main mod class, inside <init>:
modEventBus.addListener(MarbleBlockStateProvider::gather);It’s registered like any other block: see a new block.
Fabric 1.18.2 to 1.19.2
Section titled “Fabric 1.18.2 to 1.19.2”Uses:
DataGeneratorEntrypointFabricDataGenerator.createPackFabricModelProviderBlockModelGenerators.createTrivialCube
src/main/java/com/example/examplemod/datagen/ExampleModDataGenerator.java
package com.example.examplemod.datagen;
import net.fabricmc.fabric.api.datagen.v1.DataGeneratorEntrypoint;import net.fabricmc.fabric.api.datagen.v1.FabricDataGenerator;
// Fabric API's datagen entrypoint ("fabric-datagen" in fabric.mod.json): ./gradlew runDatagen runs the providers added here.public class ExampleModDataGenerator implements DataGeneratorEntrypoint { @Override public void onInitializeDataGenerator(FabricDataGenerator generator) { }}src/main/java/com/example/examplemod/datagen/MarbleModelProvider.java
package com.example.examplemod.datagen;
import com.example.examplemod.registry.ModBlocks;import net.fabricmc.fabric.api.datagen.v1.FabricDataGenerator;import net.fabricmc.fabric.api.datagen.v1.provider.FabricModelProvider;import net.minecraft.data.models.BlockModelGenerators;import net.minecraft.data.models.ItemModelGenerators;
// Writes Marble's blockstate and models (a cube with its texture on every side) when datagen runs.public class MarbleModelProvider extends FabricModelProvider { public MarbleModelProvider(FabricDataGenerator generator) { super(generator); }
@Override public void generateBlockStateModels(BlockModelGenerators generators) { generators.createTrivialCube(ModBlocks.MARBLE); }
@Override public void generateItemModels(ItemModelGenerators generators) { }}In src/main/java/com/example/examplemod/datagen/ExampleModDataGenerator.java, inside onInitializeDataGenerator:
generator.addProvider(MarbleModelProvider::new);In src/main/resources/fabric.mod.json, add this to the list at /entrypoints/fabric-datagen:
"com.example.examplemod.datagen.ExampleModDataGenerator"Add this line to build.gradle:
fabricApi { configureDataGeneration() { client = true } }It’s registered like any other block: see a new block.
Forge 1.16.5
Section titled “Forge 1.16.5”Uses:
BlockStateProvider.registerStatesAndModelsBlockStateProvider.simpleBlockBlockStateProvider.simpleBlockItemGatherDataEvent
Run ./gradlew runData: the blockstate and models are written to src/generated/resources.
src/main/java/com/example/examplemod/datagen/MarbleBlockStateProvider.java
package com.example.examplemod.datagen;
import com.example.examplemod.ExampleMod;import com.example.examplemod.registry.ModBlocks;import net.minecraft.data.DataGenerator;import net.minecraftforge.client.model.generators.BlockStateProvider;import net.minecraftforge.common.data.ExistingFileHelper;import net.minecraftforge.fml.event.lifecycle.GatherDataEvent;
// Writes Marble's blockstate, block model and item model (a cube with its texture on every side) when ./gradlew runData runs.public class MarbleBlockStateProvider extends BlockStateProvider { public MarbleBlockStateProvider(DataGenerator generator, ExistingFileHelper existingFileHelper) { super(generator, ExampleMod.MOD_ID, existingFileHelper); }
@Override protected void registerStatesAndModels() { simpleBlock(ModBlocks.MARBLE.get()); simpleBlockItem(ModBlocks.MARBLE.get(), cubeAll(ModBlocks.MARBLE.get())); }
// Listens on the mod event bus (the mod's constructor) when datagen runs. public static void gather(GatherDataEvent event) { if (event.includeClient()) { event.getGenerator().addProvider(new MarbleBlockStateProvider(event.getGenerator(), event.getExistingFileHelper())); } }}In your main mod class, inside <init>:
modEventBus.addListener(MarbleBlockStateProvider::gather);It’s registered like any other block: see a new block.
Sources
Section titled “Sources”- https://docs.fabricmc.net/1.21.1/develop/data-generation/setup
- https://docs.fabricmc.net/1.21.11/develop/data-generation/block-models
- https://docs.neoforged.net/docs/1.21.1/resources/
- https://docs.neoforged.net/docs/1.21.1/resources/client/models/datagen
Related how-tos
Section titled “Related how-tos”- A block entity that ticks
- A mob with attributes and a spawn egg
- A recipe type of your own
- Generate a crafting recipe with datagen
- Generate block tags with datagen
In Linen
Section titled “In Linen”Linen’s How-tos library has this page too, with the example for your own mod’s loader and Minecraft version. Hover a name in your code and Linen points to the how-tos that explain it. Both are free. Download Linen.