$mod_description
- Download and install MultiMC if you haven't already.
- If you haven't already, press "create instance", and press "import from zip", and paste the following URL into the text field: https://cdn.discordapp.com/attachments/666758878813487136/699323306637262928/fabric-alpha.zip
- Download $mod_name from the releases page.
- Click on your new MultiMC instance and click "edit instance" on the right. Click "loader mods" then "add", and navigate to the mod you just downloaded, and press OK.
- Clone the repository
git clone $repo_url cd $mod_name
- Generate the Minecraft source code
./gradlew genSources
- Note: on Windows, use
gradlew
rather than./gradlew
.
- Note: on Windows, use
- Import the project into your preferred IDE.
- If you use IntelliJ (the preferred option), you can simply import the project as a Gradle project.
- If you use Eclipse, you need to
./gradlew eclipse
before importing the project as an Eclipse project.
- Edit the code
- After testing in the IDE, build a JAR to test whether it works outside the IDE too
The mod JAR may be found in the./gradlew build
build/libs
directory - 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