Home

⚠️ These wiki pages are a work-in-progress, please check back later!

About

This repository is an elegant Minecraft mod template for the Fabric mod loader. It equips mod developers with the various tools and pipelines necessary for smooth development, change management and continuous deployments!

Features

Documentation

• A beautiful README.md with your mod icon and commonly used badges
• An automatically generated changelog found under CHANGELOG.md
• Contribution guidelines found under .github/CONTRIBUTING.md with an accompanied Code of Conduct found under .github/CODE_OF_CONDUCT.md
• Security Policy found under .github/SECURITY.md
• Custom issue templates using intuitive forms and example contacts
• Custom labels to help triage issues, discussions and pull requests
  • assets, build, ci, documentation and i18n

Build

• A ready-to-use Gradle build process found under build.gradle configurable by the gradle.properties
• Multi-project build support for nested mods
• Populates fabric.mod.json with the mod id, name, and version from gradle.properties
• Adds the project's LICENCE.txt to all distributions

CI/CD

• Uses GitHub Actions to trigger builds and deployments
  • Build, test and lint projects on any pull request to ensure the integrity of your codebase
  • Applies labels to pull requests that make changes to certain files

Deployment

• Publish to CurseForge
  • With additional distributions, e.g. sources jar
  • With project dependencies
• Publish to Modrinth
  • With additional distributions, e.g. sources jar
  • With project dependencies
• Publish to GitHub Packages
• Triggers googleapis/release-please on changes to release branches to automate the deployment process
  • Determines the next version ([major].[minor].[patch]) based on commit messages and updates gradle.properties
  • Generates/updates the CHANGELOG.md
  • Runs gradle publish which in turn uploads to CurseForge, Modrinth, and GitHub Packages
  • Publishes to GitHub Releases

Code Quality

• Uses Checkstyle for code linting with an extensive configuration found under .checkstyle.xml
  • Uses K&R indentation style (Kernighan & Ritchie Style) which can easily be switched to the 1TBS variant
  • Adds the following import groups: com.mojang, net.minecraft, net.fabricmc and your.package.here
• Provides a .editorconfig
• Adds JetBrains Annotations (compile only) to better describe null constraints, etc.
• Sets up JUnit for tests