ModernJobs API

Developer API for the ModernJobs Spigot/Paper plugin.
Use this to interact with jobs, player data, leaderboards, and GUIs from your own plugin.

---

Adding the dependency

The API is hosted via JitPack. You do not need the plugin JAR on your classpath — just add the JitPack repository and the dependency below.

Maven

<repositories>
    <repository>
        <id>jitpack.io</id>
        <url>https://jitpack.io</url>
    </repository>
</repositories>

<dependencies>
    <dependency>
        <groupId>com.github.el211</groupId>
        <artifactId>ModerJobs-API</artifactId>
        <version>1.0.0</version>
        <scope>provided</scope>
    </dependency>
</dependencies>

Gradle

repositories {
    maven { url 'https://jitpack.io' }
}

dependencies {
    compileOnly 'com.github.el211:ModerJobs-API:1.0.0'
}

Replace 1.0.0 with the latest release tag, or use main-SNAPSHOT to track the latest commit.

---

Requirements

• Java 17+
• Paper / Spigot 1.21+
• ModernJobs installed on the server (softdepend or depend on it in your plugin.yml)

---

plugin.yml

Make sure ModernJobs loads before your plugin:

softdepend:
  - ModernJobs

---

Getting the API instance

Always retrieve the API through OJobsProvider — never instantiate it yourself.

import fr.oreo.modernjobs.api.OJobsApi;
import fr.oreo.modernjobs.api.OJobsProvider;

// Returns Optional.empty() if ModernJobs is not loaded
Optional<OJobsApi> api = OJobsProvider.get();

// Or throw if not available
OJobsApi api = OJobsProvider.getOrThrow();

---

Examples

Check if a player has a job

OJobsApi api = OJobsProvider.getOrThrow();

if (api.hasJob(player, "miner")) {
    player.sendMessage("You are a Miner!");
}

Join / leave a job

boolean joined = api.joinJob(player, "farmer");
boolean left   = api.leaveJob(player, "farmer");

Give XP

api.giveXp(player, "miner", 50.0);

Set a player's level

api.setLevel(player.getUniqueId(), "miner", 10);

Read player job data

api.getPlayerJobData(player.getUniqueId(), "miner").ifPresent(data -> {
    int level    = data.getLevel();
    double xp    = data.getXp();
    int prestige = data.getPrestige();
});

Prestige

if (api.canPrestige(player, "miner")) {
    api.prestige(player, "miner");
}

Leaderboard

// Per-job leaderboard
List<LeaderboardEntry> top = api.getLeaderboard("miner");

// Global leaderboard (sum of all job levels)
List<LeaderboardEntry> global = api.getGlobalLeaderboard();

Open GUIs

api.openMainMenu(player);
api.openJobMenu(player, "miner");
api.openLeaderboard(player);

---

Full API reference

See OJobsApi.java for the complete list of available methods.