Setup

The cleanest way to depend on MythicRod is through JitPack, which builds the mythicrod-api artifact straight from the public GitHub tag. No file copies, no jar wrangling.

Gradle (Kotlin DSL) - JitPack

repositories {
    mavenCentral()
    maven("https://repo.papermc.io/repository/maven-public/")
    maven("https://jitpack.io")
}

dependencies {
    compileOnly("io.papermc.paper:paper-api:26.1.2.build.64-stable")
    // JitPack treats the api module as the project artifact, so pin
    // the repo not a submodule. Available from v2026.1.1 onwards.
    compileOnly("com.github.xcutiboo:MythicRod:v2026.1.1")
}

The first resolution for a new MythicRod tag triggers a one-time JitPack build (1-5 minutes). Subsequent consumers get the cached artifact. For development you can also pin com.github.xcutiboo:MythicRod:master-SNAPSHOT.

Gradle (Kotlin DSL) - jar drop

If you cannot reach JitPack from your build host, drop the released MythicRod jar into your project's libs/ folder and keep it compileOnly. Never shade or relocate it.

dependencies {
    compileOnly("io.papermc.paper:paper-api:26.1.2.build.64-stable")
    compileOnly(files("libs/MythicRod-Paper-2026.1.0.jar"))
}

Gradle (Groovy)

dependencies {
    compileOnly 'io.papermc.paper:paper-api:26.1.2.build.64-stable'
    compileOnly files('libs/MythicRod-Paper-2026.1.0.jar')
}

Maven

<dependency>
  <groupId>io.papermc.paper</groupId>
  <artifactId>paper-api</artifactId>
  <version>26.1.2.build.64-stable</version>
  <scope>provided</scope>
</dependency>
<dependency>
  <groupId>io.xcutiboo</groupId>
  <artifactId>mythicrod-paper</artifactId>
  <version>2026.1.0</version>
  <scope>system</scope>
  <systemPath>${project.basedir}/libs/MythicRod-Paper-2026.1.0.jar</systemPath>
</dependency>

paper-plugin.yml dependency

Declare MythicRod as an after-load optional dependency so the API service is registered before your plugin reaches for it:

name: YourPlugin
main: example.YourPlugin
api-version: '1.21'
dependencies:
  server:
    MythicRod:
      load: AFTER
      required: false

If MythicRod is an optional dependency, return early when the service lookup is null. A server admin may have removed MythicRod between restarts even when the declared load order says otherwise.

Plugin version compatibility

Plugin version	Paper API	Java	Folia
2026.1.x	26.1.x (1.21.11)	25	supported

Patch releases never break the API. Minor releases add methods with default implementations only. Year roll-overs may rename or remove API only when the changelog calls it out explicitly.

← Developer API