Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 17 additions & 1 deletion docs/gettingstarted/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,10 +18,25 @@ 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 IDEA, or `Referenced Libraries` in Eclipse, and have a different name depending on the Gradle plugin used (where `<version>` is the version of NeoForge used):

| Gradle Plugin | Minecraft Sources | NeoForge Sources |
|---------------|------------------------------------------------|----------------------------------------------|
| NeoGradle | `ng_dummy_ng.net.neoforged:neoforge:<version>` | `net.neoforged:neoforge:universal:<version>` |
| ModDevGradle | `minecraft-patched-<version>-merged.jar` | `net.neoforged:neoforge:universal:<version>` |

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

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].
Expand Down Expand Up @@ -58,3 +73,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
24 changes: 20 additions & 4 deletions versioned_docs/version-1.20.4/gettingstarted/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,10 +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 IDEA, or `Referenced Libraries` in Eclipse, and have a different name depending on the Gradle plugin used (where `<version>` is the version of NeoForge used):

| Gradle Plugin | Minecraft Sources | NeoForge Sources |
|---------------|------------------------------------------------|----------------------------------------------|
| NeoGradle | `ng_dummy_ng.net.neoforged:neoforge:<version>` | `net.neoforged:neoforge:universal:<version>` |
| ModDevGradle | `minecraft-patched-<version>-merged.jar` | `net.neoforged:neoforge:universal:<version>` |

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

Expand Down Expand Up @@ -58,3 +73,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
24 changes: 20 additions & 4 deletions versioned_docs/version-1.20.6/gettingstarted/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,10 +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 IDEA, or `Referenced Libraries` in Eclipse, and have a different name depending on the Gradle plugin used (where `<version>` is the version of NeoForge used):

| Gradle Plugin | Minecraft Sources | NeoForge Sources |
|---------------|------------------------------------------------|----------------------------------------------|
| NeoGradle | `ng_dummy_ng.net.neoforged:neoforge:<version>` | `net.neoforged:neoforge:universal:<version>` |
| ModDevGradle | `minecraft-patched-<version>-merged.jar` | `net.neoforged:neoforge:universal:<version>` |

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

Expand Down Expand Up @@ -58,3 +73,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
24 changes: 20 additions & 4 deletions versioned_docs/version-1.21.1/gettingstarted/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,10 +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 IDEA, or `Referenced Libraries` in Eclipse, and have a different name depending on the Gradle plugin used (where `<version>` is the version of NeoForge used):

| Gradle Plugin | Minecraft Sources | NeoForge Sources |
|---------------|------------------------------------------------|----------------------------------------------|
| NeoGradle | `ng_dummy_ng.net.neoforged:neoforge:<version>` | `net.neoforged:neoforge:universal:<version>` |
| ModDevGradle | `minecraft-patched-<version>-merged.jar` | `net.neoforged:neoforge:universal:<version>` |

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

Expand Down Expand Up @@ -59,3 +74,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
22 changes: 19 additions & 3 deletions versioned_docs/version-1.21.10/gettingstarted/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,9 +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 IDEA, or `Referenced Libraries` in Eclipse, and have a different name depending on the Gradle plugin used (where `<version>` is the version of NeoForge used):

| Gradle Plugin | Minecraft Sources | NeoForge Sources |
|---------------|------------------------------------------------|----------------------------------------------|
| NeoGradle | `ng_dummy_ng.net.neoforged:neoforge:<version>` | `net.neoforged:neoforge:universal:<version>` |
| ModDevGradle | `minecraft-patched-<version>-merged.jar` | `net.neoforged:neoforge:universal:<version>` |

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

Expand Down Expand Up @@ -58,3 +73,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
Loading
Loading