[1.16.1] The Book of Minecraft Modding - complete guide for beginners

[tcode2k16]

I got into minecraft modding recently and was surprised by how hard it is to find useful up-to-date information. Because of that, I decided to document my learning journey and write a book about Minecraft modding for beginners. It applies to Minecraft 1.16.1 and the latest version of forge.

 

Keep in mind it is still a work in progress. More chapters will be added in the coming days. Suggestions and questions also are welcomed.

 

Link: https://thebookofmodding.ml/

[patryk0328]

Would you add particles, moving mobs like wind and flinging blocks pls because i want to make a working tornado mod. thx.

[ChampionAsh5357]

Please use object holder to "hold" the block and item instances when registering or use deferred register if you're going to statically initialize anything. What you have written for custom blocks is just wrong.

[Maxi07]

6 hours ago, ChampionAsh5357 said:

Please use object holder to "hold" the block and item instances when registering or use deferred register if you're going to statically initialize anything. What you have written for custom blocks is just wrong.

I register my items and blocks similar:

 

RegisterBlocks.java

package maxi.ores_cores.init;

import maxi.ores_cores.OresCores;
import maxi.ores_cores.blocks.*;
import maxi.ores_cores.items.BasicBlockItem;
import net.minecraft.block.Block;
import net.minecraft.item.Item;
import net.minecraft.item.ItemGroup;
import net.minecraftforge.event.RegistryEvent.Register;
import net.minecraftforge.eventbus.api.SubscribeEvent;
import net.minecraftforge.fml.common.Mod.EventBusSubscriber;
import net.minecraftforge.fml.common.Mod.EventBusSubscriber.Bus;
import net.minecraftforge.registries.IForgeRegistry;

@EventBusSubscriber(modid = OresCores.MODID, bus = Bus.MOD)
public class RegisterBlocks {

	@SubscribeEvent
	public static void registerBlock(Register<Block> event) {
		final IForgeRegistry<Block> registry = event.getRegistry();
		registry.register(MetalBlock.EMOULRITE_BLOCK.setRegistryName(OresCores.MODID, "emoulrite_block"));
		registry.register(Ore.EMOULRITE_ORE.setRegistryName(OresCores.MODID, "emoulrite_ore"));
		registry.register(MetalBlock.TELERITE_BLOCK.setRegistryName(OresCores.MODID, "telerite_block"));
		registry.register(Ore.TELERITE_ORE.setRegistryName(OresCores.MODID, "telerite_ore"));
	}
	
	@SubscribeEvent
	public static void registerItem(Register<Item> event) {
		final IForgeRegistry<Item> registry = event.getRegistry();
		registry.register(new BasicBlockItem(MetalBlock.EMOULRITE_BLOCK, ItemGroup.BUILDING_BLOCKS));
		registry.register(new BasicBlockItem(Ore.EMOULRITE_ORE, ItemGroup.BUILDING_BLOCKS));
		registry.register(new BasicBlockItem(MetalBlock.TELERITE_BLOCK, ItemGroup.BUILDING_BLOCKS));
		registry.register(new BasicBlockItem(Ore.TELERITE_ORE, ItemGroup.BUILDING_BLOCKS));
	}
}

 

MetalBlock.java (Ore.java is similar)

package maxi.ores_cores.blocks;

import net.minecraft.block.SoundType;
import net.minecraft.block.Block;
import net.minecraft.block.Block.Properties;
import net.minecraft.block.material.Material;
import net.minecraft.block.material.MaterialColor;
import net.minecraftforge.common.ToolType;

public class MetalBlock {
	
	public static final Block EMOULRITE_BLOCK = new Block(Properties
								.create(Material.IRON, MaterialColor.GOLD).sound(SoundType.METAL)
								.hardnessAndResistance(5, 6)
								.harvestTool(ToolType.PICKAXE).harvestLevel(2));
	
