eightball/PluralKit
1
0
Fork 0
mirror of https://github.com/PluralKit/PluralKit.git synced 2026-02-04 04:56:49 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 1

feat: update server staff docs

Browse source
This commit is contained in:
alyssa 2024-11-12 05:22:27 +09:00
parent a0b528d4af
commit 10d45d3a1a
4 changed files with 10 additions and 10 deletions
Download patch file Download diff file Expand all files Collapse all files

2
docs/content/faq.md
View file

@ -76,7 +76,7 @@ No. This is a limitation in Discord itself, and cannot be changed. The color com
### Why can't I use nitro emoji in some channels?
* PluralKit must have the "Use External Emoji" permission to be able to use nitro emojis with the bot.
If it still doesn't work, make sure this permission isn't denied in channel overrides (found in channel settings -> permissions). You can also check if it's a permissions issue with `pk;permcheck`.
If it still doesn't work, make sure this permission isn't denied in channel overrides (found in channel settings -> permissions). You can also check if it's a permissions issue with `pk;debug permissions`.
* PluralKit must be in the server the emojis are from. This is because of a change made by Discord in 2022.
* Because PluralKit cannot be a Twitch subscriber, it will never be able to use emojis from Twitch integrations.

8
docs/content/staff/disabling.md
View file

@ -1,9 +1,9 @@
# Disabling proxying in a channel
It's possible to block a channel from being used for proxying. To do so, use the `pk;blacklist` command. For example:
pk;blacklist add #admin-channel #mod-channel #welcome
pk;blacklist add all
pk;blacklist remove #general-two
pk;blacklist remove all
pk;serverconfig blacklist add #admin-channel #mod-channel #welcome
pk;serverconfig blacklist add all
pk;serverconfig blacklist remove #general-two
pk;serverconfig blacklist remove all
This requires you to have the *Manage Server* permission on the server.

6
docs/content/staff/logging.md
View file

@ -1,7 +1,7 @@
# Proxy logging
If you want to log every proxied message to a separate channel for moderation purposes, you can use the `pk;log channel` command with the channel name.For example:
pk;log channel #proxy-log
pk;serverconfig log channel #proxy-log
This requires you to have the *Manage Server* permission on the server. To disable logging, use the `pk;log channel` command with the `-clear` flag as the channel name.
@ -14,5 +14,5 @@ Depending on your server setup, you may want to exclude some messages from loggi
To manage logging in a channel, use the following commands:
pk;log disable #some-secret-channel
pk;log enable #some-secret-channel
pk;serverconfig log blacklist add #some-secret-channel
pk;serverconfig log blacklist remove #some-secret-channel

4
docs/content/staff/permissions.md
View file

@ -21,13 +21,13 @@ For external emojis to work in proxied messages, the `@everyone` role must have
## Troubleshooting
### Permission checker command
To quickly check if PluralKit is missing channel permissions, you can use the `pk;permcheck` command in the server
To quickly check if PluralKit is missing channel permissions, you can use the `pk;debug permissions` 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
pk;debug permissions 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).