Fabric Mod Template

[One-line description of your mod]

[Longer description of what your mod does and why it's useful]

Features

• Feature 1: Description of feature
• Feature 2: Description of feature
• Feature 3: Description of feature

Installation

Requirements

• Minecraft: 1.21.9
• Fabric Loader: 0.17.3 or higher
• Fabric API: 0.134.0+1.21.9 or higher
• Java: 21 or higher

Optional Dependencies

• Mod Menu: For in-game config screen
• Cloth Config: For config UI (auto-installed)

Steps

1. Install Fabric Loader for Minecraft 1.21.9
2. Download Fabric API
3. Download this mod from Releases
4. Place all JARs in .minecraft/mods/
5. Launch Minecraft with the Fabric profile

Configuration

In-Game (Mod Menu)

Press Escape → Mods → find "YOUR_MOD_NAME" → Config button

File-Based (config/YOUR_MOD_ID.json)

{
  "setting1": true,
  "setting2": 100
}

Default Keybinds

Key	Action
[Key]	[Action description]

Rebind in Options → Controls → YOUR_MOD_NAME

Multiplayer & Server Compatibility

Fully client-side — Works on:

• Vanilla servers
• Modded servers (without this mod installed)
• Singleplayer

No server-side installation or permissions required.

Development

Building from Source

git clone https://github.com/YOUR_ORG/YOUR_REPO.git
cd YOUR_REPO
./gradlew build
# Output: build/libs/YOUR_MOD-<version>.jar

Branching Strategy

• main: Stable releases only
• dev: Active development branch
• Open PRs from feature branches to dev
• Merge dev → main for releases

Versioning & Releases

We use Axion Release to read version from Git tags and follow semantic versioning with Conventional Commits.

Creating a release:

# 1. Merge dev to main
git checkout main
git merge dev
git push origin main

# 2. Create signed version tag
git tag -s -a v0.2.0 -m "Release 0.2.0"  # Minor version
git tag -s -a v0.1.1 -m "Release 0.1.1"  # Patch version
git tag -s -a v1.0.0 -m "Release 1.0.0"  # Major version

# 3. Push the signed tag to trigger release workflow
git push origin v0.2.0

Commit Convention

Follow Conventional Commits:

feat: add new feature
fix: resolve bug
chore: update dependencies
docs: improve documentation

Roadmap / Future Features

• Feature idea 1
• Feature idea 2
• Feature idea 3

Contributing

Contributions welcome! Please:

1. Fork and create a feature branch from dev
2. Follow Conventional Commits
3. Add/update tests as needed
4. Open PR to dev (not main)

License

GNU GPLv3 — Free to use, modify, and distribute.

Credits

• Organization: YOUR_ORG • GitHub
• Author: YOUR_NAME
• Built with Fabric, Cloth Config, and Mod Menu