A permissions plugin for Minecraft servers.
Go to file
2020-04-09 11:47:10 +01:00
.github Update FUNDING.yml 2020-03-01 10:23:40 +00:00
api Ignore empty string world names in Bukkit WorldCalculator (#2119) 2020-03-30 14:32:27 +01:00
bukkit Avoid calls to the Bukkit singleton 2020-04-07 17:50:08 +01:00
bukkit-legacy Change API package to net.luckperms 2019-08-26 18:06:45 +01:00
bungee Use slightly less spammy logging when user data isn't loaded in Bungee permission check handling 2020-04-05 16:25:33 +01:00
common Optimize VerboseHandler by delaying construction of stack trace array until later 2020-04-07 17:56:56 +01:00
gradle/wrapper Update Gradle to 5.0 2018-12-15 22:24:17 +00:00
nukkit Replace 'none' option with 'auto' in messaging service config description 2020-04-05 16:04:38 +01:00
sponge Build against SpongeAPI 7.2 2020-04-09 11:47:10 +01:00
velocity Replace 'none' option with 'auto' in messaging service config description 2020-04-05 16:04:38 +01:00
.gitignore Context & action log changes 2019-08-26 14:04:50 +01:00
build.gradle More work 2019-11-18 21:19:59 +00:00
CONTRIBUTING.md Fix some small typos (#1389) 2019-01-18 09:47:03 +00:00
gradlew Make gradlew script executable by default (#1338) 2018-12-19 09:24:44 +00:00
gradlew.bat Update Gradle to 5.0 2018-12-15 22:24:17 +00:00
HEADER.txt misc tidying up 2018-11-10 20:21:08 +00:00
LICENSE.txt Update MIT license text to allow GitHub detection (#1400) 2019-01-28 10:46:05 +00:00
README.md Update badges for new API coordinates (#1816) 2019-11-24 00:38:22 +00:00
settings.gradle Change API package to net.luckperms 2019-08-26 18:06:45 +01:00

alt text

LuckPerms

Build Status javadoc Maven Central Discord

LuckPerms is an advanced permissions implementation aiming to be a fast, reliable and flexible alternative to existing permission plugins. The project's main goals are centered around high performance and a wide feature set, filling the gaps of functionality and building upon existing features found in other plugins.

LuckPerms also includes an extensive API for developers, and support for a variety of Minecraft server software & data storage options.

Still not convinced? More information can be found on the wiki, under: Why LuckPerms?

The latest downloads can be found on the project's homepage.

More information about the project & how to use the plugin can be found in the wiki.

Building

LuckPerms uses Gradle to handle dependencies & building.

Requirements

  • Java 8 JDK or newer
  • Git

Compiling from source

git clone https://github.com/lucko/LuckPerms.git
cd LuckPerms/
./gradlew build

You can find the output jars in the build/libs directories.

Contributing

Pull Requests

If you make any changes or improvements to the plugin which you think would be beneficial to others, please consider making a pull request to merge your changes back into the upstream project. (especially if your changes are bug fixes!)

LuckPerms loosely follows the Google Java Style Guide. Generally, try to copy the style of code found in the class you're editing.

Project Layout

The project is split up into a few separate modules.

  • API - The public, semantically versioned API used by other plugins wishing to integrate with and retrieve data from LuckPerms. This module (for the most part) does not contain any implementation itself, and is provided by the plugin.
  • Common - The common module contains most of the code which implements the respective LuckPerms plugins. This abstract module reduces duplicated code throughout the project.
  • Bukkit, BungeeCord, Sponge, Nukkit & Velocity - Each use the common module to implement plugins on the respective server platforms.

License

LuckPerms is licensed under the permissive MIT license. Please see LICENSE.txt for more info.