Upstream
/
LuckPerms
mirror of https://github.com/LuckPerms/LuckPerms.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
A permissions plugin for Minecraft servers.
1,109 Commits 8 Branches 39 Tags 53 MiB
Java 100%
Go to file
Luck 168e712324
Update API to 4.1 		2018-02-23 22:13:41 +00:00
api Update API to 4.1 2018-02-23 22:13:41 +00:00
bukkit Update API to 4.1 2018-02-23 22:13:41 +00:00
bungee Update API to 4.1 2018-02-23 22:13:41 +00:00
common Update API to 4.1 2018-02-23 22:13:41 +00:00
nukkit Update API to 4.1 2018-02-23 22:13:41 +00:00
sponge Update API to 4.1 2018-02-23 22:13:41 +00:00
.gitignore Update .gitignore 2016-10-30 13:37:25 +00:00
CONTRIBUTING.md Remove lombok from the project 2018-01-07 18:40:23 +00:00
LICENSE.txt Cleanup poms, update copyright header 2017-04-15 19:01:52 +01:00
README.md Remove lombok from the project 2018-01-07 18:40:23 +00:00
pom.xml Update API to 4.1 2018-02-23 22:13:41 +00:00

README.md

alt text

LuckPerms Build Status Javadocs Maven Central

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.

The main features of the project are detailed on this wiki page: Why LuckPerms?

Useful Links

Building

LuckPerms uses Maven to handle dependencies.

Requirements

  • Java 8 JDK
  • Maven 3.3.x (the older versions will not work.)
  • Git

Then run

git clone https://github.com/lucko/LuckPerms.git
cd LuckPerms/
mvn clean package

You can find the output jars in the target 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 5 seperate 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 - 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.

Thanks

Thanks to ej-technologies for granting LuckPerms an open source licence to their Java Profiling Software.