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/07/27 09:07] – added link to Kotlin example mod fudge | tutorial:setup [2020/03/29 15:44] – [Manual Steps] form -> from jamieswhiteshirt | ||
---|---|---|---|
Line 3: | Line 3: | ||
===== Prerequisites ===== | ===== Prerequisites ===== | ||
- | * A Java Development Kit (JDK) for Java 8 or newer [[https:// | + | * A Java Development Kit (JDK) for Java 8 (recommended) |
- | * 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. | ||
+ | ==== Manual Steps ==== | ||
- Copy the starting files from [[https:// | - Copy the starting files from [[https:// | ||
- Edit '' | - Edit '' | ||
Line 13: | Line 15: | ||
* 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: | ||
+ | - Run '' | ||
+ | - In order to run/debug your project, go to menu '' | ||
+ | === 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: | ||
+ | |||
+ | ==== Generator ==== | ||
+ | You may also use [[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. | ||
+ | |||
+ | ==== MinecraftDev IntelliJ IDEA Plugin ==== | ||
+ | If you are using IntelliJ IDEA you can use Earthcomputer' | ||
+ | You can follow [[https:// | ||
+ | |||
+ | ===== 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 56: | ||
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/04/15 00:35 by solidblock