Updated Commands & Permissions (markdown)

Aurora Lahtela 2023-10-07 08:25:24 +03:00
parent 21c913c121
commit b0523ffc22

@ -5,7 +5,7 @@
- [Permissions Enum](https://github.com/plan-player-analytics/Plan/blob/master/Plan/common/src/main/java/com/djrapitops/plan/settings/Permissions.java)
This page is an in depth documentation of all permissions & commands.
Page version: **5.4 build 1485**
Page version: **5.6 build 2574**
### Contents
@ -28,6 +28,7 @@ Permission | Default (on spigot) | Description
`plan.register.other`|op|Access `/plan register` command, register user that can view any page, or register users for others
`plan.unregister.self`|true|Access `/plan unregister` command, remove own Plan-user
`plan.unregister.other`|op|remove anyone's Plan-user
`plan.setgroup.other`|op|change Plan user web group and list web groups.
`plan.logout.other`|op|logout users from Plan panel
`plan.info`|op|Access `/plan info` command
`plan.reload`|op|Access `/plan reload` command
@ -48,7 +49,8 @@ Permission | Default (on spigot) | Description
`plan.ignore.commanduse`|false|Commands used by this player are ignored
`plan.ignore.afk`|false|AFK Time not calculated for this player
- [How permissions determine web user access](https://github.com/plan-player-analytics/Plan/wiki/SSL-Certificate-%28HTTPS%29-Set-Up#registering-users-after-https-is-enabled)
- [How permissions determine web user access in 5.6](https://github.com/plan-player-analytics/Plan/wiki/Web-permissions)
- [How permissions determine web user access in 5.5](https://github.com/plan-player-analytics/Plan/wiki/SSL-Certificate-%28HTTPS%29-Set-Up#registering-users-after-https-is-enabled)
<details>
<summary>List of permissions for convenience</summary>
@ -66,6 +68,7 @@ Permission | Default (on spigot) | Description
- plan.register.other
- plan.unregister.self
- plan.unregister.other
- plan.setgroup.other
- plan.logout.other
- plan.info
- plan.reload
@ -180,6 +183,14 @@ The permissions are the same and all subcommands are available on all platforms.
> List registered Plan users
> Aliases `webusers, web`
### `/plan groups`
> **Permission**: `plan.setgroup.other`
> List Plan web groups
### `/plan setgroup [username] [groupname]`
> **Permission**: `plan.setgroup.other`
> Set a Plan user's web group.
### `/plan export [export kind]`
> **Permission**: `plan.export`
> Export some files
@ -222,3 +233,12 @@ The permissions are the same and all subcommands are available on all platforms.
### `/plan db uninstalled <server>`
> **Permission**: `plan.data.remove.server`
> Set a server as uninstalled in the current database (doesn't remove / delete the data to preserve existing data on player pages, but hides the server from viewed as /server or on network page)
### `/plan db remove_join_addresses`
> **Permission**: `plan.data.clear`
> Delete all join addresses of the server this is run on. Related to a Fabric data gathering bug.
### `/plan db migrate_to_online_uuids [--remove_offline]`
> **Permission**: `plan.data.clear`
> Moves and combines offline uuid data to online uuids where possible. If --remove_offline flag is given offline players without online UUIDs are also removed, otherwise they are kept as is.