diff --git a/README.creole b/README.creole new file mode 100644 index 000000000..b105df23f --- /dev/null +++ b/README.creole @@ -0,0 +1,80 @@ += LuckPerms +A (fairly bad) permissions implementation for Bukkit/BungeeCord. + +=== Features +* **Group inheritance** - users can be members of multiple groups, groups can inherit other groups +* **Multi-server support** - data is synced across all servers/platforms +* **Per-server permissions/groups** - define user/group permissions that only apply on certain servers +* **Server-specific groups** - define groups that only apply on certain servers +* **Vault Support** - hooks into Vault to integrate with other plugins +* **Easy and simple setup and configuration using commands** - no editing yml files, yuck +* **Efficient/lightweight** - maybe? Who knows, it might be. +* **BungeeCord compatible** - permissions, users and groups are synced across Bukkit/BungeeCord instances +* **Support for MySQL and SQLite** - other storage methods coming soon (maybe) + +===== Possible Caveats +* Currently only supports MySQL and SQLite (support for more methods might come in the future) +* Not at all tested and could produce unexpected/buggy results and errors + +=== Setup +All configuration options are in the **config.yml** file, which is generated automagically when the plugin first starts. + +You can define the settings for per-server permissions, the storage method and credentials within this file. + +=== Commands + +Command usage is printed to the console/chat whenever invalid arguments are provided. Simply typing /perms will list all commands a user has permission to use. + +==== Aliases +| Bukkit | /luckperms | +| | /perms | +| | /permissions | +| | /lp | +| | /perm | +| Bungee | /luckpermsbungee | +| | /bperms | +| | /bpermissions | +| | /lpb | +| | /bperm | + +Arguments: [optional] + +Users with OP have access to all commands. + +| **Command** | **Description** | **Permission** | +| /perms | Sends plugin info and usage | N/A | +| /perms sync | Runs an update task and reloads the data of all online users | luckperms.sync | +| /perms info | Shows information about the plugin | luckperms.info | +| /perms debug | Shows some very brief debug info about the number of users/groups loaded | luckperms.debug | +| | | | +| | | | +| | | | +| /perms creategroup | Creates a new group with the given name | luckperms.creategroup | +| /perms deletegroup | Deletes an existing group | luckperms.deletegroup | +| /perms listgroups | Shows a list of the groups registered within the system | luckperms.listgroups | +| | | | +| | | | +| | | | +| /perms user info | Shows info about the user | luckperms.user.info | +| /perms user getuuid | Shows the users Mojang UUID | luckperms.user.getuuid | +| /perms user listnodes | Lists all of the permission nodes the user has | luckperms.user.listnodes | +| /perms user haspermission [server] | Checks if the user has a permission on a certain server | luckperms.user.haspermission | +| /perms user set [server]| Sets a permission for the user | luckperms.user.setpermission | +| /perms user unset [server] | Unsets a permission for the user | luckperms.user.unsetpermission | +| /perms user addgroup [server] | Adds the user to a group | luckperms.user.addgroup | +| /perms user removegroup [server] | Removes the user from a group | luckperms.user.removegroup | +| /perms user clear | Clears all permissions the user has | luckperms.user.clear | +| | | | +| | | | +| | | | +| /perms group info | Shows info about the group | luckperms.group.info | +| /perms group listnodes | Lists all of the permission nodes the group has | luckperms.group.listnodes | +| /perms group haspermission [server] | Checks if the group has a permission on a certain server | luckperms.group.haspermission | +| /perms group set [server]| Sets a permission for the group | luckperms.group.setpermission | +| /perms group unset [server] | Unsets a permission for the group | luckperms.group.unsetpermission | +| /perms group setinherit [server]| Sets the group to inherit all permissions from another group | luckperms.group.setinherit | +| /perms group unsetinherit [server] | Unsets a perviously defined inheritance rule | luckperms.group.unsetinherit | +| /perms group clear | Clears all permissions the group has | luckperms.group.clear | + +=== License +See LICENSE.md. diff --git a/README.md b/README.md deleted file mode 100644 index 9596d6b39..000000000 --- a/README.md +++ /dev/null @@ -1,28 +0,0 @@ -# LuckPerms -A quite possibly shit™ permissions implementation for Bukkit/BungeeCord. - -### Why? -Yeah, I don't know. There are other more advanced, optimized, better programmed and thoroughly tested alternative plugins around, you should probably use those instead. I just wanted some specific features, and something that was compatible with BungeeCord. - -### Features - - **Group inheritance** - users can be members of multiple groups, groups can inherit other groups - - **Multi-server support** - data is synced across all servers/platforms - - **Per-server permissions/groups** - define permissions that only apply on certain servers - - **Vault Support** - hooks into Vault to integrate with other plugins - - **Everything is configured using commands** - no editing yml files, yuck - - **Efficient** - maybe? Who knows, it might be. - - **BungeeCord compatible** - my main motive for making this was that all other Bungee/Bukkit compatible perms plugins are utter aids. (At least, I couldn't find any decent ones) - -### Caveats - - Only supports MySQL & SQLite (support for other stuff might happen in the future) - - Not at all tested and could be super unreliable - - It's quite possibly shit™ - -So, not anything major, really ¯\ _(ツ)_ /¯ - -### Commands -Command usage is printed when you supply too little arguments. - -Bukkit: `/luckperms` `/perms` `/permissions` `/lp` `/perm` - -Bungee: `/luckpermsbungee` `/bperms` `/bpermissions` `/lpb` `/bperm`