https://github.com/enderpalm/pipette
PET Project Gradle Plugin for versioning @FabricMC and other dependencies depended by Minecraft mods
https://github.com/enderpalm/pipette
fabric gradle gradle-plugin groovy minecraft pet-project
Last synced: about 1 year ago
JSON representation
PET Project Gradle Plugin for versioning @FabricMC and other dependencies depended by Minecraft mods
- Host: GitHub
- URL: https://github.com/enderpalm/pipette
- Owner: enderpalm
- License: mit
- Created: 2023-03-01T15:39:56.000Z (about 3 years ago)
- Default Branch: master
- Last Pushed: 2023-03-10T06:33:27.000Z (about 3 years ago)
- Last Synced: 2025-01-08T19:34:30.860Z (about 1 year ago)
- Topics: fabric, gradle, gradle-plugin, groovy, minecraft, pet-project
- Language: Groovy
- Homepage:
- Size: 191 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Pipette
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](https://fabricmc.net/develop/) 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](https://api.modrinth.com/v2/project/P7dR8mSH/version) while other Fabric stuffs are retrieved from [FabricMC web service](https://meta.fabricmc.net), making some Minecraft version unavailable :(
## Usage Guide
### Integration
To use this plugin, you have to include it in your `build.gradle` file.
```gradle
// -- 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:
```gradle
// -- 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")
}
}
}
}
```
- Useful links on [GitHub Token](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token#creating-a-personal-access-token-classic) and [Consuming Maven package from GitHub package registry](https://docs.github.com/en/packages/working-with-a-github-packages-registry/working-with-the-gradle-registry#using-a-published-package)
### Task Command
Pipette `migrateMinecraft` task accepts `--ver` as arg to set target Minecraft version, like this:
```cmd
./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