Upstream/LuckPerms
1
0
Fork 0
mirror of https://github.com/LuckPerms/LuckPerms.git synced 2024-11-05 02:19:33 +01:00
Code Issues Projects Releases Wiki Activity
f793fd5010
LuckPerms/README.md
Luck 800749c5ed
Update README.md
2017-12-01 00:02:35 +00:00

3.3 KiB
Raw Blame History

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

In order to contribute to and make changes to the plugin, you will need the dependencies listed above, plus the Lombok plugin for your IDE.

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.