Template readme for alpha fabric mods

README.md

$mod_name

$mod_description

Installation

1. Download and install MultiMC if you haven't already.
2. 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
3. Download $mod_name from the releases page.
4. 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.

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