	public static final Block TELERITE_BLOCK = new Block(Properties
								.create(Material.IRON, MaterialColor.PURPLE).sound(SoundType.METAL)
								.hardnessAndResistance(5, 6)
								.harvestTool(ToolType.PICKAXE).harvestLevel(2));
	
}

 

BasicBlockItem.java

package maxi.ores_cores.items;

import net.minecraft.block.Block;
import net.minecraft.item.BlockItem;
import net.minecraft.item.ItemGroup;

public class BasicBlockItem extends BlockItem {

	public BasicBlockItem(Block block, ItemGroup group) {
		super(block, new Properties().group(group));
		setRegistryName(block.getRegistryName());
	}

}

 

Whats bad about this? I am new to modding and I appreciate every suggestion for improvement that I get

[Maxi07]

3 minutes ago, diesieben07 said:

Registration must occur during a very specific time (when the registry event is fired). By using a static initializer you are completely bypassing this and doing it when your class is initialized, which is not easy to know when it is.

So I should make the methods that register the blocks and items non static?

[Maxi07]

2 hours ago, Maxi07 said:

public static final Block EMOULRITE_BLOCK = new Block(Properties .create(Material.IRON, MaterialColor.GOLD).sound(SoundType.METAL) .hardnessAndResistance(5, 6) .harvestTool(ToolType.PICKAXE).harvestLevel(2));

Oh okay, you mean this, right?

 

EDIT: Thanks for helping me improving my code @diesieben07

Edited July 4, 2020 by Maxi07

[tcode2k16]

On 7/4/2020 at 10:11 AM, ChampionAsh5357 said:

Please use object holder to "hold" the block and item instances when registering or use deferred register if you're going to statically initialize anything. What you have written for custom blocks is just wrong.

Thanks for pointing this out!

 

I updated the tutorial to use deferred registers.

 

Please let me know if you spot any further errors. I am happy to correct them as well

[zenglintao]

On 7/4/2020 at 1:09 AM, tcode2k16 said:

I got into minecraft modding recently and was surprised by how hard it is to find useful up-to-date information. Because of that, I decided to document my learning journey and write a book about Minecraft modding for beginners. It applies to Minecraft 1.16.1 and the latest version of forge.

 

Keep in mind it is still a work in progress. More chapters will be added in the coming days. Suggestions and questions also are welcomed.

 

Link: https://thebookofmodding.ml/

I want to know how to create and register an Events

[Novârch]

41 minutes ago, zenglintao said:

I want to know how to create and register an Events

Extend Event, then call MinecraftForge#EVENT_BUS#register to register it, remember you have to fire your event manually using MinecraftForge#EVENT_BUS#post.

Edited July 6, 2020 by Novârch

[Ugdhar]

Hopefully you make it further than most tutorial makers, who give up after all they cover the same stuff everyone else does!

 

Best of luck to you!

[Dernert]

Awesome. Please continue!

[Maxi07]

On 7/4/2020 at 4:11 AM, ChampionAsh5357 said:

Please use object holder to "hold" the block and item instances when registering or use deferred register if you're going to statically initialize anything.

Okay, now I am finally continue with modding. I am changing my whole registration system and how I add blocks and items. I dont want the static intializer problem, but I dont want to use DefferedRegisries either (please dont ask why). So I looked at the minecraft classes net.minecraft.block.Blocks and net.minecraft.item.Items where the minecraft blocks and items are registered. I want to do this similar. I should use ObjectHolders. I searched how they work but I couldn't find something that could help me. And now I am asking here. And please say if you have an idea how i could make my registration system without DefferedRegisries and problems.

Thanks!

Edited July 15, 2020 by Maxi07

[Novârch]

5 minutes ago, Maxi07 said:

I dont want the static intializer problem, but I dont want to use DefferedRegisries either

RegistryEvent, don't use vanilla registration if there is a Forge version available.

[Maxi07]

So will this already work?

package maxi.ores_cores.init;

