Skip to content

PET Project Gradle Plugin for versioning @FabricMC and other dependencies depended by Minecraft mods

License

Notifications You must be signed in to change notification settings

enderpalm/Pipette

Repository files navigation

Pipette

CI

Simple Gradle plugin providing Fabric dependency versions (other dependencies planned) and updates Minecraft mapping accordingly, cuz I'm lazy to copy them from Fabric's web and some API versions they provided aren't compatible with their own mod set :(

Note : Fabric API and Minecraft versions are retrieved from Modrinth API while other Fabric stuffs are retrieved from FabricMC web service, making some Minecraft version unavailable :(

Usage Guide

Integration

To use this plugin, you have to include it in your build.gradle file.

// -- build.gradle -- //
plugins{
  id "dev.enderpalm.pipette" version "1.+"
}

Retriving from GitHub Packages
Pipette has to be retrieved from GitHub Package repository which requires your own GitHub token with read-access and use it as shown below:

// -- settings.gradle -- //
pluginManagement {
    repositories {
        maven{
            name = 'GitHubPackages'
            url = uri("https://maven.pkg.github.com/enderpalm/Pipette")
            credentials {
                username = System.getenv("GITHUB_ACTOR")
                password = System.getenv("GITHUB_TOKEN")
            }
        }
    }
}

Task Command

Pipette migrateMinecraft task accepts --ver as arg to set target Minecraft version, like this:

./gradlew migrateMinecraft --ver "1.19.2"

--ver argument has various types of received key, as in below table:

Arguments Results
Game versions Update required mapping and dependencies
list List all available Minecraft versions
latest Use latest stable version
latest-dev Use latest in-dev version (snapshots / rc / pre)

After running this command, your fabric.mod.json, *.mixins.json, gradle.properties should have theirs token changed according with prompted --ver. Gradle will rebuild your project and downloading dependencies and mapping automatically. PS: I only tested it in IntelliJ Idea, VScode and Eclipse aren't yet tested.

Warning Due to error of Fabric loader unknown to me, you need to delete fabric-api key in depends block in fabric.mod.json, or loader will split out Incompatible mod set error.

Made with 🤍 using MIT License

About

PET Project Gradle Plugin for versioning @FabricMC and other dependencies depended by Minecraft mods

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published