Skip to content

An intelligent Gradle plugin used to develop mods for fabric.

License

Notifications You must be signed in to change notification settings

tayadev/Fabrigradle

Repository files navigation

Fabrigradle

An intelligent Gradle plugin used to develop mods for fabric.

License: GPL v3 Gradle Plugin Ko-Fi

Purpose

This project provides a centralized configuration with helpful defaults to help you get your fabric mod projects started faster and to keep them more maintainable and reduce mistakes over their development lifecycle.

Main features

  • Description file generation: fabric.mod.json and mixins.json
  • Debug tasks
  • Shortcuts for repositories and dependencies

Getting started creating mods with Fabrigradle

Create a file named build.gradle with the following content

plugins {
  id 'one.taya.fabrigadle' version '3.0.0'
}

group 'one.taya' // This should a domain you own in reverse, or something reasonably unique
version '0.0.1-SNAPSHOT' // Your project version

// Configuration for Fabrigradle
fabrigradle {

  versions { // look up newest versions on https://fabricmc.net/develop
    minecraft '1.19.2'
    mappings '1.19.2+build.1'
    loader '0.14.9'
    fabricApi '0.58.6+1.19.2'
  }

  entrypoints {
    main 'one.taya.example.ExampleMod' // The main class of your mod
  }
}

This is the minimal setup to get your mod to build and run, for adding further configuration refer to the following sections explaining the different configuration options.

Configuration Options

Versions

  • TODO: Document

Id

  • Has to be all lowercase with only alphanumeric characters
  • Defaults to your projects name
fabrigradle {
  id 'mod-id'
}

Version

  • Should follow SemVer2.0.0 spec
  • Defaults to your projects version
fabrigradle {
  version '1.2.3'
}

Environment

  • The Environment your mod is made for: server or client
  • Defaults to both if omitted
fabrigradle {
  environment 'client'
}

Entrypoints

  • TODO: Document

Jars

  • TODO: Document

LanguageAdapters

  • TODO: Document

Mixins

  • TODO: Document

Accesswidener

  • TODO: Document

Depends

  • TODO: Document

Recommends

  • TODO: Document

Suggests

  • TODO: Document

Conflicts

  • TODO: Document

Breaks

  • TODO: Document

Name

  • TODO: Document

Description

  • TODO: Document

Authors

  • TODO: Document

Contributors

  • TODO: Document

Contact

  • TODO: Document

License

  • TODO: Document

Icon

  • TODO: Document

Eula

  • TODO: Document

About

An intelligent Gradle plugin used to develop mods for fabric.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published