tutorial:setup
Differences
This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revisionNext revision | Previous revisionNext revisionBoth sides next revision | ||
tutorial:setup [2019/05/31 19:57] – draylar | tutorial:setup [2020/08/09 14:02] – [MinecraftDev IntelliJ IDEA Plugin] ytg1234 | ||
---|---|---|---|
Line 3: | Line 3: | ||
===== Prerequisites ===== | ===== Prerequisites ===== | ||
- | * JDK 8+ | + | |
- | * Any IDE, for example [[https:// | + | * Any Java IDE, for example [[https:// |
- | ===== Steps ===== | + | ===== 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. | ||
- | - Copy the starting files from [[https:// | + | ==== Manual Steps ==== |
+ | - 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 and the loader - all of which can be queried through [[https:// | * Make sure to update the versions of Minecraft, the mappings and the loader - all of which can be queried through [[https:// | ||
* Add any other dependencies you plan to use in '' | * Add any other dependencies you plan to use in '' | ||
- | - Import the project to your IDE. Follow [[tutorial: | + | - Import the build.gradle file to your IDE. You may refer to the next section for specific |
- | - Run the '' | + | |
- | - If you would like to have the IDE run configs you can run following commands: | + | |
- | * For IntelliJ IDEA: '' | + | |
- | * For Eclipse: '' | + | |
- | * If you use VS Code, configurations were generated at the step 3. | + | |
- Happy modding! | - Happy modding! | ||
- | ===== Advice ===== | + | You can generate the Minecraft sources for reference (since IDEA already has a decompiler this is only useful for searching through the code) : |
+ | Run the '' | ||
+ | |||
+ | === IntelliJ IDEA === | ||
+ | If you are using IntelliJ IDEA by JetBrains, please follow these steps: | ||
+ | - In the IDEA main menu, select ' | ||
+ | - Select 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 ' | ||
+ | - Change the 'Build and run using' and 'Run tests using' fields to ' | ||
+ | - Go to File -> Project Structure -> Project and set ' | ||
+ | |||
+ | Unfortunately, | ||
+ | |||
+ | === Eclipse === | ||
+ | If you are using Eclipse and you would like to have the IDE run configs you can run '' | ||
+ | |||
+ | === Visual Studio Code === | ||
+ | If you are using VSCode by Microsoft, please follow [[tutorial: | ||
+ | |||
+ | ==== MinecraftDev IntelliJ IDEA Plugin ==== | ||
+ | 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, | ||
+ | The plugin can be found [[https:// | ||
+ | |||
+ | ==== 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 ===== | ||
+ | Try [[tutorial: | ||
+ | |||
+ | ===== 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! | ||
- | * As Fabric is in early development, | + | * Occasionally, with development of fabric-loom (our Gradle build plugin) issues may crop up which require |
* 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. | ||
Line 32: | Line 65: | ||
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 '' | ||
+ |
tutorial/setup.txt · Last modified: 2024/08/12 04:20 by jeffreyg1228