Upstream/LuckPerms
1
0
Fork 0
mirror of https://github.com/LuckPerms/LuckPerms.git synced 2024-12-02 23:53:25 +01:00
Code Issues Projects Releases Wiki Activity

Updated Why LuckPerms (markdown)

Luck 2017-09-15 23:26:53 +01:00
parent c63225920a
commit c322a5edfb
1 changed files with 33 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

44
Why-LuckPerms.md

@ -1,25 +1,47 @@
<!--- https://paste.lucko.me/HWn0fZKoJn -->
## Yet another permissions plugin?
Yep. I thought there was room for improvement among the plugins already out there.
**Hi there!** 👋
This page attempts to answer a number of questions/reactions people tend to have when they first discover the plugin.
(it also serves as a great way for me to explain all the great things the project can do. It's awesome, I promise!)
___
### Yet another permissions plugin?
Yep. I thought there was room for improvement among the plugins already out there. 😄
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?
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.
### I've been using [x] plugin for years and it works great for me! 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.
## Yeah but I like x plugin because it does everything I need it to do.
That's fine! I totally understand that mindset. I'm not trying to claim you absolutely *have* to use LP. There are lots of other viable options which may suit your needs better.
In addition, LuckPerms offers a number of innovative and original features, which you simply will not find elsewhere. (more on these features later!)
## Come on then, tell me, why should I use it?
___
### 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?
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, way after Bukkit became popular, and after a lot of other permission plugins had become stable. I could model LuckPerms around what other plugins had done well, and avoid mistakes and flaws which I saw in existing options.
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 page, I'll focus on some of the new features LuckPerms has, which you are unlikely to find in other plugins.
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
LuckPerms has a [verbose](https://github.com/lucko/LuckPerms/wiki/Verbose) system, which allows you to monitor permission checks made by other plugins, occurring in real time.