From 24ea11f69176db725353452039723f53f558d430 Mon Sep 17 00:00:00 2001 From: Ske Date: Fri, 26 Jul 2019 12:18:23 +0200 Subject: [PATCH] Add docs page for permission check command --- docs/5-tips-and-tricks.md | 14 +++++++++++++- 1 file changed, 13 insertions(+), 1 deletion(-) diff --git a/docs/5-tips-and-tricks.md b/docs/5-tips-and-tricks.md index 77983732..a0a4fe20 100644 --- a/docs/5-tips-and-tricks.md +++ b/docs/5-tips-and-tricks.md @@ -20,4 +20,16 @@ PluralKit has a couple of useful command shorthands to reduce the typing: |pk;member|pk;m| |pk;member new|pk;m n| |pk;switch|pk;sw| -|pk;message|pk;msg| \ No newline at end of file +|pk;message|pk;msg| + +## Permission checker command +If you're having issues with PluralKit not proxying, it may be an issue with your server's channel permission setup. +PluralKit needs the *Read Messages*, *Manage Messages* and *Manage Webhooks* permission to function. + +To quickly check if PluralKit is missing channel permissions, you can use the `pk;permcheck` command in the server +in question. It'll return a list of channels on the server with missing permissions. This may include channels +you don't want PluralKit to have access to for one reason or another (eg. admin channels). + +If you want to check permissions in DMs, you'll need to add a server ID, and run the command with that. +For example: `pk;permcheck 466707357099884544`. You can find this ID +[by enabling Developer Mode and right-clicking (or long-pressing) on the server icon](https://discordia.me/developer-mode). \ No newline at end of file