https://github.com/syorito-hatsuki/ducky-updater-lib

Simple library for checking mod updates from modrinth
https://github.com/syorito-hatsuki/ducky-updater-lib

fabric-mod fabricmc fabricmc-mod library modrinth modrinth-api updater

Last synced: about 2 months ago
JSON representation

Simple library for checking mod updates from modrinth

• Host: GitHub
• URL: https://github.com/syorito-hatsuki/ducky-updater-lib
• Owner: syorito-hatsuki
• License: mit
• Created: 2023-02-07T14:24:53.000Z (almost 2 years ago)
• Default Branch: 1.20
• Last Pushed: 2024-10-30T14:28:15.000Z (3 months ago)
• Last Synced: 2024-10-30T15:31:13.687Z (3 months ago)
• Topics: fabric-mod, fabricmc, fabricmc-mod, library, modrinth, modrinth-api, updater
• Language: Java
• Homepage: https://modrinth.com/mod/ducky-updater-lib
• Size: 120 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Ducky Updater Lib



## Description

Simple library for checking mod updates from Modrinth

## Adding the dependency

> build.gradle.kts

```gradle

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", ""))

    

    // Option 2: Depend on Ducky Updater, but require that users install it manually

    modImplementation("maven.modrinth", "ducky-updater-lib", "")

}

```

> fabric.mod.json

```json5

{

  "depends": {

    "fabricloader": "*",

    ...

    // Also add dependency in your fabric.mod.json 

    "ducky-updater": "*"

  }

}

```

## Usage

> fabric.mod.json

```json5

{

  "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

    }

  },

}

```

    Before 2023.7.1

```java

public class ModName implements ModInitializer {

    @Override

    public void onInitialize() {

        DuckyUpdater.checkForUpdate(

                "modrinthId",

                "modId",

                "alpha",        // Optional! Default release 

                true            // Optional! Default true

        );

    }

}

```