Tutorials/Creating Forge mods
|This feature is exclusive to Java Edition.|
- 1 Overview
- 2 First steps with Forge
- 3 Creating a mod for Forge
- 4 Next Steps
- 5 Where to get help
- 6 Additional Info
- 7 See Also
Note: This tutorial is in the very earliest stages. Its aim is to point you to the resources needed to get started making mods for Minecraft Java Edition. It will not be exhaustive.
Mods (short for 'modifications') can modify or add items, blocks, entities, and much more. Presumably you already have an idea for a mod you want to create. If you simply want to add custom advancements, functions, loot tables, structures, recipes or tags to your game, look into how to make a Data pack, which does not require programming. Or look into how to make a Resource pack if you simply want to customize textures (colors and designs), models, music, sounds, languages, splashes, fonts, or the end poem. Or perhaps you want to 'fork' a favorite mod to update for newer versions of Minecraft. In any case, this guide will cover (eventually) only the most basic elements of creating an item (example: sword) and creating an entity (example: zombie), and distributing the resulting mod package.
Minecraft mods consist of jar files (example: yournewmod.jar) which contain class files, json files, and image files, to name a few of the most common.
- Class files are specific to the Java programming language. A few Java tutorials to try include w3schools (web and mobile), SoloLearn (web and mobile), and kodevelopment(web). You will need an IDE (Integrated Development Environment) such as IntelliJ or Eclipse to read or create class files. This tutorial will focus on IntelliJ IDEA Community Edition 2019.
- JSON files are a means of detailing the characteristics of objects used by Java class files. JSON is much simpler than Java. You will need a text editor such as Notepad++ to read or create json files. You probably already have Notepad on your computer, but there are many advantages to using Notepad++ instead.
- Image files you may be familiar with include .bmp and .jpg formats, but Minecraft requires .png format (example: yournewlogo.png) in multiples of 16 pixels square (example: 16x16, 32x32, 64x64). You will need an image editor such as Paint.NET or GIMP to edit or create .png files. You probably already have MS Paint on your computer, but GIMP has so much more functionality, and Paint.NET is quite user-friendly. There are also several websites with tools for creating pixel art.
If you have been playing Minecraft Java Edition, you probably already have JRE (Java Runtime Environment). To develop a mod, you will need to find JDK (Java Development Kit), which includes the JRE and an emulator. Create a free account at oracle.com and download JDK Standard Edition version 8. Then follow the instructions for installing it, and make note of the location it installs to. Pay particular attention to the section on Updating the PATH Environment Variable.
With a Java Development Kit installed, and the IntelliJ Integrated Development Environment to manipulate Java with, you now have the tools to develop custom software that can be used in a variety of applications. While working on a mod, continue working through Java tutorials. The lessons will enable you to put your ideas into action, while the ideas will make the lessons more interesting and memorable.
One more tool you should set up before starting a mod is the Forge MDK (Mod Development Kit). Forge is a collection of useful resources and mod loader, designed specifically to simplify compatibility between Minecraft Java Edition and multiple community-created mods. This tutorial will focus on the MDK for version 1.12.2 of Minecraft Java Edition; as of this writing, Forge for 1.13 is still in development, while Mojang has already released 1.14.2. To begin developing for 1.14 right away, you may decide to skip the rest of this tutorial about Forge, and instead dig into Fabric. The Forge MDK will be addressed in detail in the next section.
What not to do
There are some things that you should be careful to not do when creating a mod. Keep this list in mind:
- Don't release Minecraft versions or modifications that allow you to play without having bought Minecraft from Mojang.
- Don't release the de-compiled source code of Minecraft in any way.
- Don't modify existing mods without permission from that mod's author(s). Check their License, usually available in the author's GitHub repository. If you can't find the license, then you do not have permission to share a modified version with anybody. You may tinker with the files for personal use only.
First steps with Forge
This wiki article aims to provide a foolproof walk-through of a few key elements of Forge's tutorial: https://mcforge.readthedocs.io. Bookmark their page, as it addresses many issues this article will not. Moreover, there's more than one valid way to achieve the desired result; this wiki article will focus on the simplest, which is probably not the most efficient or elegant. If you follow precisely the steps outlined here, you should soon have a functional mod, which you can then tinker with to your heart's content. If you use Linux, Forge's tutorial will probably be more useful for you. If you use Windows, read on.
A note about placeholders
This tutorial will use "You" to represent the User profile you are logged in with; if you copy-paste paths from this tutorial, be sure to replace "You" with your own Windows username. This tutorial will use "yournewmod" to represent sections you should replace with the mod name you choose for your project.
1. Create a folder for your project
C:/Users/You/Documents and create a new folder. The name of this folder may be changed easily later.
2. Obtain a "source distribution"
Visit https://files.minecraftforge.net and make sure the version selected is 1.12.2. In the large "Download Recommended" box, click on the small MDK box. A dialog box will appear, asking where you want to save the file, and what to name it. Choose any convenient location, but leave the name unchanged.
3. Copy key files to your project folder
Open the "forge-1.12.2-...-mdk" folder (with or without unzipping it first) and copy-paste the following 5 files from this folder to the project folder you created in the first step:
4. Import the gradle project
Open/Run the IntelliJ IDEA program. In the landing screen, click on "Import Project." A dialog box will appear, asking which file to import. Navigate to your project folder and select "build.gradle," then click OK.
5. Designate the JDK
In the next window, click in the "Gradle JVM" field and navigate to the JDK files you installed earlier. If you got version 8 update 212, select the folder named "jdk1.8.0_212." Click OK and wait for the build to finish, displaying the results in the bottom field.
6. Set up workspace
IntelliJ has a Project panel on the left, which can be toggled open to show the directory of project files. Now there's also a gradle panel, with an elephant icon. Click to open the gradle panel, and click the triangle next to "Tasks" to expand the list. Then click the triangle next to "forgegradle" and double-click the setupDecompWorkspace entry. Wait a minute or two for the build to finish, then click the Refresh button in the gradle panel.
7. Configure Run settings
After refreshing, double-click the "genIntellijRuns" entry. Open the "Edit configurations" window of Run settings and look approximately halfway down, for "Use classpath of module." Click on its dropdown field, and select the option that ends with
.main, then click Apply. If the settings you just finished editing were for the Minecraft Client, click on Minecraft Server and repeat the steps to set the classpath.
You can now Run the client, which will start the Launcher with your mod included. When you get to the landing menu, you can check whether your mod is present.
Creating a mod for Forge
Identifying your mod
Creating a Custom Tool
Let's make a simple spear, with damage ability similar to a stone sword.
Custom Layers over Vanilla Textures
Textures from Scratch
Open Paint.NET and create a new image, with a canvas size of 64x64 (more or less, but in a multiple of 16).
Creating a Custom Mob
Models from Scratch
Creating a Config file
Sharing Your Mod
To build your mod, run gradlew build. This will output a file in build/libs with the name [archivesBaseName]-[version].jar. This file can be placed in the mods folder of a forge enabled Minecraft setup, and distributed.
Where to get help
- create a GitHub account to manage versions of your mod, and collaborate