import maxi.ores_cores.OresCores;
import maxi.ores_cores.items.BasicBlockItem;
import net.minecraft.block.Block;
import net.minecraft.block.SoundType;
import net.minecraft.block.Block.Properties;
import net.minecraft.block.material.Material;
import net.minecraft.block.material.MaterialColor;
import net.minecraft.item.Item;
import net.minecraft.item.ItemGroup;
import net.minecraftforge.common.ToolType;
import net.minecraftforge.event.RegistryEvent.Register;
import net.minecraftforge.eventbus.api.SubscribeEvent;
import net.minecraftforge.fml.common.Mod.EventBusSubscriber;
import net.minecraftforge.fml.common.Mod.EventBusSubscriber.Bus;
import net.minecraftforge.registries.IForgeRegistry;
import net.minecraftforge.registries.ObjectHolder;

@EventBusSubscriber(modid = OresCores.MODID, bus = Bus.MOD)
@ObjectHolder(value = OresCores.MODID)
public class RegisterBlocks {

	public static final Block EXAMPLE_BLOCK = new Block(Properties.create(Material.ROCK, MaterialColor.STONE).sound(SoundType.STONE).hardnessAndResistance(3, 3).harvestTool(ToolType.PICKAXE).harvestLevel(2));
	
	@SubscribeEvent
	public static void registerBlock(Register<Block> event) {
		final IForgeRegistry<Block> registry = event.getRegistry();
		registry.register(EXAMPLE_BLOCK.setRegistryName(OresCores.MODID, "emoulrite_block"));
	}
	
	@SubscribeEvent
	public static void registerItem(Register<Item> event) {
		final IForgeRegistry<Item> registry = event.getRegistry();
		registry.register(new BasicBlockItem(EXAMPLE_BLOCK, ItemGroup.BUILDING_BLOCKS));
	}
}

 

[Maxi07]

Okay, then what I have to change? I want to have one instance of my block. Or is this stupid?

Sorry for being a bit annoying

[Maxi07]

Of course, that makes a lot of sense! Excuse me for this silly question, but how I obtain my instance outside the registration?

[Maxi07]

Now it finally works! Every tutorial I've seen used static initializers. What are the problems, why I should avoid them (I know you said something about timing above)? And by the way, is my code now finally not bad?

@EventBusSubscriber(modid = OresCores.MODID, bus = Bus.MOD)
public class RegisterBlocks {

	@SubscribeEvent
	public static void registerBlock(Register<Block> event) {
		
		final Block EXAMPLE_BLOCK = new Block(Properties.create(Material.ROCK, MaterialColor.STONE).sound(SoundType.STONE).hardnessAndResistance(3, 3).harvestTool(ToolType.PICKAXE).harvestLevel(2));
		
		final IForgeRegistry<Block> registry = event.getRegistry();
		registry.register(EXAMPLE_BLOCK.setRegistryName(OresCores.MODID, "example_block"));
	}
	
	@SubscribeEvent
	public static void registerItem(Register<Item> event) {
		final IForgeRegistry<Item> registry = event.getRegistry();
		registry.register(new BasicBlockItem(Blocks.EXAMPLE_BLOCK, ItemGroup.BUILDING_BLOCKS));
	}
}

Blocks.java:

@ObjectHolder(value = OresCores.MODID)
public class Blocks {

	public static final Block EXAMPLE_BLOCK = null;
	
}

 

[ChampionAsh5357]

10 hours ago, diesieben07 said:

Unfortunately most modding tutorials are written by amateurs, who don't even come here to ask for feedback before posting it as just "the way to do it" on Youtube, etc.

As prior amateur, I can attest to this. Currently, I am trying to improve my skills and knowledge by being active on these forms and verifying all of what I want to say. I believe the only tutorials currently recommended are those by McJty. If you need help on a problem that you cannot deconstruct by yourself, you should always turn to the forms or the forge discord.

[Marconium2]

