README.md

README

PermissionsEx

PermissionsEx (PEX (not the pipe)) is a full-service permissions plugin giving in-depth control of permissions for a server. PEX is available for various server and proxy platforms:

• Bukkit/Spigot/Paper -- source
• Sponge -- source (API 8) / source (API 7)
• BungeeCord/Waterfall -- source
• Velocity -- source
• Fabric -- source

💬 Having an issue setting up PEX? Check out our Discord

🐞 Found a bug? File a bug report

⛏ Development Builds

Development

Want to access permissions in your plugin? PermissionsEx tries to provide extensive compatibility with native APIs, but sometimes more direct access is needed. In that case, PEX has an extensive API that allows querying any sort of information.

PEX can also be extended to support new platforms or implement new data store formats using just the implementation-agnostic core API.

On Maven

PEX is available in a format that can be retrieved in Maven. Its repository:

<repository>
    <id>pex-repo</id>
    <url>https://repo.glaremasters.me/repository/permissionsex/</url>
</repository>

and its dependency specification is:

<dependency>
    <groupId>ca.stellardrift.permissionsex</groupId>
    <artifactId>permissionsex-core</artifactId> <!-- replace with -sponge or -bukkit depending on which platform you're using -->
    <version>2.0-SNAPSHOT</version>
</dependency>

On Gradle

We work in the Kotlin DSL, but Groovy should be similar.

repositories {
    maven(url = "https://repo.glaremasters.me/repository/permissionsex/") {
        name = "pex-repo"
    }
}

dependencies {
    implementation("ca.stellardrift.permissionsex:permissionsex-core:2.0-SNAPSHOT")
}

Contributing

PermissionsEx always appreciates well thought-out pull requests for code changes, documentation improvements, and translations. All contributions except those to the Bukkit implementation of PEX must be released under the terms of the Apache 2.0 license. All contributions to PermissionsEx for Bukkit/Spigot/Paper must be provided under the terms of the GNU General Public License, version 3 or later.

We build with Gradle -- a wrapper is provided, to build the project simply run ./gradlew build. Feel free to run ideas by me in the discord before spending time implementing something that doesn't match my vision for the plugin.