diff --git a/Argument-based-command-permissions.md b/Argument-based-command-permissions.md index 40cb2d1..06d07ae 100644 --- a/Argument-based-command-permissions.md +++ b/Argument-based-command-permissions.md @@ -1,4 +1,4 @@ -This page documents the [`argument-based-command-permissions`](Configuration#argument-based-command-permissions) configuration option. +This page documents the [`argument-based-command-permissions`](https://github.com/lucko/LuckPerms/wiki/Configuration#argument-based-command-permissions) configuration option. When this option is enabled, LuckPerms will run extra permission checks when a player tries to modify or view permission data. diff --git a/Command-Usage.md b/Command-Usage.md index f9a8ead..3e36ec0 100644 --- a/Command-Usage.md +++ b/Command-Usage.md @@ -1,6 +1,6 @@ Command usage is printed to the console/chat whenever invalid arguments are provided. **Simply typing /lp** will list all commands a user has permission to use. -If the only thing returned when you type a command is the plugin version, you do not have permission to use any of the commands. You need to use the server console to [give yourself access to LuckPerms commands first](Usage#granting-full-access-to-modify-permissions). +If the only thing returned when you type a command is the plugin version, you do not have permission to use any of the commands. You need to use the server console to [give yourself access to LuckPerms commands first](https://github.com/lucko/LuckPerms/wiki/Usage#granting-full-access-to-modify-permissions). ### Aliases A list of aliases for each platform are listed below. Each command works in exactly the same manner, so you can use whichever you prefer. @@ -29,129 +29,129 @@ The alias used below (/lp) can be exchanged for any of the ones listed in the al ### General commands General commands used to operate LuckPerms functions. -* [/lp](Command-Usage:-General#lp) -* [/lp `sync`](Command-Usage:-General#lp-sync) -* [/lp `info`](Command-Usage:-General#lp-info) -* [/lp `editor`](Command-Usage:-General#lp-editor-type) -* [/lp `debug`](Command-Usage:-General#lp-debug) -* [/lp `verbose` \ [filter]](Command-Usage:-General#lp-verbose-onrecordoffupload-filter) -* [/lp `tree` [scope] [player]](Command-Usage:-General#lp-tree-scope-player) -* [/lp `search` \](Command-Usage:-General#lp-search-permission) -* [/lp `check` \ \](Command-Usage:-General#lp-check-user-permission) -* [/lp `networksync`](Command-Usage:-General#lp-networksync) -* [/lp `import` \](Command-Usage:-General#lp-import-file) -* [/lp `export` \](Command-Usage:-General#lp-export-file) -* [/lp `reloadconfig`](Command-Usage:-General#lp-reloadconfig) -* [/lp `bulkupdate`](Command-Usage:-General#lp-bulkupdate-data-type-action-action-field-action-value-constraints) -* [/lp `migration`](Command-Usage:-General#lp-migration-plugin-name-options) -* [/lp `creategroup` \](Command-Usage:-General#lp-creategroup-name) -* [/lp `deletegroup` \](Command-Usage:-General#lp-deletegroup-name) -* [/lp `listgroups`](Command-Usage:-General#lp-listgroups) -* [/lp `createtrack` \](Command-Usage:-General#lp-createtrack-name) -* [/lp `deletetrack` \](Command-Usage:-General#lp-deletetrack-name) -* [/lp `listtracks`](Command-Usage:-General#lp-listtracks) +* [/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) +* [/lp `editor`](https://github.com/lucko/LuckPerms/wiki/Command-Usage:-General#lp-editor-type) +* [/lp `debug`](https://github.com/lucko/LuckPerms/wiki/Command-Usage:-General#lp-debug) +* [/lp `verbose` \ [filter]](https://github.com/lucko/LuckPerms/wiki/Command-Usage:-General#lp-verbose-onrecordoffupload-filter) +* [/lp `tree` [scope] [player]](https://github.com/lucko/LuckPerms/wiki/Command-Usage:-General#lp-tree-scope-player) +* [/lp `search` \](https://github.com/lucko/LuckPerms/wiki/Command-Usage:-General#lp-search-permission) +* [/lp `check` \ \](https://github.com/lucko/LuckPerms/wiki/Command-Usage:-General#lp-check-user-permission) +* [/lp `networksync`](https://github.com/lucko/LuckPerms/wiki/Command-Usage:-General#lp-networksync) +* [/lp `import` \](https://github.com/lucko/LuckPerms/wiki/Command-Usage:-General#lp-import-file) +* [/lp `export` \](https://github.com/lucko/LuckPerms/wiki/Command-Usage:-General#lp-export-file) +* [/lp `reloadconfig`](https://github.com/lucko/LuckPerms/wiki/Command-Usage:-General#lp-reloadconfig) +* [/lp `bulkupdate`](https://github.com/lucko/LuckPerms/wiki/Command-Usage:-General#lp-bulkupdate-data-type-action-action-field-action-value-constraints) +* [/lp `migration`](https://github.com/lucko/LuckPerms/wiki/Command-Usage:-General#lp-migration-plugin-name-options) +* [/lp `creategroup` \](https://github.com/lucko/LuckPerms/wiki/Command-Usage:-General#lp-creategroup-name) +* [/lp `deletegroup` \](https://github.com/lucko/LuckPerms/wiki/Command-Usage:-General#lp-deletegroup-name) +* [/lp `listgroups`](https://github.com/lucko/LuckPerms/wiki/Command-Usage:-General#lp-listgroups) +* [/lp `createtrack` \](https://github.com/lucko/LuckPerms/wiki/Command-Usage:-General#lp-createtrack-name) +* [/lp `deletetrack` \](https://github.com/lucko/LuckPerms/wiki/Command-Usage:-General#lp-deletetrack-name) +* [/lp `listtracks`](https://github.com/lucko/LuckPerms/wiki/Command-Usage:-General#lp-listtracks) ### User commands Commands used to view or modify a specific user. Formed of `/lp user ...` - where `` is the username or uuid of the user being queried / modified. -* [/lp user \ `info`](Command-Usage:-User#lp-user-user-info) -* [/lp user \ `permission`](Command-Usage:-Permission) -* [/lp user \ `parent`](Command-Usage:-Parent) -* [/lp user \ `meta`](Command-Usage:-Meta) -* [/lp user \ `editor`](Command-Usage:-User#lp-user-user-editor) -* [/lp user \ `promote` \ [context...]](Command-Usage:-User#lp-user-user-promote-track-context) -* [/lp user \ `demote` \ [context...]](Command-Usage:-User#lp-user-user-demote-track-context) -* [/lp user \ `showtracks`](Command-Usage:-User#lp-user-user-showtracks) -* [/lp user \ `clear` [context...]](Command-Usage:-User#lp-user-user-clear-context) -* [/lp user \ `clone` \](Command-Usage:-User#lp-user-user-clone-user) +* [/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) +* [/lp user \ `meta`](https://github.com/lucko/LuckPerms/wiki/Command-Usage:-Meta) +* [/lp user \ `editor`](https://github.com/lucko/LuckPerms/wiki/Command-Usage:-User#lp-user-user-editor) +* [/lp user \ `promote` \ [context...]](https://github.com/lucko/LuckPerms/wiki/Command-Usage:-User#lp-user-user-promote-track-context) +* [/lp user \ `demote` \ [context...]](https://github.com/lucko/LuckPerms/wiki/Command-Usage:-User#lp-user-user-demote-track-context) +* [/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-context) +* [/lp user \ `clone` \](https://github.com/lucko/LuckPerms/wiki/Command-Usage:-User#lp-user-user-clone-user) ### 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`](Command-Usage:-Group#lp-group-group-info) -* [/lp group \ `permission`](Command-Usage:-Permission) -* [/lp group \ `parent`](Command-Usage:-Parent) -* [/lp group \ `meta`](Command-Usage:-Meta) -* [/lp group \ `editor`](Command-Usage:-Group#lp-group-group-editor) -* [/lp group \ `listmembers` [page]](Command-Usage:-Group#lp-group-group-listmembers-page) -* [/lp group \ `setweight` \](Command-Usage:-Group#lp-group-group-setweight-weight) -* [/lp group \ `setdisplayname` \](Command-Usage:-Group#lp-group-group-setdisplayname-name) -* [/lp group \ `showtracks`](Command-Usage:-Group#lp-group-group-showtracks) -* [/lp group \ `clear` [context...]](Command-Usage:-Group#lp-group-group-clear-context) -* [/lp group \ `rename` \](Command-Usage:-Group#lp-group-group-rename-new-name) -* [/lp group \ `clone` \](Command-Usage:-Group#lp-group-group-clone-new-name) +* [/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) +* [/lp group \ `meta`](https://github.com/lucko/LuckPerms/wiki/Command-Usage:-Meta) +* [/lp group \ `editor`](https://github.com/lucko/LuckPerms/wiki/Command-Usage:-Group#lp-group-group-editor) +* [/lp group \ `listmembers` [page]](https://github.com/lucko/LuckPerms/wiki/Command-Usage:-Group#lp-group-group-listmembers-page) +* [/lp group \ `setweight` \](https://github.com/lucko/LuckPerms/wiki/Command-Usage:-Group#lp-group-group-setweight-weight) +* [/lp group \ `setdisplayname` \](https://github.com/lucko/LuckPerms/wiki/Command-Usage:-Group#lp-group-group-setdisplayname-name) +* [/lp group \ `showtracks`](https://github.com/lucko/LuckPerms/wiki/Command-Usage:-Group#lp-group-group-showtracks) +* [/lp group \ `clear` [context...]](https://github.com/lucko/LuckPerms/wiki/Command-Usage:-Group#lp-group-group-clear-context) +* [/lp group \ `rename` \](https://github.com/lucko/LuckPerms/wiki/Command-Usage:-Group#lp-group-group-rename-new-name) +* [/lp group \ `clone` \](https://github.com/lucko/LuckPerms/wiki/Command-Usage:-Group#lp-group-group-clone-new-name) ### 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`](Command-Usage:-Permission#lp-usergroup-usergroup-permission-info) -* [`set` \ \ [context...]](Command-Usage:-Permission#lp-usergroup-usergroup-permission-set-node-truefalse-context) -* [`unset` \ [context...]](Command-Usage:-Permission#lp-usergroup-usergroup-permission-unset-node-context) -* [`settemp` \ \ \ [temporary modifier] [context...]](Command-Usage:-Permission#lp-usergroup-usergroup-permission-settemp-node-truefalse-duration-temporary-modifier-context) -* [`unsettemp` \ [context...]](Command-Usage:-Permission#lp-usergroup-usergroup-permission-unsettemp-node-context) -* [`check` \ [context...]](Command-Usage:-Permission#lp-usergroup-usergroup-permission-check-node-context) -* [`checkinherits` \ [context...]](Command-Usage:-Permission#lp-usergroup-usergroup-permission-checkinherits-node-context) -* [`clear` [context...]](Command-Usage:-Permission#lp-usergroup-usergroup-permission-clear-context) +* [`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-node-truefalse-context) +* [`unset` \ [context...]](https://github.com/lucko/LuckPerms/wiki/Command-Usage:-Permission#lp-usergroup-usergroup-permission-unset-node-context) +* [`settemp` \ \ \ [temporary modifier] [context...]](https://github.com/lucko/LuckPerms/wiki/Command-Usage:-Permission#lp-usergroup-usergroup-permission-settemp-node-truefalse-duration-temporary-modifier-context) +* [`unsettemp` \ [context...]](https://github.com/lucko/LuckPerms/wiki/Command-Usage:-Permission#lp-usergroup-usergroup-permission-unsettemp-node-context) +* [`check` \ [context...]](https://github.com/lucko/LuckPerms/wiki/Command-Usage:-Permission#lp-usergroup-usergroup-permission-check-node-context) +* [`checkinherits` \ [context...]](https://github.com/lucko/LuckPerms/wiki/Command-Usage:-Permission#lp-usergroup-usergroup-permission-checkinherits-node-context) +* [`clear` [context...]](https://github.com/lucko/LuckPerms/wiki/Command-Usage:-Permission#lp-usergroup-usergroup-permission-clear-context) ### 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`](Command-Usage:-Parent#lp-usergroup-usergroup-parent-info) -* [`set` \ [context...]](Command-Usage:-Parent#lp-usergroup-usergroup-parent-set-group-context) -* [`add` \ [context...]](Command-Usage:-Parent#lp-usergroup-usergroup-parent-add-group-context) -* [`remove` \ [context...]](Command-Usage:-Parent#lp-usergroup-usergroup-parent-remove-group-context) -* [`settrack` \ \ [context...]](Command-Usage:-Parent#lp-usergroup-usergroup-parent-settrack-track-group-context) -* [`addtemp` \ \ [temporary modifier] [context...]](Command-Usage:-Parent#lp-usergroup-usergroup-parent-addtemp-group-duration-temporary-modifier-context) -* [`removetemp` \ [context...]](Command-Usage:-Parent#lp-usergroup-usergroup-parent-removetemp-group-context) -* [`clear` [context...]](Command-Usage:-Parent#lp-usergroup-usergroup-parent-clear-context) -* [`cleartrack` \ [context...]](Command-Usage:-Parent#lp-usergroup-usergroup-parent-cleartrack-track-context) -* [`switchprimarygroup` \](Command-Usage:-Parent#lp-user-user-parent-switchprimarygroup-group) +* [`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-group-context) +* [`add` \ [context...]](https://github.com/lucko/LuckPerms/wiki/Command-Usage:-Parent#lp-usergroup-usergroup-parent-add-group-context) +* [`remove` \ [context...]](https://github.com/lucko/LuckPerms/wiki/Command-Usage:-Parent#lp-usergroup-usergroup-parent-remove-group-context) +* [`settrack` \ \ [context...]](https://github.com/lucko/LuckPerms/wiki/Command-Usage:-Parent#lp-usergroup-usergroup-parent-settrack-track-group-context) +* [`addtemp` \ \ [temporary modifier] [context...]](https://github.com/lucko/LuckPerms/wiki/Command-Usage:-Parent#lp-usergroup-usergroup-parent-addtemp-group-duration-temporary-modifier-context) +* [`removetemp` \ [context...]](https://github.com/lucko/LuckPerms/wiki/Command-Usage:-Parent#lp-usergroup-usergroup-parent-removetemp-group-context) +* [`clear` [context...]](https://github.com/lucko/LuckPerms/wiki/Command-Usage:-Parent#lp-usergroup-usergroup-parent-clear-context) +* [`cleartrack` \ [context...]](https://github.com/lucko/LuckPerms/wiki/Command-Usage:-Parent#lp-usergroup-usergroup-parent-cleartrack-track-context) +* [`switchprimarygroup` \](https://github.com/lucko/LuckPerms/wiki/Command-Usage:-Parent#lp-user-user-parent-switchprimarygroup-group) ### 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`](Command-Usage:-Meta#lp-usergroup-usergroup-meta-info) -* [`set` \ \ [context...]](Command-Usage:-Meta#lp-usergroup-usergroup-meta-set-key-value-context) -* [`unset` \ [context...]](Command-Usage:-Meta#lp-usergroup-usergroup-meta-unset-key-value-context) -* [`settemp` \ \ \ [temporary modifier] [context...]](Command-Usage:-Meta#lp-usergroup-usergroup-meta-settemp-key-value-duration-temporary-modifier-context) -* [`unsettemp` \ [context...]](Command-Usage:-Meta#lp-usergroup-usergroup-meta-unsettemp-key-context) -* [`addprefix` \ \ [context...]](Command-Usage:-Meta#lp-usergroup-usergroup-meta-addprefix-priority-prefix-context) -* [`addsuffix` \ \ [context...]](Command-Usage:-Meta#lp-usergroup-usergroup-meta-addsuffix-priority-suffix-context) -* [`setprefix` [priority] \ [context...]](Command-Usage:-Meta#lp-usergroup-usergroup-meta-setprefix-priority-prefix-context) -* [`setsuffix` [priority] \ [context...]](Command-Usage:-Meta#lp-usergroup-usergroup-meta-setsuffix-priority-suffix-context) -* [`removeprefix` \ [prefix] [context...]](Command-Usage:-Meta#lp-usergroup-usergroup-meta-removeprefix-priority-prefix-context) -* [`removesuffix` \ [suffix] [context...]](Command-Usage:-Meta#lp-usergroup-usergroup-meta-removesuffix-priority-suffix-context) -* [`addtempprefix` \ \ \ [temporary modifier] [context...]](Command-Usage:-Meta#lp-usergroup-usergroup-meta-addtempprefix-priority-prefix-duration-temporary-modifier-context) -* [`addtempsuffix` \ \ \ [temporary modifier] [context...]](Command-Usage:-Meta#lp-usergroup-usergroup-meta-addtempsuffix-priority-suffix-duration-temporary-modifier-context) -* [`settempprefix` [priority] \ \ [temporary modifier] [context...]](Command-Usage:-Meta#lp-usergroup-usergroup-meta-settempprefix-priority-prefix-duration-temporary-modifier-context) -* [`settempsuffix` [priority] \ \ [temporary modifier] [context...]](Command-Usage:-Meta#lp-usergroup-usergroup-meta-settempsuffix-priority-suffix-duration-temporary-modifier-context) -* [`removetempprefix` \ [prefix] [context...]](Command-Usage:-Meta#lp-usergroup-usergroup-meta-removetempprefix-priority-prefix-context) -* [`removetempsuffix` \ [suffix] [context...]](Command-Usage:-Meta#lp-usergroup-usergroup-meta-removetempsuffix-priority-suffix-context) -* [`clear` [context...]](Command-Usage:-Meta#lp-usergroup-usergroup-meta-clear-context) +* [`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-key-value-context) +* [`unset` \ [context...]](https://github.com/lucko/LuckPerms/wiki/Command-Usage:-Meta#lp-usergroup-usergroup-meta-unset-key-value-context) +* [`settemp` \ \ \ [temporary modifier] [context...]](https://github.com/lucko/LuckPerms/wiki/Command-Usage:-Meta#lp-usergroup-usergroup-meta-settemp-key-value-duration-temporary-modifier-context) +* [`unsettemp` \ [context...]](https://github.com/lucko/LuckPerms/wiki/Command-Usage:-Meta#lp-usergroup-usergroup-meta-unsettemp-key-context) +* [`addprefix` \ \ [context...]](https://github.com/lucko/LuckPerms/wiki/Command-Usage:-Meta#lp-usergroup-usergroup-meta-addprefix-priority-prefix-context) +* [`addsuffix` \ \ [context...]](https://github.com/lucko/LuckPerms/wiki/Command-Usage:-Meta#lp-usergroup-usergroup-meta-addsuffix-priority-suffix-context) +* [`setprefix` [priority] \ [context...]](https://github.com/lucko/LuckPerms/wiki/Command-Usage:-Meta#lp-usergroup-usergroup-meta-setprefix-priority-prefix-context) +* [`setsuffix` [priority] \ [context...]](https://github.com/lucko/LuckPerms/wiki/Command-Usage:-Meta#lp-usergroup-usergroup-meta-setsuffix-priority-suffix-context) +* [`removeprefix` \ [prefix] [context...]](https://github.com/lucko/LuckPerms/wiki/Command-Usage:-Meta#lp-usergroup-usergroup-meta-removeprefix-priority-prefix-context) +* [`removesuffix` \ [suffix] [context...]](https://github.com/lucko/LuckPerms/wiki/Command-Usage:-Meta#lp-usergroup-usergroup-meta-removesuffix-priority-suffix-context) +* [`addtempprefix` \ \ \ [temporary modifier] [context...]](https://github.com/lucko/LuckPerms/wiki/Command-Usage:-Meta#lp-usergroup-usergroup-meta-addtempprefix-priority-prefix-duration-temporary-modifier-context) +* [`addtempsuffix` \ \ \ [temporary modifier] [context...]](https://github.com/lucko/LuckPerms/wiki/Command-Usage:-Meta#lp-usergroup-usergroup-meta-addtempsuffix-priority-suffix-duration-temporary-modifier-context) +* [`settempprefix` [priority] \ \ [temporary modifier] [context...]](https://github.com/lucko/LuckPerms/wiki/Command-Usage:-Meta#lp-usergroup-usergroup-meta-settempprefix-priority-prefix-duration-temporary-modifier-context) +* [`settempsuffix` [priority] \ \ [temporary modifier] [context...]](https://github.com/lucko/LuckPerms/wiki/Command-Usage:-Meta#lp-usergroup-usergroup-meta-settempsuffix-priority-suffix-duration-temporary-modifier-context) +* [`removetempprefix` \ [prefix] [context...]](https://github.com/lucko/LuckPerms/wiki/Command-Usage:-Meta#lp-usergroup-usergroup-meta-removetempprefix-priority-prefix-context) +* [`removetempsuffix` \ [suffix] [context...]](https://github.com/lucko/LuckPerms/wiki/Command-Usage:-Meta#lp-usergroup-usergroup-meta-removetempsuffix-priority-suffix-context) +* [`clear` [context...]](https://github.com/lucko/LuckPerms/wiki/Command-Usage:-Meta#lp-usergroup-usergroup-meta-clear-context) ### 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`](Command-Usage:-Track#lp-track-track-info) -* [/lp track \ `append` \](Command-Usage:-Track#lp-track-track-append-group) -* [/lp track \ `insert` \ \](Command-Usage:-Track#lp-track-track-insert-group-position) -* [/lp track \ `remove` \](Command-Usage:-Track#lp-track-track-remove-group) -* [/lp track \ `clear`](Command-Usage:-Track#lp-track-track-clear) -* [/lp track \ `rename` \](Command-Usage:-Track#lp-track-track-rename-new-name) -* [/lp track \ `clone` \](Command-Usage:-Track#lp-track-track-clone-new-name) +* [/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-group) +* [/lp track \ `insert` \ \](https://github.com/lucko/LuckPerms/wiki/Command-Usage:-Track#lp-track-track-insert-group-position) +* [/lp track \ `remove` \](https://github.com/lucko/LuckPerms/wiki/Command-Usage:-Track#lp-track-track-remove-group) +* [/lp track \ `clear`](https://github.com/lucko/LuckPerms/wiki/Command-Usage:-Track#lp-track-track-clear) +* [/lp track \ `rename` \](https://github.com/lucko/LuckPerms/wiki/Command-Usage:-Track#lp-track-track-rename-new-name) +* [/lp track \ `clone` \](https://github.com/lucko/LuckPerms/wiki/Command-Usage:-Track#lp-track-track-clone-new-name) ### Log commands Commands used to view the action log. -* [/lp log `recent` [user] [page]](Command-Usage:-Log#lp-log-recent-user-page) -* [/lp log `search` \ [page]](Command-Usage:-Log#lp-log-search-query-page) -* [/lp log `notify` [on|off]](Command-Usage:-Log#lp-log-notify-onoff) -* [/lp log `export` \](Command-Usage:-Log#lp-log-export-file) -* [/lp log `userhistory` \ [page]](Command-Usage:-Log#lp-log-userhistory-user-page) -* [/lp log `grouphistory` \ [page]](Command-Usage:-Log#lp-log-grouphistory-group-page) -* [/lp log `trackhistory` \ [page]](Command-Usage:-Log#lp-log-trackhistory-track-page) +* [/lp log `recent` [user] [page]](https://github.com/lucko/LuckPerms/wiki/Command-Usage:-Log#lp-log-recent-user-page) +* [/lp log `search` \ [page]](https://github.com/lucko/LuckPerms/wiki/Command-Usage:-Log#lp-log-search-query-page) +* [/lp log `notify` [on|off]](https://github.com/lucko/LuckPerms/wiki/Command-Usage:-Log#lp-log-notify-onoff) +* [/lp log `export` \](https://github.com/lucko/LuckPerms/wiki/Command-Usage:-Log#lp-log-export-file) +* [/lp log `userhistory` \ [page]](https://github.com/lucko/LuckPerms/wiki/Command-Usage:-Log#lp-log-userhistory-user-page) +* [/lp log `grouphistory` \ [page]](https://github.com/lucko/LuckPerms/wiki/Command-Usage:-Log#lp-log-grouphistory-group-page) +* [/lp log `trackhistory` \ [page]](https://github.com/lucko/LuckPerms/wiki/Command-Usage:-Log#lp-log-trackhistory-track-page) diff --git a/Command-Usage:-General.md b/Command-Usage:-General.md index cbad660..be8cf8d 100644 --- a/Command-Usage:-General.md +++ b/Command-Usage:-General.md @@ -1,4 +1,4 @@ -This is a sub-page of the main **Command Usage** page. [Click here to go back.](Command-Usage) +This is a sub-page of the main **Command Usage** page. [Click here to go back.](https://github.com/lucko/LuckPerms/wiki/Command-Usage) Key things to remember from the main page: @@ -81,7 +81,7 @@ Filters match the start of permissions or the user being checked. You can use `& * `!Luck & !anticheat` - matches any checks not against my user and not starting with "anticheat" * `anticheat & !anticheat.check` - matches any checks starting with "anticheat" but not starting with "anticheat.check" -More information can be found [**here**](Verbose) +More information can be found [**here**](https://github.com/lucko/LuckPerms/wiki/Verbose) ___ #### `/lp tree [scope] [player]` @@ -149,7 +149,7 @@ ___ * `[action value]` - the value to replace with. only required for update actions * `[constraints]` - the constraints required for the update -Allows you to perform a bulk modification to all permission data. A detailed guide on how to use this command can be found [here](Bulk-Editing). +Allows you to perform a bulk modification to all permission data. A detailed guide on how to use this command can be found [here](https://github.com/lucko/LuckPerms/wiki/Bulk-Editing). ___ #### `/lp migration [options]` @@ -158,7 +158,7 @@ ___ * `` - the plugin to migrate data from * `[options]` - the options required for certain plugin migrations -Main command used for the migration system. Allows you to import permissions data into LuckPerms from other permission plugins. More information about this feature can be found [here](Migration). +Main command used for the migration system. Allows you to import permissions data into LuckPerms from other permission plugins. More information about this feature can be found [here](https://github.com/lucko/LuckPerms/wiki/Migration). ___ #### `/lp creategroup ` diff --git a/Command-Usage:-Group.md b/Command-Usage:-Group.md index fadc033..2516a83 100644 --- a/Command-Usage:-Group.md +++ b/Command-Usage:-Group.md @@ -1,4 +1,4 @@ -This is a sub-page of the main **Command Usage** page. [Click here to go back.](Command-Usage) +This is a sub-page of the main **Command Usage** page. [Click here to go back.](https://github.com/lucko/LuckPerms/wiki/Command-Usage) Key things to remember from the main page: @@ -12,9 +12,9 @@ ___ ### Index * [/lp group \ `info`](#lp-group-group-info) -* [/lp group \ `permission`](Command-Usage:-Permission) -* [/lp group \ `parent`](Command-Usage:-Parent) -* [/lp group \ `meta`](Command-Usage:-Meta) +* [/lp group \ `permission`](https://github.com/lucko/LuckPerms/wiki/Command-Usage:-Permission) +* [/lp group \ `parent`](https://github.com/lucko/LuckPerms/wiki/Command-Usage:-Parent) +* [/lp group \ `meta`](https://github.com/lucko/LuckPerms/wiki/Command-Usage:-Meta) * [/lp group \ `editor`](#lp-group-group-editor) * [/lp group \ `listmembers` [page]](#lp-group-group-listmembers-page) * [/lp group \ `setweight` \](#lp-group-group-setweight-weight) @@ -55,7 +55,7 @@ ___ **Permission**: luckperms.group.setdisplayname **Arguments**: * `` - the name to set -* `[context...]` - the [contexts](Context) to set the display name in +* `[context...]` - the [contexts](https://github.com/lucko/LuckPerms/wiki/Context) to set the display name in Sets the groups display name. This can effectively be used as an "alias" for the group. @@ -68,7 +68,7 @@ ___ #### `/lp group clear [context]` **Permission**: luckperms.group.clear **Arguments**: -* `[context...]` - the [contexts](Context) to filter by +* `[context...]` - the [contexts](https://github.com/lucko/LuckPerms/wiki/Context) to filter by Clears the group's permissions, parent groups and meta. diff --git a/Command-Usage:-Log.md b/Command-Usage:-Log.md index c76c231..8d2e858 100644 --- a/Command-Usage:-Log.md +++ b/Command-Usage:-Log.md @@ -1,4 +1,4 @@ -This is a sub-page of the main **Command Usage** page. [Click here to go back.](Command-Usage) +This is a sub-page of the main **Command Usage** page. [Click here to go back.](https://github.com/lucko/LuckPerms/wiki/Command-Usage) Key things to remember from the main page: diff --git a/Command-Usage:-Meta.md b/Command-Usage:-Meta.md index b12f60a..672df71 100644 --- a/Command-Usage:-Meta.md +++ b/Command-Usage:-Meta.md @@ -1,4 +1,4 @@ -This is a sub-page of the main **Command Usage** page. [Click here to go back.](Command-Usage) +This is a sub-page of the main **Command Usage** page. [Click here to go back.](https://github.com/lucko/LuckPerms/wiki/Command-Usage) Key things to remember from the main page: @@ -41,7 +41,7 @@ ___ **Arguments**: * `` - the key to set * `` - the value to set the key to -* `[context...]` - the [contexts](Context) to set the meta in +* `[context...]` - the [contexts](https://github.com/lucko/LuckPerms/wiki/Context) to set the meta in Sets a meta key value pair for a user/group. These values can be read and modified by other plugins using Vault or the Sponge Permissions API. @@ -50,7 +50,7 @@ ___ **Permission**: luckperms.user.meta.unset or luckperms.group.meta.unset **Arguments**: * `` - the key to unset -* `[context...]` - the [contexts](Context) to unset the meta in +* `[context...]` - the [contexts](https://github.com/lucko/LuckPerms/wiki/Context) to unset the meta in Unsets a meta key value pair for a user/group. @@ -62,7 +62,7 @@ ___ * `` - the value to set the key to * `` - the duration until the meta will expire * `[temporary modifier]` - how the temporary permission should be applied -* `[context...]` - the [contexts](Context) to set the meta in +* `[context...]` - the [contexts](https://github.com/lucko/LuckPerms/wiki/Context) to set the meta in Sets a temporary meta key value pair for a user/group. Duration should either be a time period, or a unix timestamp when the permission will expire. e.g. "3d13h45m" will set the permission to expire in 3 days, 13 hours and 45 minutes time. "1482694200" will set the permission to expire at 7:30PM on 25th December 2016. LuckPerms uses a format for the relative time similar to the [SimpleDateFormat](https://docs.oracle.com/javase/7/docs/api/java/text/SimpleDateFormat.html) used in java. I.e. `1M` would be one month while `1m` would be one minute. @@ -80,7 +80,7 @@ ___ **Permission**: luckperms.user.meta.unsettemp or luckperms.group.meta.unsettemp **Arguments**: * `` - the key to unset -* `[context...]` - the [contexts](Context) to unset the meta in +* `[context...]` - the [contexts](https://github.com/lucko/LuckPerms/wiki/Context) to unset the meta in Unsets a temporary meta key value pair for a user/group. @@ -90,7 +90,7 @@ ___ **Arguments**: * `` - the priority to add the prefix at * `` - the actual prefix string -* `[context...]` - the [contexts](Context) to add the prefix in +* `[context...]` - the [contexts](https://github.com/lucko/LuckPerms/wiki/Context) to add the prefix in Adds a prefix to a user/group. You can wrap the prefix in " " quotes to escape spaces. @@ -100,7 +100,7 @@ ___ **Arguments**: * `` - the priority to add the suffix at * `` - the actual suffix string -* `[context...]` - the [contexts](Context) to add the suffix in +* `[context...]` - the [contexts](https://github.com/lucko/LuckPerms/wiki/Context) to add the suffix in Adds a suffix to a user/group. You can wrap the suffix in " " quotes to escape spaces. @@ -110,7 +110,7 @@ ___ **Arguments**: * `[priority]` - the priority to set the prefix at * `` - the actual prefix string -* `[context...]` - the [contexts](Context) to set the prefix in +* `[context...]` - the [contexts](https://github.com/lucko/LuckPerms/wiki/Context) to set the prefix in Sets a prefix for a user/group. You can wrap the prefix in " " quotes to escape spaces. This is different from the `addprefix` command in that existing prefixes set in the same context are removed when the new prefix is added. Another difference is that the priority argument is optional in the setprefix command - LuckPerms will determine an appropriate value for the priority when the command is ran. @@ -120,7 +120,7 @@ ___ **Arguments**: * `[priority]` - the priority to set the suffix at * `` - the actual suffix string -* `[context...]` - the [contexts](Context) to set the suffix in +* `[context...]` - the [contexts](https://github.com/lucko/LuckPerms/wiki/Context) to set the suffix in Sets a suffix for a user/group. You can wrap the suffix in " " quotes to escape spaces. This is different from the `addsuffix` command in that existing suffixes set in the same context are removed when the new suffix is added. Another difference is that the priority argument is optional in the setsuffix command - LuckPerms will determine an appropriate value for the priority when the command is ran. @@ -130,7 +130,7 @@ ___ **Arguments**: * `` - the priority to remove the prefix at * `[prefix]` - the actual prefix string -* `[context...]` - the [contexts](Context) to remove the prefix in +* `[context...]` - the [contexts](https://github.com/lucko/LuckPerms/wiki/Context) to remove the prefix in Removes a prefix from a user/group. You can wrap the prefix in " " quotes to escape spaces. @@ -140,7 +140,7 @@ ___ **Arguments**: * `` - the priority to remove the suffix at * `[suffix]` - the actual suffix string -* `[context...]` - the [contexts](Context) to remove the suffix in +* `[context...]` - the [contexts](https://github.com/lucko/LuckPerms/wiki/Context) to remove the suffix in Removes a suffix from a user/group. You can wrap the suffix in " " quotes to escape spaces. @@ -152,7 +152,7 @@ ___ * `` - the actual prefix string * `` - the duration until the prefix will expire * `[temporary modifier]` - how the temporary permission should be applied -* `[context...]` - the [contexts](Context) to add the prefix in +* `[context...]` - the [contexts](https://github.com/lucko/LuckPerms/wiki/Context) to add the prefix in Adds a prefix to a user/group temporarily. You can wrap the prefix in " " quotes to escape spaces. Duration should either be a time period, or a unix timestamp when the permission will expire. e.g. "3d13h45m" will set the permission to expire in 3 days, 13 hours and 45 minutes time. "1482694200" will set the permission to expire at 7:30PM on 25th December 2016. LuckPerms uses a format for the relative time similar to the [SimpleDateFormat](https://docs.oracle.com/javase/7/docs/api/java/text/SimpleDateFormat.html) used in java. I.e. `1M` would be one month while `1m` would be one minute. @@ -173,7 +173,7 @@ ___ * `` - the actual suffix string * `` - the duration until the suffix will expire * `[temporary modifier]` - how the temporary permission should be applied -* `[context...]` - the [contexts](Context) to add the suffix in +* `[context...]` - the [contexts](https://github.com/lucko/LuckPerms/wiki/Context) to add the suffix in Adds a suffix to a user/group temporarily. You can wrap the suffix in " " quotes to escape spaces. Duration should either be a time period, or a unix timestamp when the permission will expire. e.g. "3d13h45m" will set the permission to expire in 3 days, 13 hours and 45 minutes time. "1482694200" will set the permission to expire at 7:30PM on 25th December 2016. LuckPerms uses a format for the relative time similar to the [SimpleDateFormat](https://docs.oracle.com/javase/7/docs/api/java/text/SimpleDateFormat.html) used in java. I.e. `1M` would be one month while `1m` would be one minute. @@ -194,7 +194,7 @@ ___ * `` - the actual prefix string * `` - the duration until the prefix will expire * `[temporary modifier]` - how the temporary permission should be applied -* `[context...]` - the [contexts](Context) to set the prefix in +* `[context...]` - the [contexts](https://github.com/lucko/LuckPerms/wiki/Context) to set the prefix in Sets a prefix to a user/group temporarily. You can wrap the prefix in " " quotes to escape spaces. This is different from the `addtempprefix` command in that existing prefixes set in the same context are removed when the new prefix is added. Another difference is that the priority argument is optional in the settempprefix command - LuckPerms will dertermine an appropriate value for the priority when the command is ran. @@ -217,7 +217,7 @@ ___ * `` - the actual suffix string * `` - the duration until the suffix will expire * `[temporary modifier]` - how the temporary permission should be applied -* `[context...]` - the [contexts](Context) to set the suffix in +* `[context...]` - the [contexts](https://github.com/lucko/LuckPerms/wiki/Context) to set the suffix in Sets a suffix to a user/group temporarily. You can wrap the suffix in " " quotes to escape spaces. This is different from the `addtempsuffix` command in that existing suffixes set in the same context are removed when the new suffix is added. Another difference is that the priority argument is optional in the settempsuffix command - LuckPerms will dertermine an appropriate value for the priority when the command is ran. @@ -238,7 +238,7 @@ ___ **Arguments**: * `` - the priority to remove the prefix at * `[prefix]` - the actual prefix string -* `[context...]` - the [contexts](Context) to remove the prefix in +* `[context...]` - the [contexts](https://github.com/lucko/LuckPerms/wiki/Context) to remove the prefix in Removes a tempoary prefix from a user/group. You can wrap the prefix in " " quotes to escape spaces. @@ -248,7 +248,7 @@ ___ **Arguments**: * `` - the priority to remove the suffix at * `[suffix]` - the actual suffix string -* `[context...]` - the [contexts](Context) to remove the suffix in +* `[context...]` - the [contexts](https://github.com/lucko/LuckPerms/wiki/Context) to remove the suffix in Removes a temporary suffix from a user/group. You can wrap the suffix in " " quotes to escape spaces. @@ -256,7 +256,7 @@ ___ #### `/lp user/group meta clear [context...]` **Permission**: luckperms.user.meta.clear or luckperms.group.meta.clear **Arguments**: -* `[context...]` - the [contexts](Context) to filter by +* `[context...]` - the [contexts](https://github.com/lucko/LuckPerms/wiki/Context) to filter by Removes all meta/prefixes/suffixes. diff --git a/Command-Usage:-Parent.md b/Command-Usage:-Parent.md index 8998e91..04c6526 100644 --- a/Command-Usage:-Parent.md +++ b/Command-Usage:-Parent.md @@ -1,4 +1,4 @@ -This is a sub-page of the main **Command Usage** page. [Click here to go back.](Command-Usage) +This is a sub-page of the main **Command Usage** page. [Click here to go back.](https://github.com/lucko/LuckPerms/wiki/Command-Usage) Key things to remember from the main page: @@ -32,7 +32,7 @@ ___ **Permission**: luckperms.user.parent.set or luckperms.group.parent.set **Arguments**: * `` - the group to set -* `[context...]` - the [contexts](Context) to set the group in +* `[context...]` - the [contexts](https://github.com/lucko/LuckPerms/wiki/Context) to set the group in Sets a user/group's parent. Unlike the "parent add" command, this command will clear all existing groups set at the given context. The add command will simply "add" the group to the existing ones a user/group has. If the command is executed with no context arguments, this command will also update a user's primary group. @@ -41,7 +41,7 @@ ___ **Permission**: luckperms.user.parent.add or luckperms.group.parent.add **Arguments**: * `` - the group to add -* `[context...]` - the [contexts](Context) to add the group in +* `[context...]` - the [contexts](https://github.com/lucko/LuckPerms/wiki/Context) to add the group in Adds a parent to a user/group. Unlike the "parent set" command, this command will just accumulate the given parent with the ones the user/group already has. No existing parents will be removed from the user, and a user's primary group will be unaffected. @@ -50,7 +50,7 @@ ___ **Permission**: luckperms.user.parent.remove or luckperms.group.parent.remove **Arguments**: * `` - the group to remove -* `[context...]` - the [contexts](Context) to remove the group in +* `[context...]` - the [contexts](https://github.com/lucko/LuckPerms/wiki/Context) to remove the group in Removes a parent from the user/group. If the removed group was the users primary group, will they be set back to default as primary. @@ -61,7 +61,7 @@ ___ **Arguments**: * `` - the track to set on * `` - the group to set to, or a number relating to the position of the group on the given track -* `[context...]` - the [contexts](Context) to set the group in +* `[context...]` - the [contexts](https://github.com/lucko/LuckPerms/wiki/Context) to set the group in Sets a users/groups position on a given track. This behaves in the same way as the set command, except it only clears existing groups which are on the specified track. Other parent groups are not affected. ___ @@ -71,7 +71,7 @@ ___ * `` - the group to add * `` - the duration until the group will expire * `[temporary modifier]` - how the temporary permission should be applied -* `[context...]` - the [contexts](Context) to add the group in +* `[context...]` - the [contexts](https://github.com/lucko/LuckPerms/wiki/Context) to add the group in Adds a parent to a user/group temporarily. Duration should either be a time period, or a unix timestamp when the permission will expire. e.g. "1mo3d13h45m" will set the permission to expire in 1 month, 3 days, 13 hours and 45 minutes time, while "1482694200" will set the permission to expire at 7:30PM on 25th December 2016. @@ -88,7 +88,7 @@ ___ **Permission**: luckperms.user.parent.removetemp or luckperms.group.parent.removetemp **Arguments**: * `` - the group to remove -* `[context...]` - the [contexts](Context) to remove the group in +* `[context...]` - the [contexts](https://github.com/lucko/LuckPerms/wiki/Context) to remove the group in Removes a tempoary parent from the user/group. @@ -96,7 +96,7 @@ ___ #### `/lp user/group parent clear [context...]` **Permission**: luckperms.user.parent.clear or luckperms.group.parent.clear **Arguments**: -* `[context...]` - the [contexts](Context) to filter by +* `[context...]` - the [contexts](https://github.com/lucko/LuckPerms/wiki/Context) to filter by Removes all parents the user or group has. This will add them back to the `default` group. @@ -106,7 +106,7 @@ ___ **Permission**: luckperms.user.parent.cleartrack or luckperms.group.parent.cleartrack **Arguments**: * `` - the track to remove on -* `[context...]` - the [contexts](Context) to filter by +* `[context...]` - the [contexts](https://github.com/lucko/LuckPerms/wiki/Context) to filter by Removes all parents from the user/group on a given track. diff --git a/Command-Usage:-Permission.md b/Command-Usage:-Permission.md index b9cde59..ef8cca8 100644 --- a/Command-Usage:-Permission.md +++ b/Command-Usage:-Permission.md @@ -1,4 +1,4 @@ -This is a sub-page of the main **Command Usage** page. [Click here to go back.](Command-Usage) +This is a sub-page of the main **Command Usage** page. [Click here to go back.](https://github.com/lucko/LuckPerms/wiki/Command-Usage) Key things to remember from the main page: @@ -31,7 +31,7 @@ ___ **Arguments**: * `` - the permission node to set * `[true|false]` - the value to set the permission to (defaults to `true`) -* `[context...]` - the [contexts](Context) to set the permission in +* `[context...]` - the [contexts](https://github.com/lucko/LuckPerms/wiki/Context) to set the permission in Sets (or gives) a permission for a user/group with "true", granting the permission. Providing a value of "false" will negate the permission. Not adding any context will set the permission in context "global". @@ -40,7 +40,7 @@ ___ **Permission**: luckperms.user.permission.unset or luckperms.group.permission.unset **Arguments**: * `` - the permission node to unset -* `[context...]` - the [contexts](Context) to unset the permission in +* `[context...]` - the [contexts](https://github.com/lucko/LuckPerms/wiki/Context) to unset the permission in Unsets (or removes) a permission for a user/group. @@ -52,7 +52,7 @@ ___ * `` - the value to set the permission to * `` - the duration until the permission will expire * `[temporary modifier]` - how the temporary permission should be applied -* `[context...]` - the [contexts](Context) to set the permission in +* `[context...]` - the [contexts](https://github.com/lucko/LuckPerms/wiki/Context) to set the permission in Sets a permission temporarily for a user/group. Providing a value of "false" will negate the permission. Duration should either be a time period, or a unix timestamp when the permission will expire. e.g. "1mo3d13h45m" will set the permission to expire in 1 month, 3 days, 13 hours and 45 minutes time, while "1482694200" will set the permission to expire at 7:30PM on 25th December 2016. @@ -69,7 +69,7 @@ ___ **Permission**: luckperms.user.permission.unsettemp or luckperms.group.permission.unsettemp **Arguments**: * `` - the permission node to unset -* `[context...]` - the [contexts](Context) to unset the permission in +* `[context...]` - the [contexts](https://github.com/lucko/LuckPerms/wiki/Context) to unset the permission in Unsets a temporary permission for a user/group. @@ -78,7 +78,7 @@ ___ **Permission**: luckperms.user.permission.check or luckperms.group.permission.check **Arguments**: * `` - the permission node to check for -* `[context...]` - the [contexts](Context) to check for the permission in +* `[context...]` - the [contexts](https://github.com/lucko/LuckPerms/wiki/Context) to check for the permission in Checks to see if a user/group has a certain permission. @@ -87,7 +87,7 @@ ___ **Permission**: luckperms.user.permission.checkinherits or luckperms.group.permission.checkinherits **Arguments**: * `` - the permission node to check for -* `[context...]` - the [contexts](Context) to check for the permission in +* `[context...]` - the [contexts](https://github.com/lucko/LuckPerms/wiki/Context) to check for the permission in Checks to see if a user/group inherits a certain permission, and if so, where from. @@ -95,7 +95,7 @@ ___ #### `/lp user/group permission clear [context...]` **Permission**: luckperms.user.permission.clear or luckperms.group.permission.clear **Arguments**: -* `[context...]` - the [contexts](Context) to filter by +* `[context...]` - the [contexts](https://github.com/lucko/LuckPerms/wiki/Context) to filter by Removes all permissions from the user or group. diff --git a/Command-Usage:-Track.md b/Command-Usage:-Track.md index 9f573d1..7788014 100644 --- a/Command-Usage:-Track.md +++ b/Command-Usage:-Track.md @@ -1,4 +1,4 @@ -This is a sub-page of the main **Command Usage** page. [Click here to go back.](Command-Usage) +This is a sub-page of the main **Command Usage** page. [Click here to go back.](https://github.com/lucko/LuckPerms/wiki/Command-Usage) Key things to remember from the main page: diff --git a/Command-Usage:-User.md b/Command-Usage:-User.md index 610eea1..88bf899 100644 --- a/Command-Usage:-User.md +++ b/Command-Usage:-User.md @@ -1,4 +1,4 @@ -This is a sub-page of the main **Command Usage** page. [Click here to go back.](Command-Usage) +This is a sub-page of the main **Command Usage** page. [Click here to go back.](https://github.com/lucko/LuckPerms/wiki/Command-Usage) Key things to remember from the main page: @@ -12,9 +12,9 @@ ___ ### Index * [/lp user \ `info`](#lp-user-user-info) -* [/lp user \ `permission`](Command-Usage:-Permission) -* [/lp user \ `parent`](Command-Usage:-Parent) -* [/lp user \ `meta`](Command-Usage:-Meta) +* [/lp user \ `permission`](https://github.com/lucko/LuckPerms/wiki/Command-Usage:-Permission) +* [/lp user \ `parent`](https://github.com/lucko/LuckPerms/wiki/Command-Usage:-Parent) +* [/lp user \ `meta`](https://github.com/lucko/LuckPerms/wiki/Command-Usage:-Meta) * [/lp user \ `editor`](#lp-user-user-editor) * [/lp user \ `promote` \ [context...]](#lp-user-user-promote-track-context) * [/lp user \ `demote` \ [context...]](#lp-user-user-demote-track-context) @@ -37,7 +37,7 @@ ___ **Permission**: luckperms.user.promote **Arguments**: * `` - the track to promote along -* `[context...]` - the [contexts](Context) to promote in +* `[context...]` - the [contexts](https://github.com/lucko/LuckPerms/wiki/Context) to promote in This command will promote a user along a track. Firstly, the command will check to see if the user is on the track specified in the given contexts. If the user is not on the track, they will be added to the first group on the track. If they are on the track in more than one place, the command will fail. In all other cases, the user will be promoted up the track, and will be removed from the existing group. If the track action affects their primary group, that will be updated too. @@ -46,7 +46,7 @@ ___ **Permission**: luckperms.user.demote **Arguments**: * `` - the track to demote along -* `[context...]` - the [contexts](Context) to demote in +* `[context...]` - the [contexts](https://github.com/lucko/LuckPerms/wiki/Context) to demote in This command will demote a user along a track. Firstly, the command will check to see if the user is on the track specified in the given contexts. If the user is not on the track, or on the track in more than one place, the command will fail. If not, the user will be demoted down the track, and will be removed from the existing group. If the track action affects their primary group, that will be updated too. @@ -59,7 +59,7 @@ ___ #### `/lp user clear [context...]` **Permission**: luckperms.user.clear **Arguments**: -* `[context...]` - the [contexts](Context) to filter by +* `[context...]` - the [contexts](https://github.com/lucko/LuckPerms/wiki/Context) to filter by Clears the user's permissions, parent groups and meta. diff --git a/Configuration.md b/Configuration.md index 46a475f..53f27a7 100644 --- a/Configuration.md +++ b/Configuration.md @@ -87,7 +87,7 @@ Links to the default file for each platform are above. Please note that the conf ### `server` The name of the server, used for server specific permissions. -If set to "global" this setting is ignored. More details about how server specific permissions are groups work can be found [here](Advanced-Setup). +If set to "global" this setting is ignored. More details about how server specific permissions are groups work can be found [here](https://github.com/lucko/LuckPerms/wiki/Advanced-Setup). ##### Example ```yaml @@ -110,7 +110,7 @@ ___ ### `storage-method` Which storage method the plugin should use. -See [here](Storage-types) for a full list of supported types. +See [here](https://github.com/lucko/LuckPerms/wiki/Storage-types) for a full list of supported types. **Accepts:** `mysql`, `mariadb`, `postgresql`, `sqlite`, `h2`, `json`, `yaml`, `hocon`, `mongodb` @@ -307,7 +307,7 @@ ___ If LuckPerms should run extra permission checks when a player uses commands to modify permission data. -This system is documented in detail [here](Argument-based-command-permissions). +This system is documented in detail [here](https://github.com/lucko/LuckPerms/wiki/Argument-based-command-permissions). ##### Example ```yaml @@ -331,7 +331,7 @@ ___ How LuckPerms should form prefixes and suffixes. -This system is documented in detail [here](Prefix-&-Suffix-Stacking). +This system is documented in detail [here](https://github.com/lucko/LuckPerms/wiki/Prefix-&-Suffix-Stacking). ___ ### `inheritance-traversal-algorithm` @@ -351,7 +351,7 @@ ___ ### `include-global` If players on this server should have their global permissions applied. (permissions that were not set with a specific server). -If this option is set to false, only permissions that were specifically set to apply on this server will apply. Do not set to false if the "server" option above is set to global. More details about how server specific permissions are groups work can be found [here](Advanced-Setup). +If this option is set to false, only permissions that were specifically set to apply on this server will apply. Do not set to false if the "server" option above is set to global. More details about how server specific permissions are groups work can be found [here](https://github.com/lucko/LuckPerms/wiki/Advanced-Setup). ##### Example ```yaml @@ -414,7 +414,7 @@ ___ ### `apply-regex` If the plugin should parse regex permissions. -If set to true, LuckPerms will detect any regex permissions, marked with "r=" at the start of the node, and return all requests matching the node. If you do not have any regex permissions setup, enabling this option will have no impact on performance. More info on this feature can be found [here](Advanced-Setup#regex). +If set to true, LuckPerms will detect any regex permissions, marked with "r=" at the start of the node, and return all requests matching the node. If you do not have any regex permissions setup, enabling this option will have no impact on performance. More info on this feature can be found [here](https://github.com/lucko/LuckPerms/wiki/Advanced-Setup#regex). ##### Example ```yaml @@ -425,7 +425,7 @@ ___ ### `apply-shorthand` If the plugin should resolve and apply any shorthand (GLOB style) permissions. -More info on this feature can be found [here](Advanced-Setup#shorthand-permissions). +More info on this feature can be found [here](https://github.com/lucko/LuckPerms/wiki/Advanced-Setup#shorthand-permissions). ##### Example ```yaml @@ -667,7 +667,7 @@ ___ The `contexts.json` file is found alongside the main LuckPerms configuration file, and allows you to set two things. ### Static Contexts -Static contexts are [contexts](Command-Usage#what-is-context) which never change, and are granted to all players on the server by default. +Static contexts are [contexts](https://github.com/lucko/LuckPerms/wiki/Command-Usage#what-is-context) which never change, and are granted to all players on the server by default. LuckPerms provides one static context by default, called "server". This value is set using the `server` option in the main configuration file. @@ -686,7 +686,7 @@ Then, I can use `/lp group default permission set some.permission true servertyp ### Default Contexts -Default contexts are [contexts](Command-Usage#what-is-context) which are used by default in all commands executed on the server, if nothing is specifically specified. +Default contexts are [contexts](https://github.com/lucko/LuckPerms/wiki/Command-Usage#what-is-context) which are used by default in all commands executed on the server, if nothing is specifically specified. ```json { diff --git a/Default-Groups.md b/Default-Groups.md index fd5284e..db303dc 100644 --- a/Default-Groups.md +++ b/Default-Groups.md @@ -45,7 +45,7 @@ This option would mean that all users are still in the "default" group. However, ## Configure default assignments If you have more specific needs, then you can use this option. However, be aware that it will negate the storage space optimisations discussed in the first section of this page. All users will be explicitly saved, whether they are a "regular" user or not. -**Note:** This feature got removed in v5 of LuckPerms, if you still need it, see [this page](Upgrading-from-v4-to-v5#other). +**Note:** This feature got removed in v5 of LuckPerms, if you still need it, see [this page](https://github.com/lucko/LuckPerms/wiki/Upgrading-from-v4-to-v5#other). ##### Note: see the "Default Assignments" section of the config for more detail on this. diff --git a/Developer-API:-Usage.md b/Developer-API:-Usage.md index 3fe90a0..575ce50 100644 --- a/Developer-API:-Usage.md +++ b/Developer-API:-Usage.md @@ -1,4 +1,4 @@ -This page shows some sample usages of the LuckPerms API, which is introduced [here](Developer-API). +This page shows some sample usages of the LuckPerms API, which is introduced [here](https://github.com/lucko/LuckPerms/wiki/Developer-API). ___ @@ -15,7 +15,7 @@ ___ * [Saving changes](#saving-changes) * [The basics of Node](#the-basics-of-node) * [Creating new node instances](#creating-new-node-instances) - * [Modifying existing nodes](Developer-API:-Usage#modifying-existing-nodes) + * [Modifying existing nodes](https://github.com/lucko/LuckPerms/wiki/Developer-API:-Usage#modifying-existing-nodes) * [Reading user/group data](#reading-usergroup-data) * [Modifying user/group data](#modifying-usergroup-data) * [The basics of Context](#the-basics-of-context) @@ -111,7 +111,7 @@ public void giveAdminPermissions(UUID uniqueId) {...} The first thing we need to do is obtain the `UserManager`. This object is responsible for handling all operations relating to `User`s. The user manager provides a method which lets us load a `User` instance, appropriately named `loadUser`. -The method returns a `CompletableFuture` (explained [here](Developer-API#using-completablefutures)). +The method returns a `CompletableFuture` (explained [here](https://github.com/lucko/LuckPerms/wiki/Developer-API#using-completablefutures)). We can simply attach a callback onto the future to apply the action. @@ -419,7 +419,7 @@ ___ ### The basics of Context -Contexts are an important concept in LuckPerms, and are introduced [here](Context). They are encapsulated within the API by a few important classes. +Contexts are an important concept in LuckPerms, and are introduced [here](https://github.com/lucko/LuckPerms/wiki/Context). They are encapsulated within the API by a few important classes. A very basic overview is that: diff --git a/External-connections.md b/External-connections.md index 058b107..abc1062 100644 --- a/External-connections.md +++ b/External-connections.md @@ -11,7 +11,7 @@ ___ ### Downloading libraries -LuckPerms makes use of a lot of libraries - all of which are listed [here](Credits#open-source). +LuckPerms makes use of a lot of libraries - all of which are listed [here](https://github.com/lucko/LuckPerms/wiki/Credits#open-source). The plugin can be configured and used in a number of ways. For example, it supports a number of storage methods, each of which require their own set of drivers. Most plugins simply bundle (or "shade") these libraries into the plugin jar file - however, this is not practical for LuckPerms, as the high number of libraries would produce a huge final jar size. The solution is to download the *required* libraries at runtime, depending on the configuration being used. diff --git a/FAQ.md b/FAQ.md index d139f0e..c4b8b17 100644 --- a/FAQ.md +++ b/FAQ.md @@ -8,7 +8,7 @@ These are some of the questions that are asked quite frequently. Please check to ### Why are permissions not working? First, *make sure LuckPerms is your only permission plugin!* We have had many issues where people will install LuckPerms and not remove another permission manager like PermissionsEx. You *must* remove any other permission plugins otherwise LuckPerms will not be used for permission checking. The only exception is when you are performing a migration, in which case you must have both permission plugins installed but please remember to remove the old plugin afterwards. -If LuckPerms is your only permission plugin, then the issue could be that you have not added the correct permissions for what you require. Always make sure to consult the documentation of the plugins you are using to see what the available permissions are. If the documentation is incomplete or you're unable to find any, then you can use [Verbose mode](Verbose) to see which permissions are being checked in real-time and what value LuckPerms returns for the user that is being checked. +If LuckPerms is your only permission plugin, then the issue could be that you have not added the correct permissions for what you require. Always make sure to consult the documentation of the plugins you are using to see what the available permissions are. If the documentation is incomplete or you're unable to find any, then you can use [Verbose mode](https://github.com/lucko/LuckPerms/wiki/Verbose) to see which permissions are being checked in real-time and what value LuckPerms returns for the user that is being checked. *** @@ -17,13 +17,13 @@ Most of the time this isn't actually an issue with LuckPerms itself but here are - LuckPerms is *not* a chat formatter and another plugin is required to format the chat or tab list to include prefixes and suffixes. - If you are running a Bukkit based server (CraftBukkit, Spigot, Paper) then you also need to install [Vault](https://dev.bukkit.org/bukkit-plugins/vault/). - - Some popular chat formatting plugins are listed [here](Prefixes,-Suffixes-&-Meta#displaying-prefixes-and-suffixes). -- Firstly, you should check if a prefix/suffix is actually set with LuckPerms - run `/lp user info` and see if the prefix/suffix is displayed correctly. If so, great! LuckPerms has done its job and now it's up to your chat/tab/whatever formatter to display it correctly. If not, you need to [set a prefix or suffix](Prefixes,-Suffixes-&-Meta). + - Some popular chat formatting plugins are listed [here](https://github.com/lucko/LuckPerms/wiki/Prefixes,-Suffixes-&-Meta#displaying-prefixes-and-suffixes). +- Firstly, you should check if a prefix/suffix is actually set with LuckPerms - run `/lp user info` and see if the prefix/suffix is displayed correctly. If so, great! LuckPerms has done its job and now it's up to your chat/tab/whatever formatter to display it correctly. If not, you need to [set a prefix or suffix](https://github.com/lucko/LuckPerms/wiki/Prefixes,-Suffixes-&-Meta). - If you are using Essentials, make sure you are running [EssentialsX and EssentialsXChat](https://ci.ender.zone/job/EssentialsX/). The X is important! Other versions of Essentials may not work correctly with LuckPerms. - Run `/ess version` for a quick rundown on your Essentials setup, this also reports whether Vault is installed and which permission plugin you are running - preferably LuckPerms! If the command only returns a message like "Reloaded Essentials [version]" then you are using an unsupported version of Essentials and should update to EssentialsX (linked above). - Essentials provides the `{DISPLAYNAME}` placeholder to its chat formats which will combine the prefix, nickname and suffix into one. If you do not like this behaviour then you can change the `add-prefix-suffix` option to `false` in the Essentials config. -- Are your prefixes/suffixes displaying, but not the right ones? You most likely need to set the priority/weight correctly. If you type `/lp user meta info` and see a bunch of zeroes, or some/all of the numbers (priorities) are the same, LuckPerms will take the first highest one and use that as that user's prefix/suffix. To change these, you will need to [set the prefix again using the correct command](Command-Usage:-Meta#lp-usergroup-usergroup-meta-setprefix-priority-prefix-context) - or you can easily edit the number using the web editor. Prefixes and suffixes are stored as permissions, just like everything else, they look similar to this: `prefix.100.[Admin]` - the `100` there is the priority and this is the number you would change to edit it. -- Lastly, the `meta-formatting` section of the LuckPerms config is very important and you should make sure you only change it when necessary (e.g. [prefix/suffix stacking](Prefix-&-Suffix-Stacking)). It's possible your prefixes/suffixes are not working because this section has been tampered with. If you want to set it back to default, make sure the `format` looks like this: +- Are your prefixes/suffixes displaying, but not the right ones? You most likely need to set the priority/weight correctly. If you type `/lp user meta info` and see a bunch of zeroes, or some/all of the numbers (priorities) are the same, LuckPerms will take the first highest one and use that as that user's prefix/suffix. To change these, you will need to [set the prefix again using the correct command](https://github.com/lucko/LuckPerms/wiki/Command-Usage:-Meta#lp-usergroup-usergroup-meta-setprefix-priority-prefix-context) - or you can easily edit the number using the web editor. Prefixes and suffixes are stored as permissions, just like everything else, they look similar to this: `prefix.100.[Admin]` - the `100` there is the priority and this is the number you would change to edit it. +- Lastly, the `meta-formatting` section of the LuckPerms config is very important and you should make sure you only change it when necessary (e.g. [prefix/suffix stacking](https://github.com/lucko/LuckPerms/wiki/Prefix-&-Suffix-Stacking)). It's possible your prefixes/suffixes are not working because this section has been tampered with. If you want to set it back to default, make sure the `format` looks like this: ``` format: - "highest" @@ -32,16 +32,16 @@ Most of the time this isn't actually an issue with LuckPerms itself but here are *** ### How do I get permissions to sync across multiple servers? -This is explained in detail on the [Network Installation](Network-Installation) page. You should also read [Syncing data between servers](Syncing-data-between-servers). Here is a brief rundown: +This is explained in detail on the [Network Installation](https://github.com/lucko/LuckPerms/wiki/Network-Installation) page. You should also read [Syncing data between servers](https://github.com/lucko/LuckPerms/wiki/Syncing-data-between-servers). Here is a brief rundown: - You need the Bungeecord version of LuckPerms installed on your proxy if: - you want to manage Bungeecord permissions (in most cases, you do), or - you set your messaging-service to `pluginmsg` (not recommended when using a SQL database). - You need LuckPerms installed on each of your backend (Spigot, Sponge) servers. - You must ensure IP forwarding is enabled on Bungeecord and that the Spigot servers have `bungeecord: true`. -- You must use the same [remote storage method](Storage-types#remote-databases) (such as MySQL) on ALL of your LuckPerms installations. This requires the `storage-method` property to be set as well as the database credentials on all servers. +- You must use the same [remote storage method](https://github.com/lucko/LuckPerms/wiki/Storage-types#remote-databases) (such as MySQL) on ALL of your LuckPerms installations. This requires the `storage-method` property to be set as well as the database credentials on all servers. - Ensure your servers are all connected to the correct database by running `/lp info` and checking if the storage method is correct. Use `/lpb info` for Bungeecord (run it from the console if you run into permission errors). -- If you are using MySQL or MariaDB, set the [`messaging-service`](Configuration#messaging-service) to `sql` on all servers. This will enable syncing for all of your servers when a change is made to the database. +- If you are using MySQL or MariaDB, set the [`messaging-service`](https://github.com/lucko/LuckPerms/wiki/Configuration#messaging-service) to `sql` on all servers. This will enable syncing for all of your servers when a change is made to the database. *** @@ -53,7 +53,7 @@ Such as: * I'm getting an annoying SSL warning message * "No operations allowed after connection closed" error -Please see [here](Storage-system-errors). +Please see [here](https://github.com/lucko/LuckPerms/wiki/Storage-system-errors). *** diff --git a/GM-&-PEX-Command-Equivalents.md b/GM-&-PEX-Command-Equivalents.md index 1b3876b..a44bf6b 100644 --- a/GM-&-PEX-Command-Equivalents.md +++ b/GM-&-PEX-Command-Equivalents.md @@ -44,7 +44,7 @@ This page is designed to help users converting from GroupManager or PermissionsE |---------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------| | pex | lp | | pex reload | lp sync | -| pex toggle debug | [lp verbose \