From f9089ba903cfb42ee5fbff34fda2aeb3c1371905 Mon Sep 17 00:00:00 2001 From: IchHabeHunger54 Date: Thu, 30 Apr 2026 12:53:17 +0200 Subject: [PATCH 1/3] add info on how to view minecraft and neoforge sources --- docs/gettingstarted/index.md | 11 +++++++++++ versioned_docs/version-1.20.4/gettingstarted/index.md | 11 +++++++++++ versioned_docs/version-1.20.6/gettingstarted/index.md | 11 +++++++++++ versioned_docs/version-1.21.1/gettingstarted/index.md | 11 +++++++++++ .../version-1.21.10/gettingstarted/index.md | 11 +++++++++++ .../version-1.21.11/gettingstarted/index.md | 11 +++++++++++ versioned_docs/version-1.21.3/gettingstarted/index.md | 11 +++++++++++ versioned_docs/version-1.21.4/gettingstarted/index.md | 11 +++++++++++ versioned_docs/version-1.21.5/gettingstarted/index.md | 11 +++++++++++ versioned_docs/version-1.21.8/gettingstarted/index.md | 11 +++++++++++ 10 files changed, 110 insertions(+) diff --git a/docs/gettingstarted/index.md b/docs/gettingstarted/index.md index 64b0d1e91..1a64f6a7d 100644 --- a/docs/gettingstarted/index.md +++ b/docs/gettingstarted/index.md @@ -22,6 +22,16 @@ Make sure you are using a 64-bit JVM. One way of checking is to run `java -versi - When doing this for the first time, Gradle will download all dependencies of NeoForge, including Minecraft itself, and decompile them. This can take a fair amount of time (up to an hour, depending on your hardware and network strength). - Whenever you make a change to the Gradle files, the Gradle changes will need to be reloaded, either through the "Reload Gradle" button in your IDE, or again through the `gradlew` terminal command. +### Minecraft Source Code + +Once Gradle has successfully loaded, not only will you have an example mod project, but your workspace will also contain the (patched) sources and [resource files][resources] of Minecraft and NeoForge for you to reference. These sources can be found under `External Libraries` in IntelliJ, or `Referenced Libraries` in Eclipse, and have a different name depending on the Gradle plugin used: + +- NeoGradle: `ng_dummy_ng.net.neoforged.neoforge:` +- ModDevGradle: `neoforge--merged.jar` + - ModDevGradle also has the resource files only in a separate library called `neoforge--client-extra-aka-minecraft-resources.jar`. + +Additionally, you can use your IDE's search feature - by default it's Double Shift in IntelliJ, and Ctrl+H in Eclipse - to search for specific Minecraft classes. + ## Customizing Your Mod Information Many of the basic properties of your mod can be changed in the `gradle.properties` file. This includes basic things like the mod name or the mod version. For more information, see the comments in the `gradle.properties` file, or see [the documentation of the `gradle.properties` file][properties]. @@ -58,3 +68,4 @@ You should always test your mod in a dedicated server environment. This includes [modgen]: https://neoforged.net/mod-generator/ [ng]: https://github.com/neoforged/NeoGradle [properties]: modfiles.md#gradleproperties +[resources]: ../resources/index.md diff --git a/versioned_docs/version-1.20.4/gettingstarted/index.md b/versioned_docs/version-1.20.4/gettingstarted/index.md index 96ab5d37c..83b90e173 100644 --- a/versioned_docs/version-1.20.4/gettingstarted/index.md +++ b/versioned_docs/version-1.20.4/gettingstarted/index.md @@ -23,6 +23,16 @@ Make sure you are using a 64-bit JVM. One way of checking is to run `java -versi - When doing this for the first time, Gradle will download all dependencies of NeoForge, including Minecraft itself, and decompile them. This can take a fair amount of time (up to an hour, depending on your hardware and network strength). - Whenever you make a change to the Gradle files, the Gradle changes will need to be reloaded, either through the "Reload Gradle" button in your IDE, or again through the `gradlew` terminal command. +### Minecraft Source Code + +Once Gradle has successfully loaded, not only will you have an example mod project, but your workspace will also contain the (patched) sources and [resource files][resources] of Minecraft and NeoForge for you to reference. These sources can be found under `External Libraries` in IntelliJ, or `Referenced Libraries` in Eclipse, and have a different name depending on the Gradle plugin used: + +- NeoGradle: `ng_dummy_ng.net.neoforged.neoforge:` +- ModDevGradle: `neoforge--merged.jar` + - ModDevGradle also has the resource files only in a separate library called `neoforge--client-extra-aka-minecraft-resources.jar`. + +Additionally, you can use your IDE's search feature - by default it's Double Shift in IntelliJ, and Ctrl+H in Eclipse - to search for specific Minecraft classes. + ## Customizing Your Mod Information Many of the basic properties of your mod can be changed in the `gradle.properties` file. This includes basic things like the mod name or the mod version. For more information, see the comments in the `gradle.properties` file, or see [the documentation of the `gradle.properties` file][properties]. @@ -58,3 +68,4 @@ You should always test your mod in a dedicated server environment. This includes [mdk]: https://github.com/NeoForgeMDKs/MDK-1.20.4-NeoGradle [neogradle]: https://docs.neoforged.net/neogradle/docs/ [properties]: modfiles.md#gradleproperties +[resources]: ../resources/index.md diff --git a/versioned_docs/version-1.20.6/gettingstarted/index.md b/versioned_docs/version-1.20.6/gettingstarted/index.md index be478bb1c..599fb4e33 100644 --- a/versioned_docs/version-1.20.6/gettingstarted/index.md +++ b/versioned_docs/version-1.20.6/gettingstarted/index.md @@ -23,6 +23,16 @@ Make sure you are using a 64-bit JVM. One way of checking is to run `java -versi - When doing this for the first time, Gradle will download all dependencies of NeoForge, including Minecraft itself, and decompile them. This can take a fair amount of time (up to an hour, depending on your hardware and network strength). - Whenever you make a change to the Gradle files, the Gradle changes will need to be reloaded, either through the "Reload Gradle" button in your IDE, or again through the `gradlew` terminal command. +### Minecraft Source Code + +Once Gradle has successfully loaded, not only will you have an example mod project, but your workspace will also contain the (patched) sources and [resource files][resources] of Minecraft and NeoForge for you to reference. These sources can be found under `External Libraries` in IntelliJ, or `Referenced Libraries` in Eclipse, and have a different name depending on the Gradle plugin used: + +- NeoGradle: `ng_dummy_ng.net.neoforged.neoforge:` +- ModDevGradle: `neoforge--merged.jar` + - ModDevGradle also has the resource files only in a separate library called `neoforge--client-extra-aka-minecraft-resources.jar`. + +Additionally, you can use your IDE's search feature - by default it's Double Shift in IntelliJ, and Ctrl+H in Eclipse - to search for specific Minecraft classes. + ## Customizing Your Mod Information Many of the basic properties of your mod can be changed in the `gradle.properties` file. This includes basic things like the mod name or the mod version. For more information, see the comments in the `gradle.properties` file, or see [the documentation of the `gradle.properties` file][properties]. @@ -58,3 +68,4 @@ You should always test your mod in a dedicated server environment. This includes [mdk]: https://github.com/NeoForgeMDKs/MDK-1.20.6-NeoGradle [neogradle]: https://docs.neoforged.net/neogradle/docs/ [properties]: modfiles.md#gradleproperties +[resources]: ../resources/index.md diff --git a/versioned_docs/version-1.21.1/gettingstarted/index.md b/versioned_docs/version-1.21.1/gettingstarted/index.md index 3cc42756c..f2bdbb686 100644 --- a/versioned_docs/version-1.21.1/gettingstarted/index.md +++ b/versioned_docs/version-1.21.1/gettingstarted/index.md @@ -23,6 +23,16 @@ Make sure you are using a 64-bit JVM. One way of checking is to run `java -versi - When doing this for the first time, Gradle will download all dependencies of NeoForge, including Minecraft itself, and decompile them. This can take a fair amount of time (up to an hour, depending on your hardware and network strength). - Whenever you make a change to the Gradle files, the Gradle changes will need to be reloaded, either through the "Reload Gradle" button in your IDE, or again through the `gradlew` terminal command. +### Minecraft Source Code + +Once Gradle has successfully loaded, not only will you have an example mod project, but your workspace will also contain the (patched) sources and [resource files][resources] of Minecraft and NeoForge for you to reference. These sources can be found under `External Libraries` in IntelliJ, or `Referenced Libraries` in Eclipse, and have a different name depending on the Gradle plugin used: + +- NeoGradle: `ng_dummy_ng.net.neoforged.neoforge:` +- ModDevGradle: `neoforge--merged.jar` + - ModDevGradle also has the resource files only in a separate library called `neoforge--client-extra-aka-minecraft-resources.jar`. + +Additionally, you can use your IDE's search feature - by default it's Double Shift in IntelliJ, and Ctrl+H in Eclipse - to search for specific Minecraft classes. + ## Customizing Your Mod Information Many of the basic properties of your mod can be changed in the `gradle.properties` file. This includes basic things like the mod name or the mod version. For more information, see the comments in the `gradle.properties` file, or see [the documentation of the `gradle.properties` file][properties]. @@ -59,3 +69,4 @@ You should always test your mod in a dedicated server environment. This includes [ngmdk]: https://github.com/NeoForgeMDKs/MDK-1.21-NeoGradle [neogradle]: https://docs.neoforged.net/neogradle/docs/ [properties]: modfiles.md#gradleproperties +[resources]: ../resources/index.md diff --git a/versioned_docs/version-1.21.10/gettingstarted/index.md b/versioned_docs/version-1.21.10/gettingstarted/index.md index 4dbd601ab..d6910cc86 100644 --- a/versioned_docs/version-1.21.10/gettingstarted/index.md +++ b/versioned_docs/version-1.21.10/gettingstarted/index.md @@ -22,6 +22,16 @@ Make sure you are using a 64-bit JVM. One way of checking is to run `java -versi - When doing this for the first time, Gradle will download all dependencies of NeoForge, including Minecraft itself, and decompile them. This can take a fair amount of time (up to an hour, depending on your hardware and network strength). - Whenever you make a change to the Gradle files, the Gradle changes will need to be reloaded, either through the "Reload Gradle" button in your IDE, or again through the `gradlew` terminal command. +### Minecraft Source Code + +Once Gradle has successfully loaded, not only will you have an example mod project, but your workspace will also contain the (patched) sources and [resource files][resources] of Minecraft and NeoForge for you to reference. These sources can be found under `External Libraries` in IntelliJ, or `Referenced Libraries` in Eclipse, and have a different name depending on the Gradle plugin used: + +- NeoGradle: `ng_dummy_ng.net.neoforged.neoforge:` +- ModDevGradle: `neoforge--merged.jar` + - ModDevGradle also has the resource files only in a separate library called `neoforge--client-extra-aka-minecraft-resources.jar`. + +Additionally, you can use your IDE's search feature - by default it's Double Shift in IntelliJ, and Ctrl+H in Eclipse - to search for specific Minecraft classes. + ## Customizing Your Mod Information Many of the basic properties of your mod can be changed in the `gradle.properties` file. This includes basic things like the mod name or the mod version. For more information, see the comments in the `gradle.properties` file, or see [the documentation of the `gradle.properties` file][properties]. @@ -58,3 +68,4 @@ You should always test your mod in a dedicated server environment. This includes [modgen]: https://neoforged.net/mod-generator/ [ng]: https://github.com/neoforged/NeoGradle [properties]: modfiles.md#gradleproperties +[resources]: ../resources/index.md diff --git a/versioned_docs/version-1.21.11/gettingstarted/index.md b/versioned_docs/version-1.21.11/gettingstarted/index.md index cb56c8f8c..951752608 100644 --- a/versioned_docs/version-1.21.11/gettingstarted/index.md +++ b/versioned_docs/version-1.21.11/gettingstarted/index.md @@ -22,6 +22,16 @@ Make sure you are using a 64-bit JVM. One way of checking is to run `java -versi - When doing this for the first time, Gradle will download all dependencies of NeoForge, including Minecraft itself, and decompile them. This can take a fair amount of time (up to an hour, depending on your hardware and network strength). - Whenever you make a change to the Gradle files, the Gradle changes will need to be reloaded, either through the "Reload Gradle" button in your IDE, or again through the `gradlew` terminal command. +### Minecraft Source Code + +Once Gradle has successfully loaded, not only will you have an example mod project, but your workspace will also contain the (patched) sources and [resource files][resources] of Minecraft and NeoForge for you to reference. These sources can be found under `External Libraries` in IntelliJ, or `Referenced Libraries` in Eclipse, and have a different name depending on the Gradle plugin used: + +- NeoGradle: `ng_dummy_ng.net.neoforged.neoforge:` +- ModDevGradle: `neoforge--merged.jar` + - ModDevGradle also has the resource files only in a separate library called `neoforge--client-extra-aka-minecraft-resources.jar`. + +Additionally, you can use your IDE's search feature - by default it's Double Shift in IntelliJ, and Ctrl+H in Eclipse - to search for specific Minecraft classes. + ## Customizing Your Mod Information Many of the basic properties of your mod can be changed in the `gradle.properties` file. This includes basic things like the mod name or the mod version. For more information, see the comments in the `gradle.properties` file, or see [the documentation of the `gradle.properties` file][properties]. @@ -58,3 +68,4 @@ You should always test your mod in a dedicated server environment. This includes [modgen]: https://neoforged.net/mod-generator/ [ng]: https://github.com/neoforged/NeoGradle [properties]: modfiles.md#gradleproperties +[resources]: ../resources/index.md diff --git a/versioned_docs/version-1.21.3/gettingstarted/index.md b/versioned_docs/version-1.21.3/gettingstarted/index.md index c3ae51adf..1b2ebca5d 100644 --- a/versioned_docs/version-1.21.3/gettingstarted/index.md +++ b/versioned_docs/version-1.21.3/gettingstarted/index.md @@ -23,6 +23,16 @@ Make sure you are using a 64-bit JVM. One way of checking is to run `java -versi - When doing this for the first time, Gradle will download all dependencies of NeoForge, including Minecraft itself, and decompile them. This can take a fair amount of time (up to an hour, depending on your hardware and network strength). - Whenever you make a change to the Gradle files, the Gradle changes will need to be reloaded, either through the "Reload Gradle" button in your IDE, or again through the `gradlew` terminal command. +### Minecraft Source Code + +Once Gradle has successfully loaded, not only will you have an example mod project, but your workspace will also contain the (patched) sources and [resource files][resources] of Minecraft and NeoForge for you to reference. These sources can be found under `External Libraries` in IntelliJ, or `Referenced Libraries` in Eclipse, and have a different name depending on the Gradle plugin used: + +- NeoGradle: `ng_dummy_ng.net.neoforged.neoforge:` +- ModDevGradle: `neoforge--merged.jar` + - ModDevGradle also has the resource files only in a separate library called `neoforge--client-extra-aka-minecraft-resources.jar`. + +Additionally, you can use your IDE's search feature - by default it's Double Shift in IntelliJ, and Ctrl+H in Eclipse - to search for specific Minecraft classes. + ## Customizing Your Mod Information Many of the basic properties of your mod can be changed in the `gradle.properties` file. This includes basic things like the mod name or the mod version. For more information, see the comments in the `gradle.properties` file, or see [the documentation of the `gradle.properties` file][properties]. @@ -59,3 +69,4 @@ You should always test your mod in a dedicated server environment. This includes [ngmdk]: https://github.com/NeoForgeMDKs/MDK-1.21.3-NeoGradle [neogradle]: https://docs.neoforged.net/neogradle/docs/ [properties]: modfiles.md#gradleproperties +[resources]: ../resources/index.md diff --git a/versioned_docs/version-1.21.4/gettingstarted/index.md b/versioned_docs/version-1.21.4/gettingstarted/index.md index c686726a0..7be9f5735 100644 --- a/versioned_docs/version-1.21.4/gettingstarted/index.md +++ b/versioned_docs/version-1.21.4/gettingstarted/index.md @@ -23,6 +23,16 @@ Make sure you are using a 64-bit JVM. One way of checking is to run `java -versi - When doing this for the first time, Gradle will download all dependencies of NeoForge, including Minecraft itself, and decompile them. This can take a fair amount of time (up to an hour, depending on your hardware and network strength). - Whenever you make a change to the Gradle files, the Gradle changes will need to be reloaded, either through the "Reload Gradle" button in your IDE, or again through the `gradlew` terminal command. +### Minecraft Source Code + +Once Gradle has successfully loaded, not only will you have an example mod project, but your workspace will also contain the (patched) sources and [resource files][resources] of Minecraft and NeoForge for you to reference. These sources can be found under `External Libraries` in IntelliJ, or `Referenced Libraries` in Eclipse, and have a different name depending on the Gradle plugin used: + +- NeoGradle: `ng_dummy_ng.net.neoforged.neoforge:` +- ModDevGradle: `neoforge--merged.jar` + - ModDevGradle also has the resource files only in a separate library called `neoforge--client-extra-aka-minecraft-resources.jar`. + +Additionally, you can use your IDE's search feature - by default it's Double Shift in IntelliJ, and Ctrl+H in Eclipse - to search for specific Minecraft classes. + ## Customizing Your Mod Information Many of the basic properties of your mod can be changed in the `gradle.properties` file. This includes basic things like the mod name or the mod version. For more information, see the comments in the `gradle.properties` file, or see [the documentation of the `gradle.properties` file][properties]. @@ -59,3 +69,4 @@ You should always test your mod in a dedicated server environment. This includes [ngmdk]: https://github.com/NeoForgeMDKs/MDK-1.21.4-NeoGradle [neogradle]: https://docs.neoforged.net/neogradle/docs/ [properties]: modfiles.md#gradleproperties +[resources]: ../resources/index.md diff --git a/versioned_docs/version-1.21.5/gettingstarted/index.md b/versioned_docs/version-1.21.5/gettingstarted/index.md index 6ee39a7b5..211924032 100644 --- a/versioned_docs/version-1.21.5/gettingstarted/index.md +++ b/versioned_docs/version-1.21.5/gettingstarted/index.md @@ -22,6 +22,16 @@ Make sure you are using a 64-bit JVM. One way of checking is to run `java -versi - When doing this for the first time, Gradle will download all dependencies of NeoForge, including Minecraft itself, and decompile them. This can take a fair amount of time (up to an hour, depending on your hardware and network strength). - Whenever you make a change to the Gradle files, the Gradle changes will need to be reloaded, either through the "Reload Gradle" button in your IDE, or again through the `gradlew` terminal command. +### Minecraft Source Code + +Once Gradle has successfully loaded, not only will you have an example mod project, but your workspace will also contain the (patched) sources and [resource files][resources] of Minecraft and NeoForge for you to reference. These sources can be found under `External Libraries` in IntelliJ, or `Referenced Libraries` in Eclipse, and have a different name depending on the Gradle plugin used: + +- NeoGradle: `ng_dummy_ng.net.neoforged.neoforge:` +- ModDevGradle: `neoforge--merged.jar` + - ModDevGradle also has the resource files only in a separate library called `neoforge--client-extra-aka-minecraft-resources.jar`. + +Additionally, you can use your IDE's search feature - by default it's Double Shift in IntelliJ, and Ctrl+H in Eclipse - to search for specific Minecraft classes. + ## Customizing Your Mod Information Many of the basic properties of your mod can be changed in the `gradle.properties` file. This includes basic things like the mod name or the mod version. For more information, see the comments in the `gradle.properties` file, or see [the documentation of the `gradle.properties` file][properties]. @@ -59,3 +69,4 @@ You should always test your mod in a dedicated server environment. This includes [ng]: https://github.com/neoforged/NeoGradle [neogradle]: https://docs.neoforged.net/neogradle/docs/ [properties]: modfiles.md#gradleproperties +[resources]: ../resources/index.md diff --git a/versioned_docs/version-1.21.8/gettingstarted/index.md b/versioned_docs/version-1.21.8/gettingstarted/index.md index 4dbd601ab..d6910cc86 100644 --- a/versioned_docs/version-1.21.8/gettingstarted/index.md +++ b/versioned_docs/version-1.21.8/gettingstarted/index.md @@ -22,6 +22,16 @@ Make sure you are using a 64-bit JVM. One way of checking is to run `java -versi - When doing this for the first time, Gradle will download all dependencies of NeoForge, including Minecraft itself, and decompile them. This can take a fair amount of time (up to an hour, depending on your hardware and network strength). - Whenever you make a change to the Gradle files, the Gradle changes will need to be reloaded, either through the "Reload Gradle" button in your IDE, or again through the `gradlew` terminal command. +### Minecraft Source Code + +Once Gradle has successfully loaded, not only will you have an example mod project, but your workspace will also contain the (patched) sources and [resource files][resources] of Minecraft and NeoForge for you to reference. These sources can be found under `External Libraries` in IntelliJ, or `Referenced Libraries` in Eclipse, and have a different name depending on the Gradle plugin used: + +- NeoGradle: `ng_dummy_ng.net.neoforged.neoforge:` +- ModDevGradle: `neoforge--merged.jar` + - ModDevGradle also has the resource files only in a separate library called `neoforge--client-extra-aka-minecraft-resources.jar`. + +Additionally, you can use your IDE's search feature - by default it's Double Shift in IntelliJ, and Ctrl+H in Eclipse - to search for specific Minecraft classes. + ## Customizing Your Mod Information Many of the basic properties of your mod can be changed in the `gradle.properties` file. This includes basic things like the mod name or the mod version. For more information, see the comments in the `gradle.properties` file, or see [the documentation of the `gradle.properties` file][properties]. @@ -58,3 +68,4 @@ You should always test your mod in a dedicated server environment. This includes [modgen]: https://neoforged.net/mod-generator/ [ng]: https://github.com/neoforged/NeoGradle [properties]: modfiles.md#gradleproperties +[resources]: ../resources/index.md From e794ddeaf300372525d8e3bb63a5fefeb81f248b Mon Sep 17 00:00:00 2001 From: IchHabeHunger54 Date: Sun, 28 Jun 2026 22:53:41 +0200 Subject: [PATCH 2/3] use a table for clarification --- docs/gettingstarted/index.md | 17 +++++++++++------ 1 file changed, 11 insertions(+), 6 deletions(-) diff --git a/docs/gettingstarted/index.md b/docs/gettingstarted/index.md index 1a64f6a7d..1432a1386 100644 --- a/docs/gettingstarted/index.md +++ b/docs/gettingstarted/index.md @@ -18,19 +18,24 @@ Make sure you are using a 64-bit JVM. One way of checking is to run `java -versi ## Setting Up the Workspace - Go to the [Mod Generator][modgen] webpage, type in a mod name (and optionally a mod id), package name, Minecraft version, and Gradle plugin (either [ModDevGradle][mdg] or [NeoGradle][ng]), click "Download Mod Project", and extract the downloaded ZIP file. -- Open your IDE and import the Gradle project. Eclipse and IntelliJ IDEA will do this automatically for you. If you have an IDE that does not do this, you can also do it via the `gradlew` terminal command. +- Open your IDE and import the Gradle project. IntelliJ IDEA and Eclipse will do this automatically for you. If you have an IDE that does not do this, you can also do it via the `gradlew` terminal command. - When doing this for the first time, Gradle will download all dependencies of NeoForge, including Minecraft itself, and decompile them. This can take a fair amount of time (up to an hour, depending on your hardware and network strength). - Whenever you make a change to the Gradle files, the Gradle changes will need to be reloaded, either through the "Reload Gradle" button in your IDE, or again through the `gradlew` terminal command. ### Minecraft Source Code -Once Gradle has successfully loaded, not only will you have an example mod project, but your workspace will also contain the (patched) sources and [resource files][resources] of Minecraft and NeoForge for you to reference. These sources can be found under `External Libraries` in IntelliJ, or `Referenced Libraries` in Eclipse, and have a different name depending on the Gradle plugin used: +Once Gradle has successfully loaded, not only will you have an example mod project, but your workspace will also contain the (patched) sources and [resource files][resources] of Minecraft and NeoForge for you to reference. These sources can be found under `External Libraries` in IntelliJ IDEA, or `Referenced Libraries` in Eclipse, and have a different name depending on the Gradle plugin used (where `` is the version of NeoForge used): -- NeoGradle: `ng_dummy_ng.net.neoforged.neoforge:` -- ModDevGradle: `neoforge--merged.jar` - - ModDevGradle also has the resource files only in a separate library called `neoforge--client-extra-aka-minecraft-resources.jar`. +| Gradle Plugin | Minecraft Sources | NeoForge Sources | +|---------------|------------------------------------------------|----------------------------------------------| +| NeoGradle | `ng_dummy_ng.net.neoforged:neoforge:` | `net.neoforged:neoforge:universal:` | +| ModDevGradle | `minecraft-patched--merged.jar` | `net.neoforged:neoforge:universal:` | -Additionally, you can use your IDE's search feature - by default it's Double Shift in IntelliJ, and Ctrl+H in Eclipse - to search for specific Minecraft classes. +Additionally, you can use your IDE's search feature - by default it's Double Shift in IntelliJ IDEA, and Ctrl+H in Eclipse - to search for specific Minecraft classes or files. + +:::warning +Other IDEs may not have this integration. If you want to look at the source code - which is vital for implementing many features -, we only support IntelliJ IDEA or Eclipse. +::: ## Customizing Your Mod Information From c42ced195b9d2ec53fcee3ae1b0d8854acac1525 Mon Sep 17 00:00:00 2001 From: IchHabeHunger54 Date: Mon, 27 Jul 2026 16:30:30 +0200 Subject: [PATCH 3/3] backport updates to other versions --- .../version-1.20.4/gettingstarted/index.md | 23 +++++++++++-------- .../version-1.20.6/gettingstarted/index.md | 23 +++++++++++-------- .../version-1.21.1/gettingstarted/index.md | 23 +++++++++++-------- .../version-1.21.10/gettingstarted/index.md | 21 ++++++++++------- .../version-1.21.11/gettingstarted/index.md | 17 +++++++++----- .../version-1.21.3/gettingstarted/index.md | 23 +++++++++++-------- .../version-1.21.4/gettingstarted/index.md | 23 +++++++++++-------- .../version-1.21.5/gettingstarted/index.md | 21 ++++++++++------- .../version-1.21.8/gettingstarted/index.md | 21 ++++++++++------- 9 files changed, 120 insertions(+), 75 deletions(-) diff --git a/versioned_docs/version-1.20.4/gettingstarted/index.md b/versioned_docs/version-1.20.4/gettingstarted/index.md index 83b90e173..3a10a6c76 100644 --- a/versioned_docs/version-1.20.4/gettingstarted/index.md +++ b/versioned_docs/version-1.20.4/gettingstarted/index.md @@ -18,20 +18,25 @@ Make sure you are using a 64-bit JVM. One way of checking is to run `java -versi ## Setting Up the Workspace - Open the [Mod Developer Kit (MDK)][mdk] GitHub repository, click "Use this template" and clone the newly-created repository to your local machine. - - If you do not want to use GitHub, or if you want to get the template for an older commit, you can also download the ZIP of the repository (under Code -> Download ZIP) and extract it. -- Open your IDE and import the Gradle project. Eclipse and IntelliJ IDEA will do this automatically for you. If you have an IDE that does not do this, you can also do it via the `gradlew` terminal command. - - When doing this for the first time, Gradle will download all dependencies of NeoForge, including Minecraft itself, and decompile them. This can take a fair amount of time (up to an hour, depending on your hardware and network strength). - - Whenever you make a change to the Gradle files, the Gradle changes will need to be reloaded, either through the "Reload Gradle" button in your IDE, or again through the `gradlew` terminal command. + - If you do not want to use GitHub, or if you want to get the template for an older commit, you can also download the ZIP of the repository (under Code -> Download ZIP) and extract it. +- Open your IDE and import the Gradle project. IntelliJ IDEA and Eclipse will do this automatically for you. If you have an IDE that does not do this, you can also do it via the `gradlew` terminal command. + - When doing this for the first time, Gradle will download all dependencies of NeoForge, including Minecraft itself, and decompile them. This can take a fair amount of time (up to an hour, depending on your hardware and network strength). + - Whenever you make a change to the Gradle files, the Gradle changes will need to be reloaded, either through the "Reload Gradle" button in your IDE, or again through the `gradlew` terminal command. ### Minecraft Source Code -Once Gradle has successfully loaded, not only will you have an example mod project, but your workspace will also contain the (patched) sources and [resource files][resources] of Minecraft and NeoForge for you to reference. These sources can be found under `External Libraries` in IntelliJ, or `Referenced Libraries` in Eclipse, and have a different name depending on the Gradle plugin used: +Once Gradle has successfully loaded, not only will you have an example mod project, but your workspace will also contain the (patched) sources and [resource files][resources] of Minecraft and NeoForge for you to reference. These sources can be found under `External Libraries` in IntelliJ IDEA, or `Referenced Libraries` in Eclipse, and have a different name depending on the Gradle plugin used (where `` is the version of NeoForge used): -- NeoGradle: `ng_dummy_ng.net.neoforged.neoforge:` -- ModDevGradle: `neoforge--merged.jar` - - ModDevGradle also has the resource files only in a separate library called `neoforge--client-extra-aka-minecraft-resources.jar`. +| Gradle Plugin | Minecraft Sources | NeoForge Sources | +|---------------|------------------------------------------------|----------------------------------------------| +| NeoGradle | `ng_dummy_ng.net.neoforged:neoforge:` | `net.neoforged:neoforge:universal:` | +| ModDevGradle | `minecraft-patched--merged.jar` | `net.neoforged:neoforge:universal:` | -Additionally, you can use your IDE's search feature - by default it's Double Shift in IntelliJ, and Ctrl+H in Eclipse - to search for specific Minecraft classes. +Additionally, you can use your IDE's search feature - by default it's Double Shift in IntelliJ IDEA, and Ctrl+H in Eclipse - to search for specific Minecraft classes or files. + +:::warning +Other IDEs may not have this integration. If you want to look at the source code - which is vital for implementing many features -, we only support IntelliJ IDEA or Eclipse. +::: ## Customizing Your Mod Information diff --git a/versioned_docs/version-1.20.6/gettingstarted/index.md b/versioned_docs/version-1.20.6/gettingstarted/index.md index 599fb4e33..324b13b32 100644 --- a/versioned_docs/version-1.20.6/gettingstarted/index.md +++ b/versioned_docs/version-1.20.6/gettingstarted/index.md @@ -18,20 +18,25 @@ Make sure you are using a 64-bit JVM. One way of checking is to run `java -versi ## Setting Up the Workspace - Open the [Mod Developer Kit (MDK)][mdk] GitHub repository, click "Use this template" and clone the newly-created repository to your local machine. - - If you do not want to use GitHub, or if you want to get the template for an older commit, you can also download the ZIP of the repository (under Code -> Download ZIP) and extract it. -- Open your IDE and import the Gradle project. Eclipse and IntelliJ IDEA will do this automatically for you. If you have an IDE that does not do this, you can also do it via the `gradlew` terminal command. - - When doing this for the first time, Gradle will download all dependencies of NeoForge, including Minecraft itself, and decompile them. This can take a fair amount of time (up to an hour, depending on your hardware and network strength). - - Whenever you make a change to the Gradle files, the Gradle changes will need to be reloaded, either through the "Reload Gradle" button in your IDE, or again through the `gradlew` terminal command. + - If you do not want to use GitHub, or if you want to get the template for an older commit, you can also download the ZIP of the repository (under Code -> Download ZIP) and extract it. +- Open your IDE and import the Gradle project. IntelliJ IDEA and Eclipse will do this automatically for you. If you have an IDE that does not do this, you can also do it via the `gradlew` terminal command. + - When doing this for the first time, Gradle will download all dependencies of NeoForge, including Minecraft itself, and decompile them. This can take a fair amount of time (up to an hour, depending on your hardware and network strength). + - Whenever you make a change to the Gradle files, the Gradle changes will need to be reloaded, either through the "Reload Gradle" button in your IDE, or again through the `gradlew` terminal command. ### Minecraft Source Code -Once Gradle has successfully loaded, not only will you have an example mod project, but your workspace will also contain the (patched) sources and [resource files][resources] of Minecraft and NeoForge for you to reference. These sources can be found under `External Libraries` in IntelliJ, or `Referenced Libraries` in Eclipse, and have a different name depending on the Gradle plugin used: +Once Gradle has successfully loaded, not only will you have an example mod project, but your workspace will also contain the (patched) sources and [resource files][resources] of Minecraft and NeoForge for you to reference. These sources can be found under `External Libraries` in IntelliJ IDEA, or `Referenced Libraries` in Eclipse, and have a different name depending on the Gradle plugin used (where `` is the version of NeoForge used): -- NeoGradle: `ng_dummy_ng.net.neoforged.neoforge:` -- ModDevGradle: `neoforge--merged.jar` - - ModDevGradle also has the resource files only in a separate library called `neoforge--client-extra-aka-minecraft-resources.jar`. +| Gradle Plugin | Minecraft Sources | NeoForge Sources | +|---------------|------------------------------------------------|----------------------------------------------| +| NeoGradle | `ng_dummy_ng.net.neoforged:neoforge:` | `net.neoforged:neoforge:universal:` | +| ModDevGradle | `minecraft-patched--merged.jar` | `net.neoforged:neoforge:universal:` | -Additionally, you can use your IDE's search feature - by default it's Double Shift in IntelliJ, and Ctrl+H in Eclipse - to search for specific Minecraft classes. +Additionally, you can use your IDE's search feature - by default it's Double Shift in IntelliJ IDEA, and Ctrl+H in Eclipse - to search for specific Minecraft classes or files. + +:::warning +Other IDEs may not have this integration. If you want to look at the source code - which is vital for implementing many features -, we only support IntelliJ IDEA or Eclipse. +::: ## Customizing Your Mod Information diff --git a/versioned_docs/version-1.21.1/gettingstarted/index.md b/versioned_docs/version-1.21.1/gettingstarted/index.md index f2bdbb686..a5f100bb7 100644 --- a/versioned_docs/version-1.21.1/gettingstarted/index.md +++ b/versioned_docs/version-1.21.1/gettingstarted/index.md @@ -18,20 +18,25 @@ Make sure you are using a 64-bit JVM. One way of checking is to run `java -versi ## Setting Up the Workspace - Open the Mod Developer Kit (MDK) (either [ModDevGradle][mdgmdk] or [NeoGradle][ngmdk]) GitHub repository, click "Use this template" and clone the newly-created repository to your local machine. - - If you do not want to use GitHub, or if you want to get the template for an older commit, you can also download the ZIP of the repository (under Code -> Download ZIP) and extract it. -- Open your IDE and import the Gradle project. Eclipse and IntelliJ IDEA will do this automatically for you. If you have an IDE that does not do this, you can also do it via the `gradlew` terminal command. - - When doing this for the first time, Gradle will download all dependencies of NeoForge, including Minecraft itself, and decompile them. This can take a fair amount of time (up to an hour, depending on your hardware and network strength). - - Whenever you make a change to the Gradle files, the Gradle changes will need to be reloaded, either through the "Reload Gradle" button in your IDE, or again through the `gradlew` terminal command. + - If you do not want to use GitHub, or if you want to get the template for an older commit, you can also download the ZIP of the repository (under Code -> Download ZIP) and extract it. +- Open your IDE and import the Gradle project. IntelliJ IDEA and Eclipse will do this automatically for you. If you have an IDE that does not do this, you can also do it via the `gradlew` terminal command. + - When doing this for the first time, Gradle will download all dependencies of NeoForge, including Minecraft itself, and decompile them. This can take a fair amount of time (up to an hour, depending on your hardware and network strength). + - Whenever you make a change to the Gradle files, the Gradle changes will need to be reloaded, either through the "Reload Gradle" button in your IDE, or again through the `gradlew` terminal command. ### Minecraft Source Code -Once Gradle has successfully loaded, not only will you have an example mod project, but your workspace will also contain the (patched) sources and [resource files][resources] of Minecraft and NeoForge for you to reference. These sources can be found under `External Libraries` in IntelliJ, or `Referenced Libraries` in Eclipse, and have a different name depending on the Gradle plugin used: +Once Gradle has successfully loaded, not only will you have an example mod project, but your workspace will also contain the (patched) sources and [resource files][resources] of Minecraft and NeoForge for you to reference. These sources can be found under `External Libraries` in IntelliJ IDEA, or `Referenced Libraries` in Eclipse, and have a different name depending on the Gradle plugin used (where `` is the version of NeoForge used): -- NeoGradle: `ng_dummy_ng.net.neoforged.neoforge:` -- ModDevGradle: `neoforge--merged.jar` - - ModDevGradle also has the resource files only in a separate library called `neoforge--client-extra-aka-minecraft-resources.jar`. +| Gradle Plugin | Minecraft Sources | NeoForge Sources | +|---------------|------------------------------------------------|----------------------------------------------| +| NeoGradle | `ng_dummy_ng.net.neoforged:neoforge:` | `net.neoforged:neoforge:universal:` | +| ModDevGradle | `minecraft-patched--merged.jar` | `net.neoforged:neoforge:universal:` | -Additionally, you can use your IDE's search feature - by default it's Double Shift in IntelliJ, and Ctrl+H in Eclipse - to search for specific Minecraft classes. +Additionally, you can use your IDE's search feature - by default it's Double Shift in IntelliJ IDEA, and Ctrl+H in Eclipse - to search for specific Minecraft classes or files. + +:::warning +Other IDEs may not have this integration. If you want to look at the source code - which is vital for implementing many features -, we only support IntelliJ IDEA or Eclipse. +::: ## Customizing Your Mod Information diff --git a/versioned_docs/version-1.21.10/gettingstarted/index.md b/versioned_docs/version-1.21.10/gettingstarted/index.md index d6910cc86..3e289266c 100644 --- a/versioned_docs/version-1.21.10/gettingstarted/index.md +++ b/versioned_docs/version-1.21.10/gettingstarted/index.md @@ -18,19 +18,24 @@ Make sure you are using a 64-bit JVM. One way of checking is to run `java -versi ## Setting Up the Workspace - Go to the [Mod Generator](https://neoforged.net/mod-generator/) webpage, type in a mod name (and optionally a mod id), package name, Minecraft version, and Gradle plugin (either [ModDevGradle][mdg] or [NeoGradle][ng]), click "Download Mod Project", and extract the downloaded ZIP file. -- Open your IDE and import the Gradle project. Eclipse and IntelliJ IDEA will do this automatically for you. If you have an IDE that does not do this, you can also do it via the `gradlew` terminal command. - - When doing this for the first time, Gradle will download all dependencies of NeoForge, including Minecraft itself, and decompile them. This can take a fair amount of time (up to an hour, depending on your hardware and network strength). - - Whenever you make a change to the Gradle files, the Gradle changes will need to be reloaded, either through the "Reload Gradle" button in your IDE, or again through the `gradlew` terminal command. +- Open your IDE and import the Gradle project. IntelliJ IDEA and Eclipse will do this automatically for you. If you have an IDE that does not do this, you can also do it via the `gradlew` terminal command. + - When doing this for the first time, Gradle will download all dependencies of NeoForge, including Minecraft itself, and decompile them. This can take a fair amount of time (up to an hour, depending on your hardware and network strength). + - Whenever you make a change to the Gradle files, the Gradle changes will need to be reloaded, either through the "Reload Gradle" button in your IDE, or again through the `gradlew` terminal command. ### Minecraft Source Code -Once Gradle has successfully loaded, not only will you have an example mod project, but your workspace will also contain the (patched) sources and [resource files][resources] of Minecraft and NeoForge for you to reference. These sources can be found under `External Libraries` in IntelliJ, or `Referenced Libraries` in Eclipse, and have a different name depending on the Gradle plugin used: +Once Gradle has successfully loaded, not only will you have an example mod project, but your workspace will also contain the (patched) sources and [resource files][resources] of Minecraft and NeoForge for you to reference. These sources can be found under `External Libraries` in IntelliJ IDEA, or `Referenced Libraries` in Eclipse, and have a different name depending on the Gradle plugin used (where `` is the version of NeoForge used): -- NeoGradle: `ng_dummy_ng.net.neoforged.neoforge:` -- ModDevGradle: `neoforge--merged.jar` - - ModDevGradle also has the resource files only in a separate library called `neoforge--client-extra-aka-minecraft-resources.jar`. +| Gradle Plugin | Minecraft Sources | NeoForge Sources | +|---------------|------------------------------------------------|----------------------------------------------| +| NeoGradle | `ng_dummy_ng.net.neoforged:neoforge:` | `net.neoforged:neoforge:universal:` | +| ModDevGradle | `minecraft-patched--merged.jar` | `net.neoforged:neoforge:universal:` | -Additionally, you can use your IDE's search feature - by default it's Double Shift in IntelliJ, and Ctrl+H in Eclipse - to search for specific Minecraft classes. +Additionally, you can use your IDE's search feature - by default it's Double Shift in IntelliJ IDEA, and Ctrl+H in Eclipse - to search for specific Minecraft classes or files. + +:::warning +Other IDEs may not have this integration. If you want to look at the source code - which is vital for implementing many features -, we only support IntelliJ IDEA or Eclipse. +::: ## Customizing Your Mod Information diff --git a/versioned_docs/version-1.21.11/gettingstarted/index.md b/versioned_docs/version-1.21.11/gettingstarted/index.md index 951752608..0903e8ed3 100644 --- a/versioned_docs/version-1.21.11/gettingstarted/index.md +++ b/versioned_docs/version-1.21.11/gettingstarted/index.md @@ -18,19 +18,24 @@ Make sure you are using a 64-bit JVM. One way of checking is to run `java -versi ## Setting Up the Workspace - Go to the [Mod Generator][modgen] webpage, type in a mod name (and optionally a mod id), package name, Minecraft version, and Gradle plugin (either [ModDevGradle][mdg] or [NeoGradle][ng]), click "Download Mod Project", and extract the downloaded ZIP file. -- Open your IDE and import the Gradle project. Eclipse and IntelliJ IDEA will do this automatically for you. If you have an IDE that does not do this, you can also do it via the `gradlew` terminal command. +- Open your IDE and import the Gradle project. IntelliJ IDEA and Eclipse will do this automatically for you. If you have an IDE that does not do this, you can also do it via the `gradlew` terminal command. - When doing this for the first time, Gradle will download all dependencies of NeoForge, including Minecraft itself, and decompile them. This can take a fair amount of time (up to an hour, depending on your hardware and network strength). - Whenever you make a change to the Gradle files, the Gradle changes will need to be reloaded, either through the "Reload Gradle" button in your IDE, or again through the `gradlew` terminal command. ### Minecraft Source Code -Once Gradle has successfully loaded, not only will you have an example mod project, but your workspace will also contain the (patched) sources and [resource files][resources] of Minecraft and NeoForge for you to reference. These sources can be found under `External Libraries` in IntelliJ, or `Referenced Libraries` in Eclipse, and have a different name depending on the Gradle plugin used: +Once Gradle has successfully loaded, not only will you have an example mod project, but your workspace will also contain the (patched) sources and [resource files][resources] of Minecraft and NeoForge for you to reference. These sources can be found under `External Libraries` in IntelliJ IDEA, or `Referenced Libraries` in Eclipse, and have a different name depending on the Gradle plugin used (where `` is the version of NeoForge used): -- NeoGradle: `ng_dummy_ng.net.neoforged.neoforge:` -- ModDevGradle: `neoforge--merged.jar` - - ModDevGradle also has the resource files only in a separate library called `neoforge--client-extra-aka-minecraft-resources.jar`. +| Gradle Plugin | Minecraft Sources | NeoForge Sources | +|---------------|------------------------------------------------|----------------------------------------------| +| NeoGradle | `ng_dummy_ng.net.neoforged:neoforge:` | `net.neoforged:neoforge:universal:` | +| ModDevGradle | `minecraft-patched--merged.jar` | `net.neoforged:neoforge:universal:` | -Additionally, you can use your IDE's search feature - by default it's Double Shift in IntelliJ, and Ctrl+H in Eclipse - to search for specific Minecraft classes. +Additionally, you can use your IDE's search feature - by default it's Double Shift in IntelliJ IDEA, and Ctrl+H in Eclipse - to search for specific Minecraft classes or files. + +:::warning +Other IDEs may not have this integration. If you want to look at the source code - which is vital for implementing many features -, we only support IntelliJ IDEA or Eclipse. +::: ## Customizing Your Mod Information diff --git a/versioned_docs/version-1.21.3/gettingstarted/index.md b/versioned_docs/version-1.21.3/gettingstarted/index.md index 1b2ebca5d..2a9d787bd 100644 --- a/versioned_docs/version-1.21.3/gettingstarted/index.md +++ b/versioned_docs/version-1.21.3/gettingstarted/index.md @@ -18,20 +18,25 @@ Make sure you are using a 64-bit JVM. One way of checking is to run `java -versi ## Setting Up the Workspace - Open the Mod Developer Kit (MDK) (either [ModDevGradle][mdgmdk] or [NeoGradle][ngmdk]) GitHub repository, click "Use this template" and clone the newly-created repository to your local machine. - - If you do not want to use GitHub, or if you want to get the template for an older commit, you can also download the ZIP of the repository (under Code -> Download ZIP) and extract it. -- Open your IDE and import the Gradle project. Eclipse and IntelliJ IDEA will do this automatically for you. If you have an IDE that does not do this, you can also do it via the `gradlew` terminal command. - - When doing this for the first time, Gradle will download all dependencies of NeoForge, including Minecraft itself, and decompile them. This can take a fair amount of time (up to an hour, depending on your hardware and network strength). - - Whenever you make a change to the Gradle files, the Gradle changes will need to be reloaded, either through the "Reload Gradle" button in your IDE, or again through the `gradlew` terminal command. + - If you do not want to use GitHub, or if you want to get the template for an older commit, you can also download the ZIP of the repository (under Code -> Download ZIP) and extract it. +- Open your IDE and import the Gradle project. IntelliJ IDEA and Eclipse will do this automatically for you. If you have an IDE that does not do this, you can also do it via the `gradlew` terminal command. + - When doing this for the first time, Gradle will download all dependencies of NeoForge, including Minecraft itself, and decompile them. This can take a fair amount of time (up to an hour, depending on your hardware and network strength). + - Whenever you make a change to the Gradle files, the Gradle changes will need to be reloaded, either through the "Reload Gradle" button in your IDE, or again through the `gradlew` terminal command. ### Minecraft Source Code -Once Gradle has successfully loaded, not only will you have an example mod project, but your workspace will also contain the (patched) sources and [resource files][resources] of Minecraft and NeoForge for you to reference. These sources can be found under `External Libraries` in IntelliJ, or `Referenced Libraries` in Eclipse, and have a different name depending on the Gradle plugin used: +Once Gradle has successfully loaded, not only will you have an example mod project, but your workspace will also contain the (patched) sources and [resource files][resources] of Minecraft and NeoForge for you to reference. These sources can be found under `External Libraries` in IntelliJ IDEA, or `Referenced Libraries` in Eclipse, and have a different name depending on the Gradle plugin used (where `` is the version of NeoForge used): -- NeoGradle: `ng_dummy_ng.net.neoforged.neoforge:` -- ModDevGradle: `neoforge--merged.jar` - - ModDevGradle also has the resource files only in a separate library called `neoforge--client-extra-aka-minecraft-resources.jar`. +| Gradle Plugin | Minecraft Sources | NeoForge Sources | +|---------------|------------------------------------------------|----------------------------------------------| +| NeoGradle | `ng_dummy_ng.net.neoforged:neoforge:` | `net.neoforged:neoforge:universal:` | +| ModDevGradle | `minecraft-patched--merged.jar` | `net.neoforged:neoforge:universal:` | -Additionally, you can use your IDE's search feature - by default it's Double Shift in IntelliJ, and Ctrl+H in Eclipse - to search for specific Minecraft classes. +Additionally, you can use your IDE's search feature - by default it's Double Shift in IntelliJ IDEA, and Ctrl+H in Eclipse - to search for specific Minecraft classes or files. + +:::warning +Other IDEs may not have this integration. If you want to look at the source code - which is vital for implementing many features -, we only support IntelliJ IDEA or Eclipse. +::: ## Customizing Your Mod Information diff --git a/versioned_docs/version-1.21.4/gettingstarted/index.md b/versioned_docs/version-1.21.4/gettingstarted/index.md index 7be9f5735..8c3f61222 100644 --- a/versioned_docs/version-1.21.4/gettingstarted/index.md +++ b/versioned_docs/version-1.21.4/gettingstarted/index.md @@ -18,20 +18,25 @@ Make sure you are using a 64-bit JVM. One way of checking is to run `java -versi ## Setting Up the Workspace - Open the Mod Developer Kit (MDK) (either [ModDevGradle][mdgmdk] or [NeoGradle][ngmdk]) GitHub repository, click "Use this template" and clone the newly-created repository to your local machine. - - If you do not want to use GitHub, or if you want to get the template for an older commit, you can also download the ZIP of the repository (under Code -> Download ZIP) and extract it. -- Open your IDE and import the Gradle project. Eclipse and IntelliJ IDEA will do this automatically for you. If you have an IDE that does not do this, you can also do it via the `gradlew` terminal command. - - When doing this for the first time, Gradle will download all dependencies of NeoForge, including Minecraft itself, and decompile them. This can take a fair amount of time (up to an hour, depending on your hardware and network strength). - - Whenever you make a change to the Gradle files, the Gradle changes will need to be reloaded, either through the "Reload Gradle" button in your IDE, or again through the `gradlew` terminal command. + - If you do not want to use GitHub, or if you want to get the template for an older commit, you can also download the ZIP of the repository (under Code -> Download ZIP) and extract it. +- Open your IDE and import the Gradle project. IntelliJ IDEA and Eclipse will do this automatically for you. If you have an IDE that does not do this, you can also do it via the `gradlew` terminal command. + - When doing this for the first time, Gradle will download all dependencies of NeoForge, including Minecraft itself, and decompile them. This can take a fair amount of time (up to an hour, depending on your hardware and network strength). + - Whenever you make a change to the Gradle files, the Gradle changes will need to be reloaded, either through the "Reload Gradle" button in your IDE, or again through the `gradlew` terminal command. ### Minecraft Source Code -Once Gradle has successfully loaded, not only will you have an example mod project, but your workspace will also contain the (patched) sources and [resource files][resources] of Minecraft and NeoForge for you to reference. These sources can be found under `External Libraries` in IntelliJ, or `Referenced Libraries` in Eclipse, and have a different name depending on the Gradle plugin used: +Once Gradle has successfully loaded, not only will you have an example mod project, but your workspace will also contain the (patched) sources and [resource files][resources] of Minecraft and NeoForge for you to reference. These sources can be found under `External Libraries` in IntelliJ IDEA, or `Referenced Libraries` in Eclipse, and have a different name depending on the Gradle plugin used (where `` is the version of NeoForge used): -- NeoGradle: `ng_dummy_ng.net.neoforged.neoforge:` -- ModDevGradle: `neoforge--merged.jar` - - ModDevGradle also has the resource files only in a separate library called `neoforge--client-extra-aka-minecraft-resources.jar`. +| Gradle Plugin | Minecraft Sources | NeoForge Sources | +|---------------|------------------------------------------------|----------------------------------------------| +| NeoGradle | `ng_dummy_ng.net.neoforged:neoforge:` | `net.neoforged:neoforge:universal:` | +| ModDevGradle | `minecraft-patched--merged.jar` | `net.neoforged:neoforge:universal:` | -Additionally, you can use your IDE's search feature - by default it's Double Shift in IntelliJ, and Ctrl+H in Eclipse - to search for specific Minecraft classes. +Additionally, you can use your IDE's search feature - by default it's Double Shift in IntelliJ IDEA, and Ctrl+H in Eclipse - to search for specific Minecraft classes or files. + +:::warning +Other IDEs may not have this integration. If you want to look at the source code - which is vital for implementing many features -, we only support IntelliJ IDEA or Eclipse. +::: ## Customizing Your Mod Information diff --git a/versioned_docs/version-1.21.5/gettingstarted/index.md b/versioned_docs/version-1.21.5/gettingstarted/index.md index 211924032..3cd201e34 100644 --- a/versioned_docs/version-1.21.5/gettingstarted/index.md +++ b/versioned_docs/version-1.21.5/gettingstarted/index.md @@ -18,19 +18,24 @@ Make sure you are using a 64-bit JVM. One way of checking is to run `java -versi ## Setting Up the Workspace - Go to the [Mod Generator](https://neoforged.net/mod-generator/) webpage, type in a mod name (and optionally a mod id), package name, Minecraft version, and Gradle plugin (either [ModDevGradle][mdg] or [NeoGradle][ng]), click "Download Mod Project", and extract the downloaded ZIP file. -- Open your IDE and import the Gradle project. Eclipse and IntelliJ IDEA will do this automatically for you. If you have an IDE that does not do this, you can also do it via the `gradlew` terminal command. - - When doing this for the first time, Gradle will download all dependencies of NeoForge, including Minecraft itself, and decompile them. This can take a fair amount of time (up to an hour, depending on your hardware and network strength). - - Whenever you make a change to the Gradle files, the Gradle changes will need to be reloaded, either through the "Reload Gradle" button in your IDE, or again through the `gradlew` terminal command. +- Open your IDE and import the Gradle project. IntelliJ IDEA and Eclipse will do this automatically for you. If you have an IDE that does not do this, you can also do it via the `gradlew` terminal command. + - When doing this for the first time, Gradle will download all dependencies of NeoForge, including Minecraft itself, and decompile them. This can take a fair amount of time (up to an hour, depending on your hardware and network strength). + - Whenever you make a change to the Gradle files, the Gradle changes will need to be reloaded, either through the "Reload Gradle" button in your IDE, or again through the `gradlew` terminal command. ### Minecraft Source Code -Once Gradle has successfully loaded, not only will you have an example mod project, but your workspace will also contain the (patched) sources and [resource files][resources] of Minecraft and NeoForge for you to reference. These sources can be found under `External Libraries` in IntelliJ, or `Referenced Libraries` in Eclipse, and have a different name depending on the Gradle plugin used: +Once Gradle has successfully loaded, not only will you have an example mod project, but your workspace will also contain the (patched) sources and [resource files][resources] of Minecraft and NeoForge for you to reference. These sources can be found under `External Libraries` in IntelliJ IDEA, or `Referenced Libraries` in Eclipse, and have a different name depending on the Gradle plugin used (where `` is the version of NeoForge used): -- NeoGradle: `ng_dummy_ng.net.neoforged.neoforge:` -- ModDevGradle: `neoforge--merged.jar` - - ModDevGradle also has the resource files only in a separate library called `neoforge--client-extra-aka-minecraft-resources.jar`. +| Gradle Plugin | Minecraft Sources | NeoForge Sources | +|---------------|------------------------------------------------|----------------------------------------------| +| NeoGradle | `ng_dummy_ng.net.neoforged:neoforge:` | `net.neoforged:neoforge:universal:` | +| ModDevGradle | `minecraft-patched--merged.jar` | `net.neoforged:neoforge:universal:` | -Additionally, you can use your IDE's search feature - by default it's Double Shift in IntelliJ, and Ctrl+H in Eclipse - to search for specific Minecraft classes. +Additionally, you can use your IDE's search feature - by default it's Double Shift in IntelliJ IDEA, and Ctrl+H in Eclipse - to search for specific Minecraft classes or files. + +:::warning +Other IDEs may not have this integration. If you want to look at the source code - which is vital for implementing many features -, we only support IntelliJ IDEA or Eclipse. +::: ## Customizing Your Mod Information diff --git a/versioned_docs/version-1.21.8/gettingstarted/index.md b/versioned_docs/version-1.21.8/gettingstarted/index.md index d6910cc86..3e289266c 100644 --- a/versioned_docs/version-1.21.8/gettingstarted/index.md +++ b/versioned_docs/version-1.21.8/gettingstarted/index.md @@ -18,19 +18,24 @@ Make sure you are using a 64-bit JVM. One way of checking is to run `java -versi ## Setting Up the Workspace - Go to the [Mod Generator](https://neoforged.net/mod-generator/) webpage, type in a mod name (and optionally a mod id), package name, Minecraft version, and Gradle plugin (either [ModDevGradle][mdg] or [NeoGradle][ng]), click "Download Mod Project", and extract the downloaded ZIP file. -- Open your IDE and import the Gradle project. Eclipse and IntelliJ IDEA will do this automatically for you. If you have an IDE that does not do this, you can also do it via the `gradlew` terminal command. - - When doing this for the first time, Gradle will download all dependencies of NeoForge, including Minecraft itself, and decompile them. This can take a fair amount of time (up to an hour, depending on your hardware and network strength). - - Whenever you make a change to the Gradle files, the Gradle changes will need to be reloaded, either through the "Reload Gradle" button in your IDE, or again through the `gradlew` terminal command. +- Open your IDE and import the Gradle project. IntelliJ IDEA and Eclipse will do this automatically for you. If you have an IDE that does not do this, you can also do it via the `gradlew` terminal command. + - When doing this for the first time, Gradle will download all dependencies of NeoForge, including Minecraft itself, and decompile them. This can take a fair amount of time (up to an hour, depending on your hardware and network strength). + - Whenever you make a change to the Gradle files, the Gradle changes will need to be reloaded, either through the "Reload Gradle" button in your IDE, or again through the `gradlew` terminal command. ### Minecraft Source Code -Once Gradle has successfully loaded, not only will you have an example mod project, but your workspace will also contain the (patched) sources and [resource files][resources] of Minecraft and NeoForge for you to reference. These sources can be found under `External Libraries` in IntelliJ, or `Referenced Libraries` in Eclipse, and have a different name depending on the Gradle plugin used: +Once Gradle has successfully loaded, not only will you have an example mod project, but your workspace will also contain the (patched) sources and [resource files][resources] of Minecraft and NeoForge for you to reference. These sources can be found under `External Libraries` in IntelliJ IDEA, or `Referenced Libraries` in Eclipse, and have a different name depending on the Gradle plugin used (where `` is the version of NeoForge used): -- NeoGradle: `ng_dummy_ng.net.neoforged.neoforge:` -- ModDevGradle: `neoforge--merged.jar` - - ModDevGradle also has the resource files only in a separate library called `neoforge--client-extra-aka-minecraft-resources.jar`. +| Gradle Plugin | Minecraft Sources | NeoForge Sources | +|---------------|------------------------------------------------|----------------------------------------------| +| NeoGradle | `ng_dummy_ng.net.neoforged:neoforge:` | `net.neoforged:neoforge:universal:` | +| ModDevGradle | `minecraft-patched--merged.jar` | `net.neoforged:neoforge:universal:` | -Additionally, you can use your IDE's search feature - by default it's Double Shift in IntelliJ, and Ctrl+H in Eclipse - to search for specific Minecraft classes. +Additionally, you can use your IDE's search feature - by default it's Double Shift in IntelliJ IDEA, and Ctrl+H in Eclipse - to search for specific Minecraft classes or files. + +:::warning +Other IDEs may not have this integration. If you want to look at the source code - which is vital for implementing many features -, we only support IntelliJ IDEA or Eclipse. +::: ## Customizing Your Mod Information