Overview

PermissionsExPlus exposes APIs for companion plugins that need to read or modify permissions at runtime.

Quick start

  1. Add Maven dependency (provided scope — do not shade PEX into your jar)
  2. Check PermissionsEx.isAvailable() in onEnable
  3. Use PermissionsEx.getApi() for new code
<dependency>
  <groupId>dev.rono.permissions</groupId>
  <artifactId>permissionsex-api</artifactId>
  <version>1.23.5</version>
  <scope>provided</scope>
</dependency>

Documentation layers

Layer What it covers
API Cookbook Practical recipes — check perms, add groups, events
Javadoc Full class and method reference for every version
Sample plugins Working example jars in the repo

The website is intentionally thin — detailed API signatures live in Javadoc. The cookbook shows you how to do common tasks with links to the relevant classes.

Two APIs

API Package When
Modern dev.rono.permissions.api.* New plugins
Legacy ru.tehkode.permissions.* Existing PEX 1.23.x plugins

Both talk to the same runtime manager on game servers.

Legacy dependencies

For classic PermissionsEx.getUser() static calls, also add:

<dependency>
  <groupId>dev.rono.permissions</groupId>
  <artifactId>permissionsex-legacy-stub</artifactId>
  <version>1.23.5</version>
  <scope>provided</scope>
</dependency>

Next steps