From 68b439257d50c1399cb4d793632def6b3ae37c3f Mon Sep 17 00:00:00 2001 From: spiral Date: Fri, 20 Nov 2020 20:26:34 -0500 Subject: [PATCH] Tweak documentation --- PluralKit.Bot/Commands/Autoproxy.cs | 1 + docs/content/user-guide.md | 25 +++++++++++++++---------- 2 files changed, 16 insertions(+), 10 deletions(-) diff --git a/PluralKit.Bot/Commands/Autoproxy.cs b/PluralKit.Bot/Commands/Autoproxy.cs index c548c82d..a77252e3 100644 --- a/PluralKit.Bot/Commands/Autoproxy.cs +++ b/PluralKit.Bot/Commands/Autoproxy.cs @@ -174,6 +174,7 @@ namespace PluralKit.Bot private async Task AutoproxyAccount(Context ctx) { + // todo: this might be useful elsewhere, consider moving it to ctx.MatchToggle if (ctx.Match("enable", "on")) await AutoproxyEnableDisable(ctx, true); else if (ctx.Match("disable", "off")) diff --git a/docs/content/user-guide.md b/docs/content/user-guide.md index f7d7240b..313652f5 100644 --- a/docs/content/user-guide.md +++ b/docs/content/user-guide.md @@ -315,17 +315,23 @@ 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 :x: emoji. Note that this only works if the message has been sent from your own account. -### Autoproxying +## Autoproxy 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)* +::: tip +To disable autoproxy for a single message, add a backslash (`\`) to the beginning of your message. +::: + #### 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: @@ -340,7 +346,14 @@ To enable latch-mode autoproxying for a given server, use the following command: pk;autoproxy latch -::: tip +#### 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 + +### Changing the latch timeout duration By default, latch mode times out after 6 hours. It is possible to change this: pk;autoproxy timeout @@ -352,14 +365,6 @@ To reset the duration, use the following command: To disable timeout (never timeout), use the following command: pk;autoproxy timeout disable -::: - -#### 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 ### Disabling front/latch autoproxy on a per-member basis If a system uses front or latch mode autoproxy, but one member prefers to send messages through the account (and not proxy), you can disable the front and latch modes for that specific member.