Expand on documentation aimed at server staff
This commit is contained in:
43
docs/content/staff/compatibility.md
Normal file
43
docs/content/staff/compatibility.md
Normal file
@@ -0,0 +1,43 @@
|
||||
# Compatibility with other bots
|
||||
Many servers use *logger bots* for keeping track of edited and deleted messages, nickname changes, and other server events.
|
||||
Because PluralKit deletes messages as part of proxying, this can often clutter up these logs.
|
||||
|
||||
## Bots with PluralKit support
|
||||
Some logger bots have offical PluralKit support, and properly handle excluding proxy deletes, as well as add PK-specific information to relevant log messages:
|
||||
|
||||
- [**Gabby Gums**](https://github.com/amadea-system/GabbyGums)
|
||||
|
||||
If your server uses an in-house bot for logging, you can use [the API](../api-documentation.md) to implement support yourself.
|
||||
|
||||
## Log cleanup
|
||||
Another solution is for PluralKit to automatically delete log messages from other bots when they get posted.
|
||||
PluralKit supports this through the **log cleanup** feature. To enable it, use the following command:
|
||||
|
||||
pk;logclean on
|
||||
|
||||
This requires you to have the *Manage Server* permission on the server.
|
||||
|
||||
### Supported bots
|
||||
At the moment, log cleanup works with the following bots:
|
||||
- [Auttaja](https://auttaja.io/) (precise)
|
||||
- [blargbot](https://blargbot.xyz/) (precise)
|
||||
- [Carl-bot](https://carl.gg/) (fuzzy)
|
||||
- [Circle](https://circlebot.xyz/) (fuzzy)
|
||||
- [Dyno](https://dyno.gg/) (precise)
|
||||
- [GearBot](https://gearbot.rocks/) (fuzzy)
|
||||
- [GenericBot](https://github.com/galenguyer/GenericBot) (precise)
|
||||
- [Logger#6088](https://logger.bot/) (precise)
|
||||
- [Logger#6278](https://loggerbot.chat/) (precise)
|
||||
- [Mantaro](https://mantaro.site/) (precise)
|
||||
- [Pancake](https://pancake.gg/) (fuzzy)
|
||||
- [SafetyAtLast](https://www.safetyatlast.net/) (fuzzy)
|
||||
- [UnbelievaBoat](https://unbelievaboat.com/) (precise)
|
||||
- Vanessa (fuzzy)
|
||||
|
||||
::: warning
|
||||
In most cases, PluralKit will match log messages by the ID of the deleted message itself. However, some bots (marked with *(fuzzy)* above) don't include this in their logs. In this case, PluralKit will attempt to match based on other parameters, but there may be false positives.
|
||||
|
||||
**For best results, use a bot marked *(precise)* in the above list.**
|
||||
:::
|
||||
|
||||
If you want support for another logging bot, [let me know on the support server](https://discord.gg/PczBt78).
|
9
docs/content/staff/disabling.md
Normal file
9
docs/content/staff/disabling.md
Normal file
@@ -0,0 +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
|
||||
|
||||
This requires you to have the *Manage Server* permission on the server.
|
18
docs/content/staff/logging.md
Normal file
18
docs/content/staff/logging.md
Normal file
@@ -0,0 +1,18 @@
|
||||
# Proxy logging
|
||||
If you want to log every proxied message to a separate channel for moderation purposes, you can use the `pk;log` command with the channel name.For example:
|
||||
|
||||
pk;log #proxy-log
|
||||
|
||||
This requires you to have the *Manage Server* permission on the server. To disable logging, use the `pk;log` command with no channel name.
|
||||
|
||||
Log messages have the following format:
|
||||
|
||||

|
||||
|
||||
## Blacklisting channels from logging
|
||||
Depending on your server setup, you may want to exclude some messages from logging. For example, if you have public proxy logs, you may want to exclude staff-only channels.
|
||||
|
||||
To manage logging in a channel, use the following commands:
|
||||
|
||||
pk;log disable #some-secret-channel
|
||||
pk;log enable #some-secret-channel
|
34
docs/content/staff/moderation.md
Normal file
34
docs/content/staff/moderation.md
Normal file
@@ -0,0 +1,34 @@
|
||||
# Moderation tools
|
||||
Since PluralKit proxies work by deleting and reposting messages through webhooks, some of Discord's standard moderation tools won't function.
|
||||
|
||||
Specifically, you can't kick or ban individual members of a system; all moderation actions have to be taken on the concrete Discord account.
|
||||
|
||||
## Identifying users
|
||||
You can use PluralKit's lookup tools to connect a message to the sender account. This allows you to use standard moderation tools on that account (kicking, banning, using other moderation tools, etc).
|
||||
|
||||
### Querying messages
|
||||
To look up which account's behind a given message (as well as other information), you can either:
|
||||
|
||||
- React to the message with the :question: emoji, which will DM you a message card
|
||||
- Use the `pk;msg <message-link>` command with the message's link, which will reply with a message card *(this also works in PluralKit's DMs)*
|
||||
|
||||
An example of a message card is seen below:
|
||||
|
||||

|
||||
|
||||
### Looking up systems and accounts
|
||||
Looking up a system by its 5-character ID (`exmpl` in the above screenshot) will show you a list of its linked account IDs. For example:
|
||||
|
||||
pk;system exmpl
|
||||
|
||||
You can also do the reverse operation by passing a Discord account ID (or a @mention), like so:
|
||||
|
||||
pk;system 466378653216014359
|
||||
|
||||
Both commands output a system card, which includes a linked account list. These commands also work in PluralKit's DMs.
|
||||
|
||||
### System tags
|
||||
A common rule on servers with PluralKit is to enforce system tags. System tags are a little snippet of text, a symbol, an emoji, etc, that's added to the webhook name of every message proxied by a system. A system tag will allow you to identify members that share a system at a glance. Note that this isn't enforced by the bot; this is simply a suggestion for a helpful server policy :slightly_smiling_face:
|
||||
|
||||
## Blocking users
|
||||
It's not possible to block specific PluralKit users. Discord webhooks don't count as 'real accounts', so there's no way to block them. PluralKit also can't control who gets to see a message, so there's also no way to implement user blocking on the bot's end. Sorry. :slightly_frowning_face:
|
31
docs/content/staff/permissions.md
Normal file
31
docs/content/staff/permissions.md
Normal file
@@ -0,0 +1,31 @@
|
||||
# Roles and permissions
|
||||
|
||||
PluralKit requires some channel permissions in order to function properly:
|
||||
|
||||
- Message proxying requires the **Manage Messages** and **Manage Webhooks** permissions in a channel.
|
||||
- Most commands require the **Embed Links**, **Attach Files** and **Add Reactions** permissions to function properly.
|
||||
- Commands with reaction menus also require **Manage Messages** to remove reactions after clicking.
|
||||
- [Proxy logging](./logging.md) requires the **Send Messages** permission in the log channel.
|
||||
- [Log cleanup](./compatibility.md#log-cleanup) requires the **Manage Messages** permission in the log channels.
|
||||
|
||||
Denying the **Send Messages** permission will *not* stop the bot from proxying, although it will prevent it from sending command responses. Denying the **Read Messages** permission will, as any other bot, prevent the bot from interacting in that channel at all.
|
||||
|
||||
## Webhook permissions
|
||||
Webhooks exist outside of the normal Discord permissions system, and (with a few exceptions) it's not possible to modify their permissions.
|
||||
|
||||
However, PluralKit will make an attempt to apply the sender account's permissions to proxied messages. For example, role mentions, `@everyone`, and `@here`
|
||||
will only function if the sender account has that permission. The same applies to link embeds.
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
### Permission checker command
|
||||
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).
|
Reference in New Issue
Block a user