LuckPerms/README.md

52 lines
3.2 KiB
Markdown
Raw Normal View History

2016-09-14 21:16:36 +02:00
![alt text](https://i.imgur.com/7TwJZ5e.png "Banner")
2017-12-01 01:01:50 +01:00
# LuckPerms [![Build Status](https://ci.lucko.me/job/LuckPerms/badge/icon)](https://ci.lucko.me/job/LuckPerms/) [![Javadocs](https://javadoc.io/badge/me.lucko.luckperms/luckperms-api.svg)](https://javadoc.io/doc/me.lucko.luckperms/luckperms-api) [![Maven Central](https://maven-badges.herokuapp.com/maven-central/me.lucko.luckperms/luckperms-api/badge.svg)](https://maven-badges.herokuapp.com/maven-central/me.lucko.luckperms/luckperms-api)
2017-01-27 21:37:27 +01:00
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.
2017-12-01 01:01:50 +01:00
The main features of the project are detailed on this wiki page: [Why LuckPerms?](https://github.com/lucko/LuckPerms/wiki/Why-LuckPerms)
2017-01-27 21:37:27 +01:00
* [Spigot Plugin Release Page](https://www.spigotmc.org/resources/luckperms-an-advanced-permissions-system.28140/ "Spigot Plugin Page")
* [Sponge Plugin Release Page](https://forums.spongepowered.org/t/luckperms-an-advanced-permissions-system/14274 "Sponge Plugin Page")
2016-07-21 22:40:24 +02:00
2017-01-27 21:37:27 +01:00
## Useful Links
2017-12-01 01:02:35 +01:00
* **Downloads** - <https://ci.lucko.me/job/LuckPerms>
2016-08-20 18:49:23 +02:00
* **Wiki** - <https://github.com/lucko/LuckPerms/wiki>
2016-07-26 04:39:56 +02:00
2017-01-27 21:37:27 +01:00
## Building
LuckPerms uses Maven to handle dependencies.
2016-08-19 22:54:40 +02:00
2017-01-27 21:37:27 +01:00
#### Requirements
2017-05-26 21:48:41 +02:00
* Java 8 JDK
2017-01-27 21:37:27 +01:00
* Maven 3.3.x (the older versions will not work.)
* Git
2016-11-12 18:27:15 +01:00
2017-01-27 21:37:27 +01:00
#### Then run
```sh
git clone https://github.com/lucko/LuckPerms.git
2017-05-26 21:48:41 +02:00
cd LuckPerms/
2017-01-27 21:37:27 +01:00
mvn clean package
```
2016-11-12 18:27:15 +01:00
2017-05-26 21:48:41 +02:00
You can find the output jars in the `target` directories.
## Contributing
#### Pull Requests
2017-12-01 01:01:50 +01:00
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!)
2017-05-26 21:48:41 +02:00
2017-12-01 01:01:50 +01:00
LuckPerms loosely follows the [Google Java Style Guide](https://google.github.io/styleguide/javaguide.html). Generally, try to copy the style of code found in the class you're editing.
2017-05-26 21:48:41 +02:00
#### Project Layout
The project is split up into 5 seperate modules.
2017-12-01 01:01:50 +01:00
* **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.
2017-05-26 21:48:41 +02:00
2017-01-27 21:37:27 +01:00
## License
LuckPerms is licensed under the permissive MIT license. Please see [`LICENSE.txt`](https://github.com/lucko/LuckPerms/blob/master/LICENSE.txt) for more info.
2016-09-14 21:16:36 +02:00
2017-01-27 21:37:27 +01:00
## Thanks
2017-02-23 22:59:43 +01:00
Thanks to ej-technologies for granting LuckPerms an open source licence to their [Java Profiling Software](http://www.ej-technologies.com/products/jprofiler/overview.html "Java Profiler").