From 01c4e998761490b8c63b248058794fde92da449d Mon Sep 17 00:00:00 2001 From: Ske Date: Sat, 25 Jan 2020 16:21:52 +0100 Subject: [PATCH] Document autoproxy functionality --- docs/1-user-guide.md | 32 ++++++++++++++++++++++++++++++++ docs/2-command-list.md | 1 + docs/6-tips-and-tricks.md | 1 + 3 files changed, 34 insertions(+) diff --git a/docs/1-user-guide.md b/docs/1-user-guide.md index 956b464d..29731cd1 100644 --- a/docs/1-user-guide.md +++ b/docs/1-user-guide.md @@ -311,6 +311,38 @@ Since the messages will be posted by PluralKit's webhook, there's no way to dele To delete a PluralKit-proxied message, you can react to it with the ❌ emoji. Note that this only works if the message has been sent from your own account. +### Autoproxying +The bot's *autoproxy* feature allows you to have messages be proxied without directly including the proxy tags. Autoproxy can be set up in various ways. There are three autoproxy modes currently implemented: + +To see your system's current autoproxy settings, simply use the command: + pk;autoproxy + +To disable autoproxying for the current server, use the command: + pk;autoproxy off + +*(hint: `pk;autoproxy` can be shortened to `pk;ap` in all related commands)* + +#### Front mode +This autoproxy mode will proxy messages as the current *first* fronter of the system. If you register a switch with `Alice` and `Bob`, messages without proxy tags will be autoproxied as `Alice`. +To enable front-mode autoproxying for a given server, use the following command: + + pk;autoproxy front + +#### Latch mode +This autoproxy mode will essentially "continue" previous proxy tags. If you proxy a message with `Alice`'s proxy tags, messages posted afterwards will be proxied as Alice. Proxying again with someone else's proxy tags, say, `Bob`, will cause messages *from then on* to be proxied as Bob. +In other words, it means proxy tags become "sticky". This will carry over across all channels in the same server. + +To enable latch-mode autoproxying for a given server, use the following command: + + pk;autoproxy latch + +#### Member mode +This autoproxy mode will autoproxy for a specific selected member, irrelevant of past proxies or fronters. + +To enable member-mode autoproxying for a given server, use the following command, where `` is a member name (in "quotes" if multiple words) or 5-letter ID: + + pk;autoproxy + ## Managing switches PluralKit allows you to log member switches through the bot. Essentially, this means you can mark one or more members as *the current fronter(s)* for the duration until the next switch. diff --git a/docs/2-command-list.md b/docs/2-command-list.md index 8a2ac6d5..9ee20111 100644 --- a/docs/2-command-list.md +++ b/docs/2-command-list.md @@ -24,6 +24,7 @@ Words in \ are *required parameters*. Words in [square brackets] - `pk;system [id] frontpercent [timeframe]` - Shows the aggregated front history of a system within a given time frame. - `pk;system [id] list` - Shows a paginated list of a system's members. - `pk;system [id] list full` - Shows a paginated list of a system's members, with increased detail. +- `pk;autoproxy [off|front|latch|member]` - Updates the system's autoproxy settings for a given server. - `pk;link ` - Links this system to a different account. - `pk;unlink [account]` - Unlinks an account from this system. ## Member commands diff --git a/docs/6-tips-and-tricks.md b/docs/6-tips-and-tricks.md index a0a4fe20..8fe45976 100644 --- a/docs/6-tips-and-tricks.md +++ b/docs/6-tips-and-tricks.md @@ -21,6 +21,7 @@ PluralKit has a couple of useful command shorthands to reduce the typing: |pk;member new|pk;m n| |pk;switch|pk;sw| |pk;message|pk;msg| +|pk;autoproxy|pk;ap| ## Permission checker command If you're having issues with PluralKit not proxying, it may be an issue with your server's channel permission setup.