when you create your RegistryHandler class, it would have been helpful if you showed what you put in the import ...;   section. It took me quite a while to figure out what to import.

[FrostDracony]

You just give me the inspiration to do the same (of course as soon as I know more about forge and complex stuff😅).

https://thebookofmodding.ml/adding-custom-items/
 

package com.example.examplemod;

import ...;

public class RegistryHandler {
    // create DeferredRegister object
    public static final DeferredRegister<Item> ITEMS = DeferredRegister.create(ForgeRegistries.ITEMS, ExampleMod.MODID);

    public static void init() {
        // attach DeferredRegister to the event bus
        ITEMS.register(FMLJavaModLoadingContext.get().getModEventBus());
    }

    // register item
    public static final RegistryObject<Item> COPPER = ITEMS.register("copper", () ->
            new Item(
                    new Item.Properties().group(ItemGroup.MATERIALS)
            )
    );
}

 

    public static void init() {
        // attach DeferredRegister to the event bus
        ITEMS.register(FMLJavaModLoadingContext.get().getModEventBus());
    }

 

Personally I register this here in the constructor of my main class, just confirm. And to keep everything organized, I create a class for every DeferredRegister (e.g. the Item DeferredRegister is in a class called "ModItems" and there are all my items), I do this for every DeferredRegister I use, but this is just a small detail and everybody has the freedom to do what he wants. (I register the bus in my mainclass constructor and separate the items from the blocks, the blocks from the potions etc.)

https://thebookofmodding.ml/
I also wanted to ask (I know that 99.99% doesn't respect this anyway, but you should always do it) that you tell the readers on the start page that they should know Java first. As I said before, 99.99% of people don't read it and start right away, they get an error and ask you directly:

 

- some guy: "Some kind of generic error", hey you! Can you please solve it for me directly? I don't understand anything about generics…

- You: Have you at least learned Java?

(The answer is already: NO)
 

So you could also just the recommend readers java tutorials in the same way as cadiboo it did (bad english, srry):
https://cadiboo.github.io/tutorials/Pre-requisites/
 

Last question:

How did you create such a website? And do you pay to host it?

I am interested in it myself (as I said before) and don't know if I should program my own website or rather use a website generator like: Github Beautiful Jekyll.  Just asking (and I think it's one of the few website tutorials, though not the only one that supports DarkTheme. Sorry, but this is something to celebrate).

 

Hope these tips will help you (sorry if it's a bit long)

P.S.: 
https://thebookofmodding.ml/loot-tables/
https://thebookofmodding.ml/crafting-and-smeliting-recipes/
I would use a DataGenerator instead of doing this manually. If you want a tutorial about the DataGenerator:
https://mcforge.readthedocs.io/en/latest/datagen/intro/

Edited August 4, 2020 by FrostDracony

[depodoom]

I'm stuck on the 2nd part of creating an item where do I edit the do i make a new class project or do i add it to the bottom of the code thats there im kinda stupid

[chuckster.]

works fine up until RegistryHandler.init();. Comes up with init as red error, and RegistryHandler as depreciated with a cross through it. please help, cant find any solutions about it online.

[JabberWocky234]

Hey Could somebody here tell me how to make hostile mobs and make custom models for them and stuff I am a really big noob to this and know pretty much nothing I didnt really try and make one myself since i will most likely mess a lotta stuff up so i would really appreciate some help.
 

Edit: Also im Using 1.16

Edited August 24, 2020 by JabberWocky234
Unclarified Point

[FrostDracony]

S E A R C H   O N   Y O U T U B E  /  G O O G L E. You will find some tutorials, so really? Dont be too lazy. 

[ChampionAsh5357]

On 8/25/2020 at 4:14 PM, FrostDracony said:

S E A R C H   O N   Y O U T U B E  /  G O O G L E. You will find some tutorials, so really? Dont be too lazy. 

Probably not since most videos on youtube promote bad coding practices. Ask for help on the forums and use your brain. So, as you said, don't be too lazy.