Jump to content
Search the Forums BEFORE making a new post.
Currently supported: All versions

Is there any comprehensive documentation for Forge and Minecraft?

QuantumPie

By QuantumPie
in Modder Support

 Share

Recommended Posts

QuantumPie Tree Puncher

QuantumPie

Posted
Posted

I'm interested in creating mods for MC but as I research how to do this there doesn't seem to be a lot of documentation. The Forge Documentation seems to be the only official source of information I can find but it's not very comprehensive. Other than that I've been looking at mcjty's tutorials and MinecraftByExample          but that will only get you so far. Looking at those tutorials, I see a lot of inheritance going on but when I look at the parent classes implementation, there are seldom any comments explaining anything. Am I just supposed to scour through MC's source code and figure things out as I go? There is a guide on mcjty's wiki that says how to make a dimension but not biomes, how would I go about learning how to implement that? Better said, how did mcjty learn how to implement his own dimension assuming he had no other wiki to use? I'm also having a hard time finding up to date information on the internal workings of MC. I know a lot changed post 1.8 and most of those guides were pre, I'm not sure what differs. The only thing I'm guessing hasn't changed is there being only a client and server thread with a game loop.

Animefan8888 Reality Controller

Animefan8888

Posted
Posted
2 hours ago, QuantumPie said:

Am I just supposed to scour through MC's source code and figure things out as I go?

Basically yes. There are so many changes between versions keeping a comprehensive guide would be almost impossible. Its kinds why the forums exist in the first place. Its kind of a comprehensive guide. That has people who are constantly adding to it by making more posts. It's just not as organized as a guide. 

VANILLA MINECRAFT CLASSES ARE THE BEST RESOURCES WHEN MODDING

I will be posting 1.15.2 modding tutorials on this channel. If you want to be notified of it do the normal YouTube stuff like subscribing, ect.

Forge and vanilla BlockState generator.

Draco18s Reality Controller

Draco18s

Posted
Posted (edited)
2 hours ago, QuantumPie said:

Am I just supposed to scour through MC's source code and figure things out as I go?

Pretty much. There's comments on a lot of methods that tell you what they're for and most parameters can be inferred based on their Type.

2 hours ago, QuantumPie said:

how did mcjty learn how to implement his own dimension assuming he had no other wiki to use?

See prior comment. Mostly either by trial and error or by having done dimension work on a prior version and already knowing some of the things that were required.

2 hours ago, QuantumPie said:

but not biomes, how would I go about learning how to implement that?

Biomes work pretty much just like blocks and items. You just won't see them "spawn" naturally because they haven't been added to the BiomeController* (which is the code that handles worldgen).

 

*BiomeProvider, I can't remember what it's currently called. There's one for each dimension (and one for flat worlds).

Edited by Draco18s

Apparently I'm a complete and utter jerk and come to this forum just like to make fun of people, be confrontational, and make your personal life miserable.  If you think this is the case, JUST REPORT ME.  Otherwise you're just going to get reported when you reply to my posts and point it out, because odds are, I was trying to be nice.

 

Exception: If you do not understand Java, I WILL NOT HELP YOU and your thread will get locked.

 

DO NOT PM ME WITH PROBLEMS. No help will be given.

QuantumPie Tree Puncher

QuantumPie

Posted
  • Author
Posted

So would you happen to know of any recent post / guide that explains the underlying structure of Minecraft? I know it works based on ticks and a client + server thread but that's about it. I'd like to get a better idea before delving into the source code.

Animefan8888 Reality Controller

Animefan8888

Posted
Posted
2 hours ago, QuantumPie said:

So would you happen to know of any recent post / guide that explains the underlying structure of Minecraft? 

No I dont believe anyone has approached with this particular question before.

 

2 hours ago, QuantumPie said:

I'd like to get a better idea before delving into the source code.

Basically everything you've said is true.

 

