Minecraft Forge is a modding framework, designed to allow different mods to load and work together to be compatible. Through the years, there has been many changes in the Forge tooling to make working with mods as seamless as possible. It is now easier than ever to start making your own mod.
The Mod Development Kit
The Mod Development Kit or MDK is a downloadable archive that contains the basic skeleton for starting a new mod. It contains the following files and folders:
- The Mod Development Kit
gradle/wrapper/- The folder containing the Gradle wrapper, Forge uses Version 7.2
src- The sources folder
.gitattributes- Used by Git for specifying attributes for files
.gitignore- Used by Git for specifying intentionally untracked/ignored files
build.gradle- The Gradle buildscript, which defines the project and tasks
changelog.txt- The Forge version changelog
CREDITS.txt- Forge's credits/thank you file
gradle.properties- The Gradle properties file, for defining additional variables and options
gradlew- The *nix shell file for executing the Gradle wrapper
gradlew.bat- The Windows batch file for executing the Gradle wrapper
LICENSE.txt- File containing the licensing information for Forge and libraries
README.txt- Readme file with the basic setup instructions
Basic MDK Setup
- Download the MDK from the official Minecraft Forge download site and extract the MDK into an empty folder.
- Open your IDE of choice, and import the project as a Gradle project.
- For Eclipse: File > Import > Gradle > Existing Gradle Project, select the folder for the Project root directory, click Finish
- For IntelliJ IDEA: File > Open, select and open the folder, select the build.gradle file, click OK, click Open as Project
- Wait for the setup process to complete and the Minecraft sources are decompiled.
- Generate the run configurations for your IDE using the appropriate Gradle task.
These tasks can be run on the command line using (Windows)
gradlew gen***Runsor (*nix)
- For Eclipse: the task is
genEclipseRuns; to run in the IDE directly, open the Gradle Tasks tab on the bottom panel, wait until the tasks have loaded then expand the folder, expand the fg_runs folder, then double-click genEclipseRuns.
- For IntelliJ IDEA: the task is
genIntellijRuns; to run in the IDE directly, open the Gradle on the right, expand the project folder, double-click Tasks > fg_runs > genIntellijRuns.
- For Visual Studio Code: the task is
genVSCodeRuns; the Java plugin and Gradle tasks plugin should both be installed for smoother integration.
- For Eclipse: the task is
Customizing the MDK
The MDK provides default values for the buildscript and mods.toml file. These values should be replaced with your own mod's information.
All edits should be done below the
apply plugin: 'net.minecraftforge.gradle' line. The lines above it are required for the Forge MDK to work correctly, and should not be modified without proper knowledge.
- All references to
examplemodin the buildscript should be replaced with your modid.
- Use your IDE's find-and-replace function to quickly replace these values.
- Pick a unique and memorable modid. The modid must be between 2 and 64 characters, and must consist of lowercase letters, numbers, underscores (
_) and hyphens (
-). The recommendation is to avoid using acronyms and abbreviations.
- Change the
archivesBaseNamevariable to your modid. This is used as the base name for the JAR file when you build your mod, and as the artifactId of your mod's maven coordinates.
- Change the
groupto your unique root java package. This is used as the groupId of your mod's maven coordinates.
- In the
jartask, change the values of the
Implementation-Vendorkeys to your username/brand name or other form of identification.
- Optional suggestion: Change the
versionvariable to have a 0 as the major version (ex.
'0.1'. This is to follow semantic versioning guidelines for versions in active development.
Building and Testing
You can test your mod in the development environment using either your IDE's run configurations and built-in debugging utilities, or by running the
run* task as defined by the buildscript's run configurations.
There are three default run configurations with the MDK:
runClient, for starting the client.
runServer, for starting the dedicated server. You will need to accept the EULA through the eula.txt after running the server for the first time.
runData, for starting the client in data generation mode.
You can build your mod's final JAR using the
build task. The resulting JAR will be located in the
build/libs folder under your project directory.
- StackOverflow answer: ... Basically, if it was stored in META-INF, it was Meta-data Information...
- Official git documentation on .gitattributes
- Official git documentation on .gitignore
- Gradle User Guide for 7.2: Build Script Basics
- Gradle User Guide for 7.2: Build Environment § Gradle properties