Upstream/LuckPerms
1
0
Fork 0
mirror of https://github.com/LuckPerms/LuckPerms.git synced 2025-03-01 19:01:07 +01:00
Code Issues Projects Releases Wiki Activity

Updated Why LuckPerms (markdown)

Luck 2018-01-02 23:21:10 +00:00
parent 6266f19d78
commit 1d58b197a2
1 changed files with 11 additions and 27 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

38
Why-LuckPerms.md

@ -1,46 +1,29 @@
**Hi there!** 👋
This page attempts to answer a number of questions/reactions people tend to have when they first discover the plugin.
This page attempts to answer a number of questions/reactions people tend to have when they first discover the project, and address why you should use LuckPerms. It's awesome, I promise!
(it also serves as a great way for me to explain all the great things the project can do. It's awesome, I promise!)
So firstly, some FAQs.
___
### Yet another permissions plugin?
Yep. I thought there was room for improvement among the plugins already out there. 😄
#### Yet another permissions plugin?
Yep. I thought there was room for improvement among the plugins already out there. LuckPerms aims to be fast, reliable and flexible. The project's main goals centre around high performance and a wide feature set. It has an extensive developer API and supports a variety of data storage options.
LuckPerms is an advanced permissions plugin, 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.
___
### I've been using [x] plugin for years and it works great for me! Why should I bother switching?
#### I've been using [x] plugin for years and it works great! Why should I bother switching?
Most of the other available permission plugins date back a number of years, and were created in the early Bukkit era. Whilst this may mean they're stable, it also means they're often abandoned by the original authors, and receive no updates, support or bug fixes. LuckPerms is still a growing and active resource, and I endeavour to reply to all bug reports, issues and feature requests in a timely manner.
In addition, LuckPerms offers a number of innovative and original features, which you simply will not find elsewhere. (more on these features later!)
LuckPerms is the recommended replacement for the (now discontinued) PermissionsEx plugin. ([source](https://github.com/PEXPlugins/PermissionsEx/blob/master/README.md)) ([other source](https://i.imgur.com/PUpp8ou.png))
___
#### LuckPerms seems like a pretty big resource, and I just want something simple and lightweight.
Although the plugin has a pretty huge set of configuration options, the default values are fine for most users. The LuckPerms in-game and online interfaces are very straight forward to use, and there is a massive set of wiki pages and setup guides you can read here on GitHub. 🎉
### LuckPerms seems like a pretty big resource, and I just want something simple and lightweight.
Although the plugin has a pretty huge set of configuration options, the default values are fine for most people. Hooray! 🎉
You shouldn't even need to touch the configuration file if you just want to setup something basic for your server. The LuckPerms in-game and online interfaces are very straight forward to use, and there is a massive set of wiki pages and setup guides you can read here on GitHub.
___
### I run a big network and performance is important. How does LuckPerms perform?
#### I run a big network and performance is important. How does LuckPerms perform?
The plugin has been written and improved over time with large servers in mind. It has proven itself to be reliable and efficient and currently runs on a number of popular networks in the community.
From the very start, LuckPerms has been written to make use of multithreading for almost all of it's operations - something which previously hadn't been attempted in many permissions plugins. This design has proven to be highly effective, and is the reason why LuckPerms scales so well.
___
### Come on then, tell me, why should I use LuckPerms?
LuckPerms is capable of a lot, and at least on a technical level, outperforms the majority of other plugins. I don't accredit this to my own ability to create good plugins, but rather to timing.
I started working on the plugin in early 2016. I could model LuckPerms around what existing permissions plugins had done well, and avoid mistakes and flaws which I saw in existing options.
With that in mind, if you're interested in what LuckPerms can do "technically", a good place to start is the [Command Usage](https://github.com/lucko/LuckPerms/wiki/Command-Usage) page, or take a look at some of the pages listed under **Features** in the wiki contents.
For the rest of this article, I'll focus on some of the new features LuckPerms has, which you are unlikely to find in other plugins.
### Verbose
@ -53,7 +36,8 @@ You can trace exactly where permission checks originate from - right down to the
[![](https://i.imgur.com/Ta7gtd9.png)](https://i.imgur.com/Ta7gtd9.png)
You can also upload recordings to the web, for easier analysis and reading.
[https://git.io/vQitM](https://git.io/vQitM)
[![](https://i.imgur.com/xhnG2ue.png)](https://git.io/vbhy7)
### Permission Trees
LuckPerms allows you [build "permission trees"](https://github.com/lucko/LuckPerms/wiki/Command-Usage#lp-tree) of all permissions known to the server. The data is populated using permissions registered to the server by plugins.