Minecraft singleplayer has many threads. The two you should concern yourself with the most is the logic threads. Denoted as server and client. You must do everything logic based that you dont want the client to lie about on the server thread. There is a third thread you might end up encountering, but less often. It is the network thread. You must only decode encode and receive on the network thread, processing must be deferred to the server/client thread. You'll see an example on the forge docs website. However in 1.13+ world gen is handled on it's own thread(keep world generation thread safe). Typically you figure this out by World#isRemote being false. And vice versa for client thread. Any client only code cannot run on the server at all. This is known as reaching across logical sides. Any attempt to do this will cause seemingly random hard to reproduce bugs in singleplayer and will crash the dedicated server.

 

Speaking of the dedicated server this is the jar file you launch when host a public server. The dedicated server has all client only code stripped of it and has no client thread. Thus the crashing.

 

Yes Minecraft also runs a tick and frame system instead of just a frame system. As such there are supposed to be 20 ticks in a second. You can use this to determine a change in time by implementing a variable every tick. This also creates a need for a partialTick float when rendering. Because while we update at a constant 20 ticks/second we can render as many frames/second as we want. Partial ticks represents the fractional(0.0-1.0) time between the next tick.

 

If I missed anything important anyone is welcome to add on. If you have a more specific question about the internal runnings please ask. Might need a new thread for it depending on its relation to this one.

VANILLA MINECRAFT CLASSES ARE THE BEST RESOURCES WHEN MODDING

I will be posting 1.15.2 modding tutorials on this channel. If you want to be notified of it do the normal YouTube stuff like subscribing, ect.

Forge and vanilla BlockState generator.

Join the conversation

You can post now and register later. If you have an account, sign in now to post with your account.
Note: Your post will require moderator approval before it will be visible.

Guest
Unfortunately, your content contains terms that we do not allow. Please edit your content to remove the highlighted words below.
Reply to this topic...

×   Pasted as rich text.   Restore formatting

  Only 75 emoji are allowed.

×   Your link has been automatically embedded.   Display as a link instead

×   Your previous content has been restored.   Clear editor

×   You cannot paste images directly. Upload or insert images from URL.

×
 Share
Go to topic listing

