A permissions plugin for Minecraft servers.
Go to file
Luck 3474c66c1c
Big API refactor
- removed a bunch of ugly / badly designed methods and APIs
- refactored 'Contexts' --> 'QueryOptions'
- Removed the FullySatisfiedContexts hack and replaced it with a sane API
- Made PermissionHolder (in the API) less ugly and horrible
- removed lots of deprecated / duplicated API functionality
and much more...
2019-08-26 14:02:44 +01:00
.github Create FUNDING.yml 2019-05-27 10:40:12 +01:00
api Big API refactor 2019-08-26 14:02:44 +01:00
bukkit Big API refactor 2019-08-26 14:02:44 +01:00
bukkit-legacy Buildscript changes 2019-01-07 21:25:11 +00:00
bungee Big API refactor 2019-08-26 14:02:44 +01:00
common Big API refactor 2019-08-26 14:02:44 +01:00
gradle/wrapper Update Gradle to 5.0 2018-12-15 22:24:17 +00:00
nukkit Big API refactor 2019-08-26 14:02:44 +01:00
sponge Big API refactor 2019-08-26 14:02:44 +01:00
velocity Big API refactor 2019-08-26 14:02:44 +01:00
.gitignore Update gitignore 2018-08-31 20:27:13 +01:00
build.gradle Update to expect Velocity shading text 3 2019-05-07 13:59:44 +01: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 README.md 2018-11-06 16:36:34 +00:00
settings.gradle replace LoadingCache with more simple LoadingMap alternative when no auto expiry is needed 2018-12-14 18:37:56 +00:00

alt text

LuckPerms

Build Status Javadocs 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.