Skip to content

Latest commit

 

History

History
45 lines (26 loc) · 5.42 KB

README.md

File metadata and controls

45 lines (26 loc) · 5.42 KB
Raw

Fabric Mod Template

Mod Loader Enviroment

A Kotlin Fabric Template based on Stonecutter for multi-version support.

Usage

For starters, Use this template.

Warning

Do not Fork, Clone, or Download ZIP this template. Using this template will automatically generate a custom mod id. On Linux, you can manually configure this using the make-my-own script. If you're on another OS, simply click the "Use this template" button.

This template uses Stonecutter for multi-version support and DevAuth for logging in with your Minecraft account (if desired, you can opt out of using DevAuth by removing it from build.gradle.kts).

To run the mod, you will need Java 21, which you can download from Adoptium, the white page of doom Oracle, or any other preferred source.

When importing the project into IntelliJ, remember to set both Gradle JVM and Project SDK to use Java 21 JDK, then click on the sync button, it should create run tasks based on the versions you selected with Stonecutter. If it doesn't then try restarting IntelliJ.
You will get preconfigured launch configs based on the selected versions you set with Stonecutter's Settings.

I highly suggest you head over to Stonecutter's setup page to understand it better, or at the very least the launch page to better know how to manage your mod versions, run minecraft, and export the mod, alternativly you can read this quick guide (provided you use IntelliJ IDEA):

You should have a Gradle menu on the right sidebar, in there you will see two groups: stonecutter and project.

Under the stonecutter group you will see multiple tasks:

  • "Refresh active version" - Re-runs the comment processor on the current version.
  • "Reset active version" - Switches the active version to vcsVersion from settings.gradle.kts. Run this before making commits.
  • "Set active version to <X.XX.X>" - Changes the active version to the selected one.

In the project group you will see chiseledBuild, which is the task you will use to export your mod versions as JAR files.

Unfortunately, you can't fully opt out of mixins (which allow you to modify vanilla code), but you can choose to not use them, simply remove the mixins group in fabric.mod.json, the modid.mixins.json file (both can be found in src/main/resources), and the mixins package in src/main/java/me/yourname.

License

This template is licensed under the Unlicense or alternativly, Creative Commons 1.0 Universal (CC0 1.0). All contributions and pull requests to this template should follow these licenses.

You can license your mod (based on this template) however you like, and you don't need to reference back to this template in any way.