From 5bcbda5779f26e3ed480c9f311007412e05a7b3f Mon Sep 17 00:00:00 2001 From: Luck Date: Fri, 2 Mar 2018 23:38:01 +0000 Subject: [PATCH] Updated Command Usage (markdown) --- Command-Usage.md | 35 ++++++++++++++++++++++++++++------- 1 file changed, 28 insertions(+), 7 deletions(-) diff --git a/Command-Usage.md b/Command-Usage.md index 9f04d8e..8a19226 100644 --- a/Command-Usage.md +++ b/Command-Usage.md @@ -27,6 +27,8 @@ If you want to include spaces in arguments, you must escape the argument with qu The alias used below (/lp) can be exchanged for any of the ones listed in the aliases section above. ### General commands +General commands used to operate LuckPerms functions. + * [/lp](https://github.com/lucko/LuckPerms/wiki/Command-Usage:-General#lp) * [/lp `sync`](https://github.com/lucko/LuckPerms/wiki/Command-Usage:-General#lp-sync) * [/lp `info`](https://github.com/lucko/LuckPerms/wiki/Command-Usage:-General#lp-info) @@ -49,7 +51,10 @@ The alias used below (/lp) can be exchanged for any of the ones listed in the al * [/lp `deletetrack` \](https://github.com/lucko/LuckPerms/wiki/Command-Usage:-General#lp-deletetrack) * [/lp `listtracks`](https://github.com/lucko/LuckPerms/wiki/Command-Usage:-General#lp-listtracks) -### User commands (/lp user \ ...) +### User commands +Commands used to view or modify a specific user. + +Formed of `/lp user ...` - where `` is the username of uuid of the user being queried / modified. * [/lp user \ `info`](https://github.com/lucko/LuckPerms/wiki/Command-Usage:-User#lp-user-user-info) * [/lp user \ `permission`](https://github.com/lucko/LuckPerms/wiki/Command-Usage:-Permission) * [/lp user \ `parent`](https://github.com/lucko/LuckPerms/wiki/Command-Usage:-Parent) @@ -60,7 +65,10 @@ The alias used below (/lp) can be exchanged for any of the ones listed in the al * [/lp user \ `showtracks`](https://github.com/lucko/LuckPerms/wiki/Command-Usage:-User#lp-user-user-showtracks) * [/lp user \ `clear` [context...]](https://github.com/lucko/LuckPerms/wiki/Command-Usage:-User#lp-user-user-clear) -### Group commands (/lp group \ ...) +### Group commands +Commands used to view or modify a specific group. + +Formed of `/lp group ...` - where `` is the name of the group being queried / modified. * [/lp group \ `info`](https://github.com/lucko/LuckPerms/wiki/Command-Usage:-Group#lp-group-group-info) * [/lp group \ `permission`](https://github.com/lucko/LuckPerms/wiki/Command-Usage:-Permission) * [/lp group \ `parent`](https://github.com/lucko/LuckPerms/wiki/Command-Usage:-Parent) @@ -74,7 +82,10 @@ The alias used below (/lp) can be exchanged for any of the ones listed in the al * [/lp group \ `rename` \](https://github.com/lucko/LuckPerms/wiki/Command-Usage:-Group#lp-group-group-rename) * [/lp group \ `clone` \](https://github.com/lucko/LuckPerms/wiki/Command-Usage:-Group#lp-group-group-clone) -### Permission commands (/lp user \ permission ... | /lp group \ permission ...) +### Permission commands +Commands used to view or modify the permissions data of a specific user or group. + +Formed of either `/lp user permission ...` or `/lp group permission ...` * [`info`](https://github.com/lucko/LuckPerms/wiki/Command-Usage:-Permission#lp-usergroup-usergroup-permission-info) * [`set` \ \ [context...]](https://github.com/lucko/LuckPerms/wiki/Command-Usage:-Permission#lp-usergroup-usergroup-permission-set) * [`unset` \ [context...]](https://github.com/lucko/LuckPerms/wiki/Command-Usage:-Permission#lp-usergroup-usergroup-permission-unset) @@ -83,7 +94,10 @@ The alias used below (/lp) can be exchanged for any of the ones listed in the al * [`check` \ [context...]](https://github.com/lucko/LuckPerms/wiki/Command-Usage:-Permission#lp-usergroup-usergroup-permission-check) * [`checkinherits` \ [context...]](https://github.com/lucko/LuckPerms/wiki/Command-Usage:-Permission#lp-usergroup-usergroup-permission-checkinherits) -### Parent commands (/lp user \ parent ... | /lp group \ parent ...) +### Parent commands +Commands used to view or modify the inheritance properties (parents) of a specific user or group. + +Formed of either `/lp user parent ...` or `/lp group parent ...` * [`info`](https://github.com/lucko/LuckPerms/wiki/Command-Usage:-Parent#lp-usergroup-usergroup-parent-info) * [`set` \ [context...]](https://github.com/lucko/LuckPerms/wiki/Command-Usage:-Parent#lp-usergroup-usergroup-parent-set) * [`add` \ [context...]](https://github.com/lucko/LuckPerms/wiki/Command-Usage:-Parent#lp-usergroup-usergroup-parent-add) @@ -95,7 +109,10 @@ The alias used below (/lp) can be exchanged for any of the ones listed in the al * [`cleartrack` \ [context...]](https://github.com/lucko/LuckPerms/wiki/Command-Usage:-Parent#lp-usergroup-usergroup-parent-cleartrack) * [`switchprimarygroup` \](https://github.com/lucko/LuckPerms/wiki/Command-Usage:-Parent#lp-user-user-parent-switchprimarygroup) -### Meta commands (/lp user \ meta ... | /lp group \ meta ...) +### Meta commands +Commands used to view or modify the metadata of a specific user or group. + +Formed of either `/lp user meta ...` or `/lp group meta ...` * [`info`](https://github.com/lucko/LuckPerms/wiki/Command-Usage:-Meta#lp-usergroup-usergroup-meta-info) * [`set` \ \ [context...]](https://github.com/lucko/LuckPerms/wiki/Command-Usage:-Meta#lp-usergroup-usergroup-meta-set) * [`unset` \ [context...]](https://github.com/lucko/LuckPerms/wiki/Command-Usage:-Meta#lp-usergroup-usergroup-meta-unset) @@ -111,7 +128,10 @@ The alias used below (/lp) can be exchanged for any of the ones listed in the al * [`removetempsuffix` \ [suffix] [context...]](https://github.com/lucko/LuckPerms/wiki/Command-Usage:-Meta#lp-usergroup-usergroup-meta-removetempsuffix) * [`clear` [context...]](https://github.com/lucko/LuckPerms/wiki/Command-Usage:-Meta#lp-usergroup-usergroup-meta-clear) -### Track commands (/lp track \ ...) +### Track commands +Commands used to view or modify a specific track. + +Formed of `/lp track ...` - where `` is the name of the track being queried / modified. * [/lp track \ `info`](https://github.com/lucko/LuckPerms/wiki/Command-Usage:-Track#lp-track-track-info) * [/lp track \ `append` \](https://github.com/lucko/LuckPerms/wiki/Command-Usage:-Track#lp-track-track-append) * [/lp track \ `insert` \ \](https://github.com/lucko/LuckPerms/wiki/Command-Usage:-Track#lp-track-track-insert) @@ -120,7 +140,8 @@ The alias used below (/lp) can be exchanged for any of the ones listed in the al * [/lp track \ `rename` \](https://github.com/lucko/LuckPerms/wiki/Command-Usage:-Track#lp-track-track-rename) * [/lp track \ `clone` \](https://github.com/lucko/LuckPerms/wiki/Command-Usage:-Track#lp-track-track-clone) -### Log commands (/lp log ...) +### Log commands +Commands used to view the action log. * [/lp log `recent` [user] [page]](https://github.com/lucko/LuckPerms/wiki/Command-Usage:-Log#lp-log-recent) * [/lp log `search` \ [page]](https://github.com/lucko/LuckPerms/wiki/Command-Usage:-Log#lp-log-search) * [/lp log `notify` [on|off]](https://github.com/lucko/LuckPerms/wiki/Command-Usage:-Log#lp-log-notify)