From c0a0239eeba0baaddb8e194f3da0a53c09e87496 Mon Sep 17 00:00:00 2001 From: Luck Date: Wed, 24 Aug 2016 10:24:37 +0100 Subject: [PATCH] Update readme --- README.md | 37 ++++++------------------------------- 1 file changed, 6 insertions(+), 31 deletions(-) diff --git a/README.md b/README.md index 64c7680c..2fa97bd9 100644 --- a/README.md +++ b/README.md @@ -6,37 +6,12 @@ A permissions implementation for Bukkit/Spigot, BungeeCord and Sponge. * **Javadocs** - * **Wiki** - -## Why LuckPerms? -_Features checked on 19th Aug 2016. If you find any inaccuracies, please do let me know. I tried to be as fair as possible, and copy all major features from the respective plugin pages._ +## Description +LuckPerms is an advanced permissions implementation aiming to be a flexible, performant and reliable alternative to other permission systems, providing all the features you could ever possibly need in a permissions plugin, along with an extensive and well documented API for developers. -![alt text](https://static.lucko.me/luckperms-compare.png "Feature comparison") - -## Features -* **Group inheritance** - users can be members of multiple groups, groups can inherit other groups -* **Temporary permissions** - users/groups can be given permissions that expire after a given time -* **Wildcard permissions** - users/groups can be given wildcard permissions (e.g. "minecraft.command.*"), even when plugins haven't implemented their own wildcards. -* **Temporary groups** - users/groups can be added to/inherit other groups temporarily -* **Multi-server support** - data is synced across all servers/platforms -* **Full offline-mode/mixed-mode support** - player permissions are synced properly over offline-mode or mixed online/offline-mode networks. -* **Per-server permissions/groups** - define user/group permissions that only apply on certain servers -* **Per-world permissions/groups** - define user/group permissions that only apply on certain worlds (on BungeeCord, a connected Bukkit/Spigot instance is treated as a world) -* **Tracks / paths / ladders** - users can be promoted/demoted along multiple group tracks -* **Vault Support** - hooks into Vault to integrate with other plugins -* **Developer API** - easily integrate LuckPerms into your own projects -* **Advanced action logging** - keep track of permission changes over time -* **Easily switch between storage systems** - export a log file from one datastore and import it into another -* **Easy and simple setup and configuration using commands** - no editing yml files, yuck -* **Negated permissions and groups** - define special rules for certain users/groups -* **Regex permissions** - define special permissions using regex -* **Shorthand nodes** - add nodes using the LuckPerms shorthand system -* **Full support for UUIDs, even in Offline Mode** - users can change their usernames without losing permissions. In offline mode, a single user has the same internal UUID across a network. -* **Permission data stored within MySQL in a json format** - easily integrate the LuckPerms backend into your other projects -* **Well documented** - API methods have comprehensive Java docs, it's clear what each method does. -* **Efficient/lightweight** - maybe? Who knows, it might be. -* **Open Sourced, Free...** - you shouldn't have to pay $10+ for a "powerful" permissions plugin. -* **BungeeCord compatible** - permissions, users and groups are synced across all LuckPerms instances -* **Sponge compatible** - permissions, users and groups are synced across all LuckPerms instances (bukkit --> sponge, for example) -* **Support for MySQL, MongoDB, SQLite, H2 & Flatfile (JSON)** - other storage methods coming soon (maybe) +## LuckPerms vs Other Plugins +![alt text](https://static.lucko.me/luckperms-compare-copy.png "Feature comparison") +_Features checked on 23rd Aug 2016. If you find any inaccuracies, please do let me know. I tried to be as fair as possible, and copy all major features from the respective plugin pages._ ## License -See LICENSE.md. \ No newline at end of file +See LICENSE.md.