User Tools

Site Tools


tutorial:setup

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision
Previous revision
Next revisionBoth sides next revision
tutorial:setup [2020/07/27 23:18] – [MinecraftDev IntelliJ IDEA Plugin] Better commas comp500tutorial:setup [2020/09/18 08:48] – Update Fabric API advice siglong
Line 35: Line 35:
  
 Unfortunately, it is currently impossible to set an IDE-wide default for the 'Build and run using' and 'Run tests using' options, so these steps have to be repeated for every new project. Unfortunately, it is currently impossible to set an IDE-wide default for the 'Build and run using' and 'Run tests using' options, so these steps have to be repeated for every new project.
 +
 +**NOTE:** Don't run ''./gradlew idea'' as it messes up with gradle and breaks develop environment.
  
 === Eclipse === === Eclipse ===
Line 41: Line 43:
 === Visual Studio Code === === Visual Studio Code ===
 If you are using VSCode by Microsoft, please follow [[tutorial:vscode_setup|these instructions]] If you are using VSCode by Microsoft, please follow [[tutorial:vscode_setup|these instructions]]
 +
 +==== 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, generating accessors/shadow fields, and copying Mixin Target References (JVM Descriptors).
 +The plugin can be found [[https://plugins.jetbrains.com/plugin/8327|in the IntelliJ plugin repository]], so you can install it using IntelliJ's internal plugin browser by navigating to File → Settings → Plugins, then clicking the Marketplace tab and searching for Minecraft.
  
 ==== Generator ==== ==== Generator ====
-You may also use [[https://github.com/ExtraCrafTX/GeneratorFabricMod|GeneratorFabricMod]] by ExtraCrafTX, a convenient tool to automatically generate new fabric mods from template. Follow these steps:+If you are unable to use the MinecraftDev plugin or the [[https://github.com/FabricMC/fabric-example-mod/|fabric-example-mod]] repo, you may also use [[https://github.com/ExtraCrafTX/GeneratorFabricMod|GeneratorFabricMod]] by ExtraCrafTX, a convenient tool to automatically generate new fabric mods from template. Follow these steps:
   - Download latest release of GeneratorFabricMod [[https://github.com/ExtraCrafTX/GeneratorFabricMod/releases|here]] and extract them.   - Download latest release of GeneratorFabricMod [[https://github.com/ExtraCrafTX/GeneratorFabricMod/releases|here]] and extract them.
   - Make a new directory, then run a command shell there and type ''path/to/GeneratorFabricMod/bin/GeneratorFabricMod''.   - Make a new directory, then run a command shell there and type ''path/to/GeneratorFabricMod/bin/GeneratorFabricMod''.
   - After letting it get its dependencies, follow the instructions and input required information.   - After letting it get its dependencies, follow the instructions and input required information.
   - 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.
- 
-==== 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, generating accessors/shadow fields, and the Copy Mixin Target Reference context menu option. 
-The plugin can be found [[https://plugins.jetbrains.com/plugin/8327|in the IntelliJ plugin repository]], so you can install it using IntelliJ's internal plugin browser by navigating to File → Settings → Plugins, then clicking the Marketplace tab and searching for Minecraft. 
- 
 ===== Getting started ===== ===== Getting started =====
 Try [[tutorial:items|adding an item]] or [[tutorial:blocks|a block]]. It's also a good idea to visit [[tutorial:applychanges|Applying changes without restarting Minecraft]]. Try [[tutorial:items|adding an item]] or [[tutorial:blocks|a block]]. It's also a good idea to visit [[tutorial:applychanges|Applying changes without restarting Minecraft]].
  
 ===== 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! Even some of the tutorials on the wiki implicitly require Fabric API.
   * Occasionally, with development of fabric-loom (our Gradle build plugin) issues may crop up which require resetting the cache files. This can be done by running ''gradlew cleanloom''. Running ''gradlew %%--%%stop'' can also help with a few rare issues.   * Occasionally, with development of fabric-loom (our Gradle build plugin) issues may crop up which require resetting the cache files. This can be done by running ''gradlew cleanloom''. Running ''gradlew %%--%%stop'' can also help with a few rare issues.
   * 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: 2023/09/09 18:03 by andrew6rant