Tenreg

A registration tool for modern Minecraft

Do registration, datagen, and manage your blocks and items from one place

WARNING: Tenreg is currently unstable. Each release may have breaking changes, and bugs may appear often. You can still use it, I use it in all my new mods now.

Installation

For users

Download Tenreg from Modrinth

For developers

A Welltemplate template exists, altough you need to compile it yourself

Use the new Nexusrealms maven repository, hosted on our Gitlab Find the version you want to use and click install to see instructions for your gradle / maven configuration Important In the install instructions, replace implementation with modImplementation

Usage

1. Create a Reg instance

//In your mod initializer
public class Mod implements ModInitializer {
    public static final String MOD_ID = "your mod id goes here";
    public static final Reg REG = Reg.create(MOD_ID);
    @Override
    public void onInitialize() {
        //Needed to load the class with your items and blocks
        ModItems.init();
        ModBlocks.init();
        //Register the entries
        REG.register();
    }
}

2. Create your Subregs

//In your ModBlocks.java
public class ModBlocks {
    private static final BlockReg BLOCKS = Mod.REG.getBlockReg();
}

3. Setup your datagen

//In your data generation entrypoint
public class ModDataGenerator implements DataGeneratorEntrypoint {
    @Override
    public void onInitializeDataGenerator(FabricDataGenerator fabricDataGenerator) {
        FabricDataGenerator.Pack pack = fabricDataGenerator.createPack();
        Mod.REG.genData(pack);
    }
}

4. Create your entries - you can use builders for more advanced patterns

//In your ModBlocks.java
public class ModBlocks {
    private static final BlockReg BLOCKS = Mod.REG.getBlockReg();
    public static final BlockEntry<Block> AWESOME_BLOCK = BLOCKS.builder()
            .constructor(Block::new)
            .transform(BlockToolTransformers.pickaxeOnly())
            .dropsSelf()
            .simpleCubeAll()
            .simpleItem()
            .name("Awesome block")
            .build("awesome_block");
}