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:38] – Rearranging and add generator mkpoli | tutorial:setup [2020/09/18 08:48] – Update Fabric API advice siglong | ||
---|---|---|---|
Line 7: | Line 7: | ||
===== Mod Startup ===== | ===== 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 ==== | ==== Manual Steps ==== | ||
- Copy the starting files from [[https:// | - Copy the starting files from [[https:// | ||
Line 17: | Line 19: | ||
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, | + | - 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 | ||
+ | - (If the run configurations still don't show up, try reimporting the Gradle | ||
+ | |||
+ | //Optional, but recommended//: | ||
+ | By default, IntelliJ delegates | ||
+ | - Open the 'Gradle Settings' | ||
+ | - Change the 'Build and run using' and ' | ||
+ | - Go to File -> Project Structure -> Project | ||
+ | |||
+ | Unfortunately, | ||
+ | |||
+ | **NOTE:** Don't run '' | ||
=== Eclipse === | === Eclipse === | ||
Line 29: | Line 43: | ||
=== Visual Studio Code === | === 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 ==== | ==== Generator ==== | ||
- | You many also use [[https:// | + | If you are unable to use the MinecraftDev plugin or the [[https:// |
- Download latest release of GeneratorFabricMod [[https:// | - Download latest release of GeneratorFabricMod [[https:// | ||
- Make a new directory, then run a command shell there and type '' | - Make a new directory, then run a command shell there and type '' | ||
- After letting it get its dependencies, | - After letting it get its dependencies, | ||
- You're now done, just open the project folder with in your IDE. | - You're now done, just open the project folder with in your IDE. | ||
- | |||
- | |||
===== Getting started ===== | ===== Getting started ===== | ||
Try [[tutorial: | Try [[tutorial: | ||
===== Advice ===== | ===== 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. | ||
tutorial/setup.txt · Last modified: 2024/04/15 00:35 by solidblock