Source Installation Information for Modders

This code follows the Minecraft Forge installation methodology. It will apply some small patches to the vanilla MCP source code, giving you and it access to some of the data and functions you need to build a successful mod.

Note: The patches are built against "un-renamed" MCP source code (aka SRG Names) - this means that you will not be able to read them directly against normal code.

Setup Process:

Step 1:

Open your command-line and browse to the folder where you extracted the zip file.

Step 2:

You're left with a choice.

If you prefer to use Eclipse:

1. Run the command: gradlew genEclipseRuns (./gradlew genEclipseRuns if you are on Mac/Linux)
2. Open Eclipse, go to Import > Existing Gradle Project > Select Folder, or run gradlew eclipse to generate the project.

If you prefer to use IntelliJ:

1. Open IDEA, and import the project.
2. Select your build.gradle file and have it import.
3. Run the command: gradlew genIntellijRuns (./gradlew genIntellijRuns if you are on Mac/Linux)
4. Refresh the Gradle Project in IDEA if required.

Troubleshooting: If at any point you are missing libraries in your IDE, or you've run into problems, you can run gradlew --refresh-dependencies to refresh the local cache and gradlew clean to reset everything (does not affect your code), then start the process again.

Mapping Names:

By default, the MDK is configured to use the official mapping names from Mojang for methods and fields in the Minecraft codebase. These names are covered by a specific license. All modders should be aware of this license; if you do not agree with it, you can change your mapping names to other crowdsourced names in your build.gradle. For the latest license text, refer to the mapping file itself, or the reference copy here: Mojang License

Additional Resources:

• Community Documentation: Minecraft Forge Documentation
• LexManos' Install Video: YouTube Video
• Forge Forum: Minecraft Forge Forums
• Forge Discord: The NeoForge Project

---