PluralKit/docs/content/staff/compatibility.md

52 lines
2.8 KiB
Markdown
Raw Permalink Normal View History

# 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
2023-03-20 01:11:35 +00:00
Some moderation bots have official PluralKit support, and properly handle excluding proxy deletes, as well as add PK-specific information to relevant log messages:
- [**Catalogger**](https://catalogger.starshines.xyz/docs)
- [**Aero**](https://aero.bot/)
- [**CoreBot**](https://discord.gg/GAAj6DDrCJ)
2021-12-07 07:42:22 +00:00
If your server uses an in-house bot for logging, you can use [the API](/api) 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/) (precise)
- [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)
2021-07-27 14:36:02 +00:00
- [Vortex](https://github.com/jagrosh/Vortex/wiki) (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).
## Chat filter bots
If PluralKit detects that a proxy trigger message has already been deleted when it attempts to delete it itself, it'll also delete the trigger message. This ensures compatibility in *most* cases with moderation bots that filter messages (eg. swear words, links, invites, etc). The bot will delete the original trigger message, and then PluralKit will clean up the proxied message as well.
Due to the timing aspect, this may not work 100% of the time, especially if there's server lag involved, but it's hopefully good enough.