v0.3_a4 🧀

Author: BlueStaggo

MODDING.md

@@ -0,0 +1,133 @@
+# Modding guide
+This guide provides information on how to create modifications for Minecraft Diverge.
+
+
+## Prerequisites:
+- JDK 8 (more recent versions do not support modding) (preferrably downloaded from [Adoptium](https://adoptium.net/en-GB/temurin/releases/?version=8), the JDK used to compile Minecraft Diverge)
+- RetroMCP 1.0.1 (https://github.com/MCPHackers/RetroMCP-Java; download 1.0.1 from the "Actions" tab, select the latest workflow, download the build artifacts and use the "GUI" jar if 1.0.1 has not released it)
+- Minecraft Diverge's [patch file](merged.patch)
+- Both the Minecraft Diverge [client](https://github.com/BlueStaggo/MCDiverge/releases/download/latest/mcdiverge.zip) and [server](https://github.com/BlueStaggo/MCDiverge/releases/download/latest/mcdiverge_server.zip)
+- (Optional, but recommended) A Java IDE, like IntelliJ or Eclipse.
+
+## Table of contents:
+- [Chapter 1: Development environment](#chapter-1-development-environment)
+    - [Setting up RetroMCP](#setting-up-retromcp)
+    - [Decompiling Minecraft Diverge (or at least try to)](#decompiling-minecraft-diverge-or-at-least-try-to)
+    - [Decompiling and patching Alpha v1.1.2_01](#decompiling-and-patching-alpha-v112_01)
+    - [Recompiling and running Minecraft Diverge](#recompiling-and-running-minecraft-diverge)
+- [Chapter 2: Basic mod development](#chapter-2-basic-mod-development)
+    - [Loading the mod](#loading-the-mod)
+    - [Adding mod content](#adding-mod-content)
+    - [Publishing the mod](#publishing-the-mod)
+    - [Additional resources](#further-resources)
+
+# Chapter 1: Development environment
+
+## Setting up RetroMCP
+First, the RetroMCP jar needs to be placed in a new folder. Before decompiling, the `Side` in the `Options` menu needs to be set to `Merged`. Then, go to the "Current version" dropdown and select "Alpha 1.1.2_01". Upon being prompted to run the setup, click yes. RetroMCP will show up a notification when setup is completed, and at that stage RetroMCP should be closed. After this, in the directory RetroMCP is in, two folders called `minecraft` and `minecraft_server` need to be created with each containing a folder called `jars`, since RetroMCP does not create them automatically despite requiring them.
+
+## Decompiling Minecraft Diverge (or at least try to)
+In the `jars` folder (not in `minecraft` or `minecraft_server`), there should be a jar file for the client named `minecraft.jar` and a jar file for the server named `minecraft_server.jar`. Each jar needs to be opened in a file archiver and the contents of `mcdiverge.zip` and `mcdiverge_server.zip` need to be copied over to the respective jar. Make sure to delete META-INF in `minecraft.jar`, but not in `minecraft_server.jar`.
+
+With Diverge ready to decompile, open up RetroMCP again and click on the `Decompile` button. Wait for it to do its work, however the decompilation will fail as there are many missing classes, duplicate members and missing generics. This is supposed to happen, as Minecraft Diverge has changed the source code so much that it is bound to have some major differences from the vanilla source code which RetroMCP cannot cope with. This is fine, as there is a different way to get Minecraft Diverge's source code that actually works.
+
+## Decompiling and patching Alpha v1.1.2_01
+Create a new folder and copy RetroMCP into it. Open up RetroMCP, set the side to merged, select "Alpha 1.1.2_01" as the current version and click "Decompile". Once decompilation is finished, create a `patches` folder, where the patch file for Minecraft Diverge needs to be moved into and named `merged.patch`. Back in RetroMCP, to the top left of the window, click on `MCP` > `More tasks...` > `Apply patch` to apply the patch file.
+
+## Recompiling and running Minecraft Diverge
+In the `minecraft_merged` folder, there is a `src` folder. This folder needs to be copied over to the `minecraft_merged` folder in the Minecraft Diverge decompilation after its `src` and `src_original` folders have been deleted. After that, the `src` folder needs to be copied as a new folder called `src_original`, so that RetroMCP will now use the fixed source code for recompiling as well as source code patch creation. Open up RetroMCP again and press the following buttons in this order while accepting any prompts that appear: `Recompile`, `Update MD5`, `Reobfuscate`, `Build`. After all of this, click `MCP` > `Launch client` and a decompiled version of Minecraft Diverge should be running!
+
+# Chapter 2: Basic mod development
+
+## Loading the mod
+To start off creating a mod, add a new class in the folder `minecraft_merged/src/net/minecraft/src`. This class needs to inherit `BaseMod` and override the following methods:
+
+```java
+@Override // Name of the mod
+public String getName() {
+    return "Example Mod";
+}
+
+@Override // Mod version
+public String getVersion() {
+    return "v0.3_a4";
+}
+
+@Override // Author of the mod
+public String getAuthor() {
+    return "BlueStaggo";
+}
+
+@Override // Mod icon for mod list (optional)
+public String getIcon() {
+    return "/example_mod/icon.png";
+}
+
+@Override // Is the mod for the client or server? (defaults to both)
+public ModSide getSide() {
+    return ModSide.BOTH;
+}
+
+@Override // Load the actual mod
+public void load() throws Exception {
+    // Load your mod!
+}
+```
+
+All resources are loaded relative to the first `src` folder, so if the mod class was used as the icon, its path would be `/net/minecraft/src/YourMod.class`. In the case above, relative to the RetroMCP jar, the icon would need to be stored in `/minecraft_merged/src/example_mod/icon.png`.
+
+Upon running the game, however, the mod will not load. To force the mod to load, go to `ModLoader.java`, and before the code that loads the example mod, add in this code:
+
+```java
+// ...
+        }
+    }
+}
+
+// v v v
+mods.add(new YourMod());
+modCount++;
+// ^ ^ ^
+
+if (loadExampleMod) {
+    mods.add(new ExampleMod());
+    modCount++;
+}
+// ...
+```
+
+Make sure to remove this extra code before publishing the mod. If `ModLoader.class` appears in the final jar, it is safe to delete it.
+To compile the code and run the game, click on `Recompile`, `Reobfuscate` and `Build` in RetroMCP. When the game is opened, check in the mods list and the mod should appear with its icon:
+
+![Example Mod, Version v0.3_a4, By BlueStaggo](img/doc/modding/modicon.png)
+
+## Adding mod content
+What should the mod do? One simple thing it can do is create an achievement and grant it to the player when the game loads. This is very trivial, as this is all the code that needs to be added in the mod:
+
+```java
+public static Achievement exampleAchievement;
+
+@Override
+public void load() {
+    exampleAchievement = new Achievement("example_mod/got_modded", "Got Modded", "Now it is Yourcraft!")
+            .setCreativeUnlockable();
+    ModLoader.registry.addAchievement(exampleAchievement); // Make sure it is saved correctly
+    if (ModLoader.isClient()) {
+        Minecraft.getInstance().achievements.updateProgress(exampleAchievement, 1);
+    }
+}
+```
+
+As for the assets, relative to the src folder, these images need to be stored in the directory `/achievements/example_mod/` as `got_modded.png` and `got_modded_locked.png` respectively:
+
+![got_modded.png](img/doc/modding/got_modded.png) ![got_modded_locked.png](img/doc/modding/got_modded_locked.png)
+
+Now when the game is loaded this time, this should appear in the achievements menu:
+
+![Got Modded, Now it is Yourcraft!](img/doc/modding/achievement.png)
+
+## Publishing the mod
+First, make sure the mod is not loaded from the ModLoader class. Like before, `Recompile`, `Reobfuscate` and `Build` in RetroMCP. In the `build` folder relative to the RetroMCP jar, two files can be found: `minecraft.zip` and `minecraft_server.zip`. Both of these files contain every class you have modified, but if there are any classes in there that you have not modified then make sure to delete them. Finally, the mod can be shared across the web, but one of the best places to share it in is in the Minecraft Diverge [Discord server](https://discord.gg/rzHsJkvpqw).
+
+## Additional resources
+This guide only shows so much, so looking through the [Example Mod](example_mod/net/minecraft/src/ExampleMod.java) and Minecraft Diverge's source code is recommended.

README.md

@@ -4,7 +4,7 @@
 
 Minecraft Diverge is a Minecraft Alpha v1.1.2_01 mod that takes the game towards a different direction. Explore the new biomes, experiment with magic items and explore in a version of Minecraft, diverged! It provides fresh new world generation, extra content for the late game and plenty of tweaks.
 
-For guidance with installing this mod, check out the [INSTALLATION](INSTALLATION.md) document.
+For guidance with installing this mod, check out the [INSTALLATION](INSTALLATION.md) document. If you want to create mods for Diverge, check out the [MODDING](MODDING.md) guide.
 
 This is the Github repository for Minecraft Diverge, where users can submit issues and download new versions. The source code for Minecraft Diverge is partially available in the form of patch files from RetroMCP-Java 1.0.
 

example_mod/achievement/example_mod/eat_the_cheese.png

@@ -0,0 +1,119 @@
+package net.minecraft.src;
+
+import java.util.List;
+
+public class ExampleMod extends BaseMod {
+	public static Achievement eatTheCheese;
+	public static Item cheese;
+	public static Block cheeseBlock;
+
+	@Override
+	public String getName() {
+		return "Example Mod";
+	}
+
+	@Override
+	public String getVersion() {
+		return "v0.3_a4";
+	}
+
+	@Override
+	public String getAuthor() {
+		return "BlueStaggo";
+	}
+
+	@Override
+	public String getIcon() {
+		return "/example_mod/icon.png";
+	}
+
+	@Override
+	public void load() throws Exception {
+		// Create an achievement. Textures are stored in /achievements/example/eat_the_cheese.png
+		// and /achievements/example/eat_the_cheese_locked.png depending on progress.
+		// Creating the locked achievement image is the same as setting HSL saturation to 0
+		// and decreasing HSL lightness by 80.
+		eatTheCheese = new Achievement("example_mod/eat_the_cheese", "EAT THE CHEESE!", "Some random cheese fell on your head. Eat it!")
+				.setCreativeUnlockable(); // Achievements are not unlockable in creative mode by default.
+		ModLoader.registry.addAchievement(eatTheCheese); // Register it to the ModLoader so that it loads properly
+
+		// Create a new item. New IDs can be automatically used with ModLoader.registry.itemId().
+		// The "5" in the ItemFood constructor is how much health the food heals.
+		cheese = new ItemFood(ModLoader.registry.itemId(), 5)
+				.setIconIndex(ModLoader.registry.addItemTexture("/example_mod/items/cheese.png")); // Load in a custom texture into the item texture atlas
+		// Add in a tooltip for the inventory
+		cheese.setTooltip(new ItemTooltip(ItemTooltip.LEGENDARY_GRAD,   // Legendary gradient (magenta)
+				"Cheese", ItemTooltip.LEGENDARY_COL,                    // Legendary color (magenta)
+				"Very exquisite cuisine", ItemTooltip.DESCRIPTION_COL,  // Description color (beige)
+				cheese)); // Pass in item for automatic info generation (how much health the cheese heals)
+
+		// Create a new block. This cheese block will inherit the sponge texture,
+		// but loading custom block textures is done in a very similar fashion
+		// to loading custom item textures.
+		cheeseBlock = new BlockCheese(ModLoader.registry.blockId(), Block.sponge.blockIndexInTexture, Material.plants)
+				.setHardness(1.0F)
+				.setStepSound(Block.soundClothFootstep);
+		cheeseBlock.setTooltip(new ItemTooltip(ItemTooltip.LEGENDARY_GRAD,
+				"Block of Cheese", ItemTooltip.LEGENDARY_COL,
+				"SO MUCH CHEESE!", ItemTooltip.DESCRIPTION_COL));
+		ModLoader.registry.registerItemBlock(cheeseBlock); // Make sure to register the block item!
+
+		// Create a new recipe. Make a 2x2 square of cheese
+		// to craft a cheese block.
+		ModLoader.registry.addRecipe(new ItemStack(cheeseBlock),
+				"XX",
+				"XX",
+				'X', cheese);
+		ModLoader.registry.addRecipe(new ItemStack(cheese), // Make sure to be able to convert the cheese back!
+				"X",
+				'X', cheeseBlock);
+
+		// Item tooltips can be overrided. Here, the Bucket
+		// of Milk becomes the Bucket of Cheese.
+		ItemTooltip.items[Item.bucketMilk.shiftedIndex] = new ItemTooltip("Bucket of Cheese",
+				"What kind of cheese is this?", ItemTooltip.DESCRIPTION_COL);
+	}
+
+	// Using hooks, custom code can be ran
+	// on every tick of the world.
+	@Override
+	public void onWorldMiscUpdates(World world) {
+		// Drop cheese in singleplayer worlds in 1 in 1000 ticks.
+		int cheeseInterval = 1000;
+		if (ModLoader.isClient() && world.canDoClientAction() && world.rand.nextInt(cheeseInterval) == 0) {
+			for (EntityPlayer player : (List<EntityPlayer>)world.playerEntities) {
+				EntityItem item = new EntityItem(world, player.posX, player.posY + 10, player.posZ, new ItemStack(cheese));
+				world.spawnEntityInWorld(item);
+				world.playSoundAtEntity(item, "random.wand", 1.0F, world.rand.nextFloat() * 0.2F + 0.9F);
+				world.achievements.updateProgress(eatTheCheese, 1); // Award the "EAT THE CHEESE!" achievement to whoever got the cheese.
+			}
+		}
+	}
+
+	// Add mod items to the creative inventory using a hook.
+	@Override
+	public void setupCreativeInventory(CreativeInventoryBuilder inv) {
+		inv.addLabel("Example Mod");
+		inv.addItem(cheese.shiftedIndex, 0);
+		inv.addItem(cheeseBlock.blockID, 0);
+	}
+
+	// This is a custom BlockCheese class to get the right shape.
+	// The Block of Cheese is not a full block, so it needs special code.
+	private static class BlockCheese extends Block {
+		public BlockCheese(int var1, int var2, Material var3) {
+			super(var1, var2, var3);
+			this.setBlockBounds(0.25F, 0.0F, 0.25F, 0.75F, 0.5F, 0.75F);
+		}
+
+		@Override
+		public boolean isOpaqueCube() {
+			return false;
+		}
+
+		@Override
+		public boolean shouldSideBeRendered(IBlockAccess var1, int var2, int var3, int var4, int var5) {
+			return true;
+		}
+	}
+}