RankForge Developer API – Minecraft Plugin Integration (Java/Kotlin)

The RankForge Developer API (xyz.noxlydev.rankforge.api.*) empowers third-party plugins to read and manipulate PvP ranking data: points, tiers, kill/death statistics, K/D ratios, and leaderboard standings, as well as react to state changes via custom Bukkit events.

Capabilities

Read Player Statistics

getPoints, getTier, getNextTier, getKills, getDeaths, getKD, getDailyKills, getPlayerData.

Modify Points

setPoints, addPoints, removePoints triggering cancellable Bukkit events.

Leaderboards & Tiers

getTopPlayers(limit), getRegisteredTiers(), getTierByPoints(points).

Custom Events

PlayerPointsChangeEvent, PlayerTierUpEvent, PlayerTierDownEvent.

API Components

Class / Interface	Purpose
RankForgeAPI	Static singleton gateway: isAvailable() and get()
IRankForgeAPI	Public interface exposing all API operations
Tier	Immutable tier model (id, min points, display, sound, title, rewards)
PlayerData	Thread-safe player data model
api.event.*	Custom cancellable Bukkit events

Quick Example

import xyz.noxlydev.rankforge.api.RankForgeAPI;
import xyz.noxlydev.rankforge.model.Tier;

if (RankForgeAPI.isAvailable()) {
    int points = RankForgeAPI.get().getPoints(player);
    Tier tier = RankForgeAPI.get().getTier(player);
    player.sendMessage("Points: " + points + " | Tier: " + (tier != null ? tier.display : "Unranked"));
}

Threading Rules

Methods that mutate points dispatch synchronous Bukkit events and should be called from the server thread (main thread or Folia region thread). Read Best Practices.

Navigation

1. Dependency SetupMaven, Gradle, and plugin.yml setup.

2. API ReferenceDetailed method documentation.

3. Custom EventsEvent listeners, cancellation, and flow.

4. Integration RecipesReady-to-use plugin integration examples.