Home

Developer Wiki

This wiki is here to provide an advanced guide to integrating the PlayerEx API with your mod.

A note of caution: a relatively high level of java competency is expected, so if you have come here after watching your first insert generic modding tutorial, this may not be appropriate.

Setting Up The Build

You can integrate the PlayerEx API using Gradle. In your mods build.gradle file, the following must be present:

Note that right now the latest build (1.1.5) is not yet available on jitpack (queued) - this message will be removed when it becomes available.

dependencies {
    runtimeOnly fg.deobf("com.github.CleverNucleus:PlayerEx:${version}")
    compileOnly fg.deobf("com.github.CleverNucleus:PlayerEx:${version}:api")
}

Replace ${version} with the PlayerEx version - 1.1.5 for example.

repositories {
    maven {
        url = "https://jitpack.io/"
    }
}

At the moment, the only online maven-structured repository is with jitpack, however with time alternatives may become available.

After building the project and refreshing dependencies the API will become available in the developer environment. The API contains javadocs for eclipse users.