tutorial:setup
Differences
This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revisionNext revision | Previous revisionLast revisionBoth sides next revision | ||
tutorial:setup [2021/08/05 06:01] – Add Generating Sources heading, because people keep missing it daomephsta | tutorial:setup [2023/09/09 18:03] – andrew6rant | ||
---|---|---|---|
Line 2: | Line 2: | ||
===== Prerequisites ===== | ===== Prerequisites ===== | ||
- | + | * A Java Development Kit (JDK) for Java 17 (recommended) or newer. Visit [[https://adoptium.net/releases.html]] for installers. | |
- | * A Java Development Kit (JDK) for Java 16 (recommended) or newer. Visit [[https://adoptopenjdk.net/]] for installers. | + | |
* If you are professional, | * If you are professional, | ||
* Any Java IDE, for example [[https:// | * Any Java IDE, for example [[https:// | ||
+ | * If you are not familiar with any of these, we recommend to use Intellij IDEA as that is what most people choose for modding. | ||
- | ===== Mod Startup | + | ===== Mod Setup ===== |
- | 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. | + | |
==== Manual Steps ==== | ==== Manual Steps ==== | ||
- | - Copy the starting files from [[https:// | + | - Copy the starting files from [[https:// |
- Edit '' | - Edit '' | ||
* Make sure to set '' | * Make sure to set '' | ||
- | * Make sure to update the versions of Minecraft, the mappings | + | * Make sure to update the versions of Minecraft, the mappings, the loader |
* Add any other dependencies you plan to use in '' | * Add any other dependencies you plan to use in '' | ||
- Import the build.gradle file to your IDE. You may refer to the next section for specific IDE's. | - Import the build.gradle file to your IDE. You may refer to the next section for specific IDE's. | ||
- Happy modding! | - Happy modding! | ||
- | === Generating Sources | + | === Fabric Mod ID Change |
- | You can generate the Minecraft | + | As of Minecraft |
- | Run the '' | + | |
- | | + | |
=== IntelliJ IDEA === | === IntelliJ IDEA === | ||
If you are using IntelliJ IDEA by JetBrains, please follow these steps: | If you are using IntelliJ IDEA by JetBrains, please follow these steps: | ||
Line 34: | Line 31: | ||
- Open the ' | - Open the ' | ||
- Change the 'Build and run using' and 'Run tests using' fields to ' | - Change the 'Build and run using' and 'Run tests using' fields to ' | ||
- | - Go to File -> Project Structure -> Project and set ' | ||
Unfortunately, | Unfortunately, | ||
- | **NOTE:** Don't run '' | + | **NOTE:** Don't run the '' |
+ | |||
+ | If you are using IntelliJ IDEA you can use the [[https:// | ||
+ | This plugin adds support for automatically generating Fabric projects | ||
+ | generating accessors/ | ||
+ | You can install | ||
+ | then clicking the Marketplace tab and searching for Minecraft. | ||
+ | |||
+ | **NOTE:** The default template in the mcdev plugin blindly uses the latest unstable version of the loom. Use with caution. | ||
=== Eclipse === | === Eclipse === | ||
Line 44: | Line 48: | ||
=== Visual Studio Code === | === Visual Studio Code === | ||
- | If you are using VSCode | + | If you are using VSCode, please follow [[tutorial:setup: |
- | ==== MinecraftDev IntelliJ IDEA Plugin | + | ===== Generating Minecraft Sources ===== |
- | If you are using IntelliJ IDEA you can use the MinecraftDev plugin. This plugin adds support for automatically generating Fabric projects as well as some mixin related features like inspections, generating accessors/ | + | Reading the Minecraft source is an essential part of modding. |
- | The plugin | + | Unfortunately, |
+ | You need to generate the Minecraft source yourself. | ||
+ | |||
+ | To generate the Minecraft source. run the '' | ||
+ | If your IDE doesn' | ||
+ | It can take a while depending on your computer power. | ||
+ | You may need to refresh gradle after running the task. | ||
+ | |||
+ | See [[tutorial:reading_mc_code|Reading | ||
- | ==== Generator ==== | ||
- | If you are unable to use the MinecraftDev plugin or the [[https:// | ||
- | - Download latest release of GeneratorFabricMod [[https:// | ||
- | - Make a new directory, then run a command shell there and type '' | ||
- | - After letting it get its dependencies, | ||
- | - You're now done, just open the project folder with in your IDE. | ||
===== Getting started ===== | ===== Getting started ===== | ||
Try [[tutorial: | Try [[tutorial: | ||
Line 62: | Line 68: | ||
* 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. | * 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. | ||
* Occasionally, | * Occasionally, | ||
+ | * Keep up with the latest Loom version (which is defined in '' | ||
+ | * Keep up with the latest Gradle version, which can be defined in '' | ||
+ | * Different Gradle versions require different Java versions. Usually latest Gradle supports the recommended Java version 17. | ||
+ | * If you're developing mods for old version Minecraft, besides changing '' | ||
* Don't hesitate to ask questions! We're here to help you and work with you to make your dream mod a reality. | * Don't hesitate to ask questions! We're here to help you and work with you to make your dream mod a reality. | ||
===== Troubleshooting ===== | ===== Troubleshooting ===== | ||
- | ==== Missing sounds | + | ==== "no usages" |
+ | After running the '' | ||
+ | ==== Missing sounds ==== | ||
Sometimes, when importing the Gradle project into an IDE, the assets might not download correctly. In this case, run the '' | Sometimes, when importing the Gradle project into an IDE, the assets might not download correctly. In this case, run the '' | ||
+ | ==== Could not find or load class net.fabricmc.devlaunchinjector.Main: | ||
+ | It seems to be a bug of Intellij IDEA since a recent update 2023.2. To fix, just delete the `.idea` folder entirely and then restart Intellij IDEA. The module will be reconstructed. You may need to specify Java versions again. If after restarting there is no run config, you can run `gradle ideaSyncTask` then check it again. | ||
+ | |||
+ | ==== java.lang.ClassNotFoundException: | ||
+ | This may be because the project path contains non-ASCII characters that may cause incompatibility. Try move the project to paths without non-ASCII characters, or in the run config of " | ||
+ | ===== What's Next? ===== | ||
+ | Create your first [[tutorial: |
tutorial/setup.txt · Last modified: 2024/04/15 00:35 by solidblock