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 [2020/02/21 11:15] – typo mkpoli | tutorial:setup [2021/06/08 17:51] – Add more Eclipse setup steps player | ||
---|---|---|---|
Line 3: | Line 3: | ||
===== Prerequisites ===== | ===== Prerequisites ===== | ||
- | * A Java Development Kit (JDK) for Java 8 or newer [[https:// | + | * A Java Development Kit (JDK) for Java 16 (recommended) |
- | * Any IDE, for example [[https:// | + | * If you are professional, |
+ | * Any Java IDE, for example [[https:// | ||
- | ===== General 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. | ||
+ | |||
+ | ==== Manual Steps ==== | ||
- Copy the starting files from [[https:// | - Copy the starting files from [[https:// | ||
- Edit '' | - Edit '' | ||
Line 16: | Line 20: | ||
You can generate the Minecraft sources for reference (since IDEA already has a decompiler this is only useful for searching through the code) : | 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 '' | + | 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: | ||
- | - Run '' | + | - In the IDEA main menu, select |
- | - In order to run/debug your project, go to menu '' | + | - Select the project's build.gradle file to import the project. |
- | - Happy Modding! | + | - After Gradle is done setting up, close (File -> Close Project) |
+ | - (If the run configurations still don't show up, try reimporting the Gradle project from the Gradle tab in IDEA.) | ||
- | ==== Eclipse ==== | + | //Optional, but recommended//: |
- | If you are using Eclipse and you would like to have the IDE run configs you can run '' | + | By default, IntelliJ delegates |
+ | - Open the ' | ||
+ | - Change the 'Build and run using' and 'Run tests using' fields to ' | ||
+ | - Go to File -> Project Structure -> Project and set ' | ||
- | ==== Visual Studio Code ==== | + | Unfortunately, |
+ | |||
+ | **NOTE:** Don't run '' | ||
+ | |||
+ | === 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: | 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 ===== | ===== Getting started ===== | ||
Try [[tutorial: | Try [[tutorial: | ||
- | ===== Advice ===== | ||
- | | + | ===== Advice ===== |
- | * 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. | ||
tutorial/setup.txt · Last modified: 2024/09/23 05:31 by solidblock