LuckPerms/README.md

![alt text](https://i.imgur.com/7TwJZ5e.png "Banner")
# LuckPerms [![Build Status](https://ci.lucko.me/job/LuckPerms/badge/icon)](https://ci.lucko.me/job/LuckPerms/)
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.

[See the charts below](https://github.com/lucko/LuckPerms#luckperms-vs-other-plugins) for a partial list of features & comparison with other providers.

* [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")

## Useful Links
* **Development Builds** - <https://ci.lucko.me/job/LuckPerms>
* **Javadocs** - <https://luckperms.lucko.me/javadocs/>
* **Wiki** - <https://github.com/lucko/LuckPerms/wiki>

## Building
LuckPerms uses Maven to handle dependencies.

#### Requirements
* Maven 3.3.x (the older versions will not work.)
* Git

#### Then run
```sh
git clone https://github.com/lucko/LuckPerms.git
mvn clean package
```

## 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.

## LuckPerms vs Other Plugins
### Bukkit
![alt text](https://static.lucko.me/luckperms-compare-copy.png "Feature comparison")
###### _Features checked on 23rd Aug 2016. If you find any inaccuracies, please let me know._
### Sponge
![alt text](https://static.lucko.me/luckperms-compare-sponge.png "Feature comparison")
###### _Features checked on 8th Oct 2016. If you find any inaccuracies, please let me know._

## Thanks
[![JProfiler](https://www.ej-technologies.com/images/product_banners/jprofiler_large.png)](http://www.ej-technologies.com/products/jprofiler/overview.html)

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").
Update readme 2016-09-14 21:16:36 +02:00			`![alt text](https://i.imgur.com/7TwJZ5e.png "Banner")`
Update readme 2016-07-26 04:39:56 +02:00			`# LuckPerms [![Build Status](https://ci.lucko.me/job/LuckPerms/badge/icon)](https://ci.lucko.me/job/LuckPerms/)`
Update readme 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.`

			`[See the charts below](https://github.com/lucko/LuckPerms#luckperms-vs-other-plugins) for a partial list of features & comparison with other providers.`

			`* [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")`
Add Api 2016-07-21 22:40:24 +02:00
Update readme 2017-01-27 21:37:27 +01:00			`## Useful Links`
Update readme 2016-08-02 15:12:06 +02:00			`* Development Builds - <https://ci.lucko.me/job/LuckPerms>`
update javadocs link in readme 2017-02-23 22:59:43 +01:00			`* Javadocs - <https://luckperms.lucko.me/javadocs/>`
A few small fixes 2016-08-20 18:49:23 +02:00			`* Wiki - <https://github.com/lucko/LuckPerms/wiki>`
Update readme 2016-07-26 04:39:56 +02:00
Update readme 2017-01-27 21:37:27 +01:00			`## Building`
			`LuckPerms uses Maven to handle dependencies.`
Update readme 2016-08-19 22:54:40 +02:00
Update readme 2017-01-27 21:37:27 +01:00			`#### Requirements`
			`* Maven 3.3.x (the older versions will not work.)`
			`* Git`
Update readme 2016-11-12 18:27:15 +01:00
Update readme 2017-01-27 21:37:27 +01:00			`#### Then run`
			```sh
			`git clone https://github.com/lucko/LuckPerms.git`
			`mvn clean package`
			```
Update readme 2016-11-12 18:27:15 +01:00
Update readme 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.
Update readme 2016-09-14 21:16:36 +02:00
Update readme 2016-08-24 11:24:37 +02:00			`## LuckPerms vs Other Plugins`
Update readme 2016-10-09 11:58:14 +02:00			`### Bukkit`
Update readme 2016-08-24 11:24:37 +02:00			`![alt text](https://static.lucko.me/luckperms-compare-copy.png "Feature comparison")`
Update readme 2017-01-27 21:37:27 +01:00			`###### _Features checked on 23rd Aug 2016. If you find any inaccuracies, please let me know._`
Update readme 2016-10-09 11:58:14 +02:00			`### Sponge`
			`![alt text](https://static.lucko.me/luckperms-compare-sponge.png "Feature comparison")`
Update readme 2017-01-27 21:37:27 +01:00			`###### _Features checked on 8th Oct 2016. If you find any inaccuracies, please let me know._`
Update readme 2016-09-10 10:04:59 +02:00
Update readme 2017-01-27 21:37:27 +01:00			`## Thanks`
Update readme 2016-09-10 10:04:59 +02:00			`[![JProfiler](https://www.ej-technologies.com/images/product_banners/jprofiler_large.png)](http://www.ej-technologies.com/products/jprofiler/overview.html)`

update javadocs link in readme 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").`