Ducky Updater Lib

Ducky Updater Lib

Description

Simple library for checking mod updates from Modrinth

Adding the dependency

> build.gradle.kts

repositories {
    maven {
        url = "https://api.modrinth.com/maven"
    }
}

dependencies {
    // Option 1: Include Ducky Updater to project for it available within your own jar (additional ~17kb)
    include(modImplementation("maven.modrinth", "ducky-updater-lib", "<version>"))
    
    // Option 2: Depend on Ducky Updater, but require that users install it manually
    modImplementation("maven.modrinth", "ducky-updater-lib", "<version>")
}

> fabric.mod.json

{
  "depends": {
    "fabricloader": "*",
    ...
    // Also add dependency in your fabric.mod.json 
    "ducky-updater": "*"
  }
}

Usage

> fabric.mod.json

{
  "custom": {
    ...
    "duckyupdater": {
      //Mod modrinth ID from project page
      "modrinthId": "mWxGwd3F",
      // Optional (release, beta, alpha)
      // Default: release
      "type": "release",
      // Optional (true, false)
      // Default false
      "featured": false
    }
  },
}

public class ModName implements ModInitializer {
    @Override
    public void onInitialize() {
        DuckyUpdater.checkForUpdate(
                "modrinthId",
                "modId",
                "alpha",        // Optional! Default release 
                true            // Optional! Default true
        );
    }
}