$mod_name

$mod_description

Installation

1. Download and run the Fabric installer.
   • Note: this step may vary if you aren't using the vanilla launcher or an old version of Minecraft.
2. Download the Fabric API and move it to the mods folder (.minecraft/mods).
3. Download $mod_name from the releases page and move it to the mods folder (.minecraft/mods).

Contributing

1. Clone the repository

   git clone $repo_url
   cd $mod_name
   

2. Generate the Minecraft source code

   ./gradlew genSources
   

   • Note: on Windows, use gradlew rather than ./gradlew.
3. Import the project into your preferred IDE.
   1. If you use IntelliJ (the preferred option), you can simply import the project as a Gradle project.
   2. If you use Eclipse, you need to ./gradlew eclipse before importing the project as an Eclipse project.
4. Edit the code
5. After testing in the IDE, build a JAR to test whether it works outside the IDE too

   ./gradlew build
   

   The mod JAR may be found in the build/libs directory
6. Create a pull request so that your changes can be integrated into $mod_name
   • Note: for large contributions, create an issue before doing all that work, to ask whether your pull request is likely to be accepted