LuckPerms/wiki

Mention `/lp verbose command` in command list

Andre601 opened this issue · 2 comments

The General commands page currently only lists the /lp verbose command options on, off, record and upload and leaves out the command option completely.

The only place this command is mentioned in is the Verbose page, which not everyone would check. So for transparency reasons should it imo be listed, tho it could become a bit overloaded/bloated, which is why I personally first want to discuss this here before making a proper PR.

My current Idea:

#### `/lp verbose <on|record|off|upload|command> [filter|<me|player> <command>]`  
**Permission**: luckperms.verbose  
**Arguments**:  
* `<on|record|off|upload|command>` - whether to enable/disable logging, or to upload the logged output, or to perform checks on a command
* `[filter|<me|player> <command>]` - the filter to sort the output, or the player and command to use verbose on when the `command` argument is used

Controls the LuckPerms verbose logging system. This allows you to listen for all permission checks against players on the server. Whenever a permission is checked by a plugin, the check is passed onto the verbose handler.    

If your filters match the permission check, you will be notified.    

`on` will enable the system, and will send you an alert in chat when the filter is matched. `record` will do the same, however you will not be notified of checks in the chat. `off` will simply disable the checking, and `upload` will upload the first results to the web viewer, and provide you with a link. `command` will allow you to execute a command as the specified player and return any permission checks.    

Filters match the start of permissions or the user being checked. You can use `&` (and) and `|` (or) symbols, and `!` to negate a match. Parenthesis `( )` are also supported.   

**For example:**    
* `Luck & (essentials | worldedit)` - matches any checks made against my user starting with "essentials" or "worldedit"
* `!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)

That sounds like a good idea to me! Sorry it's taken so long to get back to you. If you're still around and want to PR this change, it will be accepted. If not, we can add it in ourselves. Up to you!

I'll work on a PR in a few hours.