Skip to content

Commit

Permalink
feat(docs): Update getting started
Browse files Browse the repository at this point in the history
  • Loading branch information
ChampionAsh5357 committed Dec 14, 2024
1 parent 57563ac commit 69caab1
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 2 deletions.
4 changes: 2 additions & 2 deletions docs/gettingstarted/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ You should always test your mod in a dedicated server environment. This includes
[github]: https://github.com/
[intellij]: https://www.jetbrains.com/idea/
[jdk]: https://learn.microsoft.com/en-us/java/openjdk/download#openjdk-21
[mdgmdk]: https://github.com/NeoForgeMDKs/MDK-1.21-ModDevGradle
[ngmdk]: https://github.com/NeoForgeMDKs/MDK-1.21-NeoGradle
[mdgmdk]: https://github.com/NeoForgeMDKs/MDK-1.21.4-ModDevGradle
[ngmdk]: https://github.com/NeoForgeMDKs/MDK-1.21.4-NeoGradle
[neogradle]: https://docs.neoforged.net/neogradle/docs/
[properties]: modfiles.md#gradleproperties
3 changes: 3 additions & 0 deletions docs/gettingstarted/modfiles.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,9 @@ Most values are also explained as comments in [the MDK's `gradle.properties` fil
|---------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------|
| `org.gradle.jvmargs` | Allows you to pass extra JVM arguments to Gradle. Most commonly, this is used to assign more/less memory to Gradle. Note that this is for Gradle itself, not Minecraft. | `org.gradle.jvmargs=-Xmx3G` |
| `org.gradle.daemon` | Whether Gradle should use the daemon when building. | `org.gradle.daemon=false` |
| `org.gradle.parallel` | Whether Gradle should fork JVMs to execute projects in parallel. | `org.gradle.parallel=false` |
| `org.gradle.caching` | Whether Gradle should reuse task outputs from previous builds. | `org.gradle.caching=false` |
| `org.gradle.configuration-cache` | Whether Gradle should reuse the build configuration from previous builds. | `org.gradle.configuration-cache=false` |
| `org.gradle.debug` | Whether Gradle is set to debug mode. Debug mode mainly means more Gradle log output. Note that this is for Gradle itself, not Minecraft. | `org.gradle.debug=false` |
| `minecraft_version` | The Minecraft version you are modding on. Must match with `neo_version`. | `minecraft_version=1.20.6` |
| `minecraft_version_range` | The Minecraft version range this mod can use, as a [Maven Version Range][mvr]. Note that [snapshots, pre-releases and release candidates][mcversioning] are not guaranteed to sort properly, as they do not follow maven versioning. | `minecraft_version_range=[1.20.6,1.21)` |
Expand Down

1 comment on commit 69caab1

@neoforged-pages-deployments
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Deploying with Cloudflare Pages

Name Result
Last commit: 69caab1b67d536741f4d71354a072e3f9a65e2ca
Status: ✅ Deploy successful!
Preview URL: https://25f20ada.neoforged-docs-previews.pages.dev
PR Preview URL: https://pr-211.neoforged-docs-previews.pages.dev

Please sign in to comment.