Differences

This shows you the differences between two versions of the page.

--- tutorial:setup [2020/02/21 11:38] – Rearranging and add generator mkpoli
+++ tutorial:setup [2021/09/17 14:46] – some tweaks siglong
@@ Line 2: / Line 2: @@
 ===== Prerequisites =====
+   * A Java Development Kit (JDK) for Java 16 (recommended) or newer. Visit [[https://adoptopenjdk.net/]] for installers.
-   * A Java Development Kit (JDK) for Java 8 (recommended) or newer [[https://adoptopenjdk.net/]]
+       * If you are professional, you can obtain a JDK from [[http://jdk.java.net/]], which needs to be extracted and have system variables set up manually.
    * Any Java IDE, for example [[https://www.jetbrains.com/idea/download/#section=windows|Intellij IDEA]] and [[https://www.eclipse.org/downloads/|Eclipse]]. You may also use any other code editors, such as [[https://code.visualstudio.com/|Visual Studio Code]].
+       * If you are not familiar with any of these, we recommend to use Intellij IDEA as that is what most people choose for modding.
+==== Minecraft Development (mcdev) IntelliJ IDEA Plugin  ====
+If you are using IntelliJ IDEA you can use the [[https://plugins.jetbrains.com/plugin/8327|MinecraftDev plugin]].
+This plugin adds support for automatically generating Fabric projects as well as some mixin related features like inspections,
+generating accessors/shadow fields, and copying Mixin Target References (JVM Descriptors).
+You can install it using IntelliJ's internal plugin browser by navigating to File → Settings → Plugins,
+then clicking the Marketplace tab and searching for Minecraft.
 ===== Mod Startup =====
+There are two main ways to make a new mod for Minecraft based on Fabric.
+You can either manually download fabric-example-mod and setup by yourself, or use automatic tools for you.
+**NOTE:** The template in the mcdev plugin blindly uses the latest unstable version of the loom. Use with caution.
 ==== Manual Steps ====
-   - Copy the starting files from [[https://github.com/FabricMC/fabric-example-mod/|fabric-example-mod]] (or from [[https://github.com/natanfudge/fabric-example-mod-kotlin|the Kotlin version]], if you wish to use Kotlin,) excluding the ''LICENSE'' and ''README.md'' files - as those apply to the template itself, not necessarily to your mod.
+   - Copy the starting files from [[https://github.com/FabricMC/fabric-example-mod/|fabric-example-mod]] (or from [[https://github.com/SmushyTaco/Example-Mod/|the Kotlin version]], if you wish to use Kotlin,) excluding the ''LICENSE'' and ''README.md'' files - as those apply to the template itself, not necessarily to your mod.
    - Edit ''gradle.properties'':
        * Make sure to set ''archives_base_name'' and ''maven_group'' to your preferred values.
-       * Make sure to update the versions of Minecraft, the mappings and the loader - all of which can be queried through [[https://modmuss50.me/fabric.html|this website]] - to match the versions you wish to target.
+       * Make sure to update the versions of Minecraft, the mappings, the loader and the loom - all of which can be queried through https://fabricmc.net/versions.html - to match the versions you wish to target.
        * Add any other dependencies you plan to use in ''build.gradle''.
    - Import the build.gradle file to your IDE. You may refer to the next section for specific IDE's.
    - Happy modding!
-You can generate the Minecraft sources for reference (since IDEA already has a decompiler this is only useful for searching through the code) :
+If you are unable to use the mc plugin or the fabric-example-mod, you may also use [[https://github.com/ExtraCrafTX/GeneratorFabricMod|GeneratorFabricMod]] by ExtraCrafTX, a convenient tool to automatically generate new fabric mods from template. Follow these steps:
- Run the ''genSources'' Gradle task. If your IDE doesn't have Gradle integration, then run the following command in the terminal: ''gradlew genSources'' (or ''.gradlew genSources'' on Linux/MacOS).
+  - Download latest release of GeneratorFabricMod [[https://github.com/ExtraCrafTX/GeneratorFabricMod/releases|here]] and extract them.
+  - Make a new directory, then run a command shell there and type ''path/to/GeneratorFabricMod/bin/GeneratorFabricMod''.
+  - After letting it get its dependencies, follow the instructions and input required information.
+  - You're now done, just open the project folder with in your IDE.
 === IntelliJ IDEA ===
 If you are using IntelliJ IDEA by JetBrains, please follow these steps:
-    - Run ''gradlew idea'' first, then import the Project to IDEA.
+    - In the IDEA main menu, select 'Import Project' (or File -> Open... if you already have a project open).
-    - In order to run/debug your project, go to menu ''Run -> Edit Configurations...''. In ''Run/Debug Configuration'' dialog, find ''Application > Minecraft Client'' and change ''Use classpath of module'' form ''[ProjectName]'' to ''[ProjectName].main'', then change for ''Application > Minecraft Server'' as well. After pressing OK, you will know see Minecraft Client and Minecraft Server now showing up at Run/Debug Toolbar.
+    - Select the project's build.gradle file to import the project.
+    - After Gradle is done setting up, close (File -> Close Project) and re-open the project to fix run configurations not displaying correctly.
+    - (If the run configurations still don't show up, try reimporting the Gradle project from the Gradle tab in IDEA.)
+//Optional, but recommended//:
+By default, IntelliJ delegates to Gradle to build the project. This is unnecessary for Fabric and causes longer build times and hotswapping related weirdness, among other problems. To make it use the builtin compiler:
+    - Open the 'Gradle Settings' dialog from the Gradle tab.
+    - Change the 'Build and run using' and 'Run tests using' fields to 'IntelliJ IDEA'.
+    - Go to File -> Project Structure -> Project and set 'Project compiler output' to ''$PROJECT_DIR$/out''.
+Unfortunately, it is currently impossible to set an IDE-wide default for the 'Build and run using' and 'Run tests using' options, so these steps have to be repeated for every new project.
+**NOTE:** Don't run the ''idea'' gradle task. It is known to break development environment.
 === Eclipse ===
-If you are using Eclipse and you would like to have the IDE run configs you can run ''gradlew eclipse''.
+If you are using Eclipse and you would like to have the IDE run configs you can run ''gradlew eclipse''. The project can then be imported as a normal (non-gradle) Eclipse project into your workspace using the 'File' - 'Import...' menu, then 'General' -> 'Existing Projects into Workspace'.
 === Visual Studio Code ===
-If you are using VSCode by Microsoft, please follow [[tutorial:vscode_setup|these instructions]]
+If you are using VSCode, please follow [[tutorial:vscode_setup|these instructions]].
-==== Generator ====
+===== Generating Minecraft Sources =====
-You many also use [[https://github.com/ExtraCrafTX/GeneratorFabricMod|GeneratorFabricMod]] by ExtraCrafTX, a convenient tool to automatically generate new fabric mods from template. Follow these steps:
+Reading the Minecraft source is an essential part of modding.
-  - Download latest release of GeneratorFabricMod [[https://github.com/ExtraCrafTX/GeneratorFabricMod/releases|here]] and extract them.
+Unfortunately, we can't publish the Minecraft source because it violates the Minecraft EULA.
-  - Make a new directory, then run a command shell there and type ''path/to/GeneratorFabricMod/bin/GeneratorFabricMod''.
+You need to generate the Minecraft yourself.
-  - After letting it get its dependencies, follow the instructions and input required information.
-  - You're now done, just open the project folder with in your IDE.
+To generate the Minecraft source. run the ''genSources'' gradle task.
+If your IDE doesn't have gradle integration, run the following command in the terminal: ''gradlew genSources'' (or ''./gradlew genSources'' on Linux/MacOS).
+It can take a while depends on your computer power.
+You may need to refresh gradle after running the task.
@@ Line 42: / Line 73: @@
 ===== Advice =====
-  * While Fabric API is not strictly necessary for developing mods, its primary goal is to provide cross-compatibility and hooks where the game engine does not, and as such it is highly recommended!
+  * While Fabric API is not strictly necessary for developing mods, its primary goal is to provide cross-compatibility and hooks where the game engine does not, and as such it is highly recommended! Even some of the tutorials on the wiki implicitly require Fabric API.
-  * As Fabric is in early development, occasionally, with development of fabric-loom (our Gradle build plugin) issues may crop up which require a manual clearing (deleting) of the cache (which can be found in ''.gradle/caches/fabric-loom''). Those will generally be announced as they are identified.
+  * Occasionally, with development of fabric-loom (our Gradle build plugin) issues may crop up which require resetting the cache files. This can be done by running ''gradlew cleanloom''. Running ''gradlew %%--%%stop'' can also help with a few rare issues.
   * Don't hesitate to ask questions! We're here to help you and work with you to make your dream mod a reality.
@@ Line 49: / Line 80: @@
 ==== Missing sounds ====
 Sometimes, when importing the Gradle project into an IDE, the assets might not download correctly. In this case, run the ''downloadAssets'' task manually - either using IDE's built-in menu or by simply running ''gradlew downloadAssets''.