Announcements



  • Recently Browsing

    • No registered users viewing this page.

  • Posts

    • vals_kenway
      Problem Sync Client-server for Entity Mount

      By vals_kenway · Posted

      Version 1.19 - Forge 41.0.63 I want to create a wolf entity that I can ride, so far it seems to be working, but the problem is that when I get on the wolf, I can’t control it. I then discovered that the issue is that the server doesn’t detect that I’m riding the wolf, so I’m struggling with synchronization. However, it seems to not be working properly. As I understand it, the server receives the packet but doesn’t register it correctly. I’m a bit new to Java, and I’ll try to provide all the relevant code and prints *The comments and prints are translated by chatgpt since they were originally in Spanish* Thank you very much in advance No player is mounted, or the passenger is not a player. No player is mounted, or the passenger is not a player. No player is mounted, or the passenger is not a player. No player is mounted, or the passenger is not a player. No player is mounted, or the passenger is not a player. MountableWolfEntity package com.vals.valscraft.entity; import com.vals.valscraft.network.MountSyncPacket; import com.vals.valscraft.network.NetworkHandler; import net.minecraft.client.Minecraft; import net.minecraft.network.syncher.EntityDataAccessor; import net.minecraft.network.syncher.EntityDataSerializers; import net.minecraft.network.syncher.SynchedEntityData; import net.minecraft.server.MinecraftServer; import net.minecraft.server.level.ServerPlayer; import net.minecraft.world.entity.EntityType; import net.minecraft.world.entity.Mob; import net.minecraft.world.entity.ai.attributes.AttributeSupplier; import net.minecraft.world.entity.ai.attributes.Attributes; import net.minecraft.world.entity.animal.Wolf; import net.minecraft.world.entity.player.Player; import net.minecraft.world.entity.Entity; import net.minecraft.world.InteractionHand; import net.minecraft.world.InteractionResult; import net.minecraft.world.item.ItemStack; import net.minecraft.world.item.Items; import net.minecraft.world.level.Level; import net.minecraft.world.phys.Vec3; import net.minecraftforge.event.TickEvent; import net.minecraftforge.eventbus.api.SubscribeEvent; import net.minecraftforge.network.PacketDistributor; public class MountableWolfEntity extends Wolf { private boolean hasSaddle; private static final EntityDataAccessor<Byte> DATA_ID_FLAGS = SynchedEntityData.defineId(MountableWolfEntity.class, EntityDataSerializers.BYTE); public MountableWolfEntity(EntityType<? extends Wolf> type, Level level) { super(type, level); this.hasSaddle = false; } @Override protected void defineSynchedData() { super.defineSynchedData(); this.entityData.define(DATA_ID_FLAGS, (byte)0); } public static AttributeSupplier.Builder createAttributes() { return Wolf.createAttributes() .add(Attributes.MAX_HEALTH, 20.0) .add(Attributes.MOVEMENT_SPEED, 0.3); } @Override public InteractionResult mobInteract(Player player, InteractionHand hand) { ItemStack itemstack = player.getItemInHand(hand); if (itemstack.getItem() == Items.SADDLE && !this.hasSaddle()) { if (!player.isCreative()) { itemstack.shrink(1); } this.setSaddle(true); return InteractionResult.SUCCESS; } else if (!level.isClientSide && this.hasSaddle()) { player.startRiding(this); MountSyncPacket packet = new MountSyncPacket(true); // 'true' means the player is mounted NetworkHandler.CHANNEL.sendToServer(packet); // Ensure the server handles the packet return InteractionResult.SUCCESS; } return InteractionResult.PASS; } @Override public void travel(Vec3 travelVector) { if (this.isVehicle() && this.getControllingPassenger() instanceof Player) { System.out.println("The wolf has a passenger."); System.out.println("The passenger is a player."); Player player = (Player) this.getControllingPassenger(); // Ensure the player is the controller this.setYRot(player.getYRot()); this.yRotO = this.getYRot(); this.setXRot(player.getXRot() * 0.5F); this.setRot(this.getYRot(), this.getXRot()); this.yBodyRot = this.getYRot(); this.yHeadRot = this.yBodyRot; float forward = player.zza; float strafe = player.xxa; if (forward <= 0.0F) { forward *= 0.25F; } this.flyingSpeed = this.getSpeed() * 0.1F; this.setSpeed((float) this.getAttributeValue(Attributes.MOVEMENT_SPEED) * 1.5F); this.setDeltaMovement(new Vec3(strafe, travelVector.y, forward).scale(this.getSpeed())); this.calculateEntityAnimation(this, false); } else { // The wolf does not have a passenger or the passenger is not a player System.out.println("No player is mounted, or the passenger is not a player."); super.travel(travelVector); } } public boolean hasSaddle() { return this.hasSaddle; } public void setSaddle(boolean hasSaddle) { this.hasSaddle = hasSaddle; } @Override protected void dropEquipment() { super.dropEquipment(); if (this.hasSaddle()) { this.spawnAtLocation(Items.SADDLE); this.setSaddle(false); } } @SubscribeEvent public static void onServerTick(TickEvent.ServerTickEvent event) { if (event.phase == TickEvent.Phase.START) { MinecraftServer server = net.minecraftforge.server.ServerLifecycleHooks.getCurrentServer(); if (server != null) { for (ServerPlayer player : server.getPlayerList().getPlayers()) { if (player.isPassenger() && player.getVehicle() instanceof MountableWolfEntity) { MountableWolfEntity wolf = (MountableWolfEntity) player.getVehicle(); System.out.println("Tick: " + player.getName().getString() + " is correctly mounted on " + wolf); } } } } } private boolean lastMountedState = false; @Override public void tick() { super.tick(); if (!this.level.isClientSide) { // Only on the server boolean isMounted = this.isVehicle() && this.getControllingPassenger() instanceof Player; // Only print if the state changed if (isMounted != lastMountedState) { if (isMounted) { Player player = (Player) this.getControllingPassenger(); // Verify the passenger is a player System.out.println("Server: Player " + player.getName().getString() + " is now mounted."); } else { System.out.println("Server: The wolf no longer has a passenger."); } lastMountedState = isMounted; } } } @Override public void addPassenger(Entity passenger) { super.addPassenger(passenger); if (passenger instanceof Player) { Player player = (Player) passenger; if (!this.level.isClientSide && player instanceof ServerPlayer) { // Send the packet to the server to indicate the player is mounted NetworkHandler.CHANNEL.send(PacketDistributor.PLAYER.with(() -> (ServerPlayer) player), new MountSyncPacket(true)); } } } @Override public void removePassenger(Entity passenger) { super.removePassenger(passenger); if (passenger instanceof Player) { Player player = (Player) passenger; if (!this.level.isClientSide && player instanceof ServerPlayer) { // Send the packet to the server to indicate the player is no longer mounted NetworkHandler.CHANNEL.send(PacketDistributor.PLAYER.with(() -> (ServerPlayer) player), new MountSyncPacket(false)); } } } @Override public boolean isControlledByLocalInstance() { Entity entity = this.getControllingPassenger(); return entity instanceof Player; } @Override public void positionRider(Entity passenger) { if (this.hasPassenger(passenger)) { double xOffset = Math.cos(Math.toRadians(this.getYRot() + 90)) * 0.4; double zOffset = Math.sin(Math.toRadians(this.getYRot() + 90)) * 0.4; passenger.setPos(this.getX() + xOffset, this.getY() + this.getPassengersRidingOffset() + passenger.getMyRidingOffset(), this.getZ() + zOffset); } } } MountSyncPacket package com.vals.valscraft.network; import com.vals.valscraft.entity.MountableWolfEntity; import net.minecraft.network.FriendlyByteBuf; import net.minecraft.server.level.ServerLevel; import net.minecraft.server.level.ServerPlayer; import net.minecraft.world.entity.Entity; import net.minecraft.world.entity.player.Player; import net.minecraftforge.network.NetworkEvent; import java.util.function.Supplier; public class MountSyncPacket { private final boolean isMounted; public MountSyncPacket(boolean isMounted) { this.isMounted = isMounted; } public void encode(FriendlyByteBuf buffer) { buffer.writeBoolean(isMounted); } public static MountSyncPacket decode(FriendlyByteBuf buffer) { return new MountSyncPacket(buffer.readBoolean()); } public void handle(NetworkEvent.Context context) { context.enqueueWork(() -> { ServerPlayer player = context.getSender(); // Get the player from the context if (player != null) { // Verifies if the player has dismounted if (!isMounted) { Entity vehicle = player.getVehicle(); if (vehicle instanceof MountableWolfEntity wolf) { // Logic to remove the player as a passenger wolf.removePassenger(player); System.out.println("Server: Player " + player.getName().getString() + " is no longer mounted."); } } } }); context.setPacketHandled(true); // Marks the packet as handled } } networkHandler package com.vals.valscraft.network; import com.vals.valscraft.valscraft; import net.minecraft.resources.ResourceLocation; import net.minecraftforge.network.NetworkRegistry; import net.minecraftforge.network.simple.SimpleChannel; import net.minecraftforge.network.NetworkEvent; import java.util.function.Supplier; public class NetworkHandler { private static final String PROTOCOL_VERSION = "1"; public static final SimpleChannel CHANNEL = NetworkRegistry.newSimpleChannel( new ResourceLocation(valscraft.MODID, "main"), () -> PROTOCOL_VERSION, PROTOCOL_VERSION::equals, PROTOCOL_VERSION::equals ); public static void init() { int packetId = 0; // Register the mount synchronization packet CHANNEL.registerMessage( packetId++, MountSyncPacket.class, MountSyncPacket::encode, MountSyncPacket::decode, (msg, context) -> msg.handle(context.get()) // Get the context with context.get() ); } }  
    • TileEntity
      Trying to play any world is stuck on 100% loading and shuts down computer

      By TileEntity · Posted

      Also make a test without EMF (Entity Model Features)
    • TileEntity
      Server Keeps Crashing When I Press E in Creative only

      By TileEntity · Posted

      Do you use features of inventory profiles next (ipnext) or is there a change without it?
    • TileEntity
      Duplicate mod issue on modpack startup

      By TileEntity · Posted

      Keep on this thread:  
    • TileEntity
      Duplicate mod issue on modpack startup

      By TileEntity · Posted

      Remove rubidium - you are already using embeddium, which is a fork of rubidium

  • Topics

×
×
  • Create New...

Important Information

By using this site, you agree to our Terms of Use.

  I accept