RankForge API Dependency Setup – Maven, Gradle & plugin.yml

To integrate with the API, your plugin compiles against the RankForge JAR without bundling it (provided / compileOnly scope), and declares the dependency in plugin.yml.

Artifact Distribution

RankForge is Closed Source. Official binary JARs are distributed exclusively on Modrinth. Download the JAR and configure it as a local library dependency.

1. Obtain the Plugin Artifact

Download from Modrinth

1. Download RankForge-1.0.0.jar from the Modrinth Release Page.
2. Save the JAR into your plugin project’s libs/ directory.

Install to Local Maven Cache

Install the downloaded JAR into your local .m2 repository:

mvn install:install-file \
  -Dfile=RankForge-1.0.0.jar \
  -DgroupId=xyz.noxlydev \
  -DartifactId=RankForge \
  -Dversion=1.0.0 \
  -Dpackaging=jar

2. Declare the Build Dependency

Maven (Local Jar)

<dependency>
    <groupId>xyz.noxlydev</groupId>
    <artifactId>RankForge</artifactId>
    <version>1.0.0</version>
    <scope>system</scope>
    <systemPath>${project.basedir}/libs/RankForge-1.0.0.jar</systemPath>
</dependency>

Gradle (Kotlin DSL)

dependencies {
    compileOnly(files("libs/RankForge-1.0.0.jar"))
}

Gradle (Groovy DSL)

dependencies {
    compileOnly files('libs/RankForge-1.0.0.jar')
}

3. Configure plugin.yml

# Hard dependency (plugin requires RankForge to boot)
depend:
  - RankForge

# OR Soft dependency (optional feature integration)
softdepend:
  - RankForge

4. Verify API Availability at Runtime

import xyz.noxlydev.rankforge.api.RankForgeAPI;

if (RankForgeAPI.isAvailable()) {
    int points = RankForgeAPI.get().getPoints(player);
}