From f6a9a32d455e8f76cee240536d30f0f4f0e3c7c1 Mon Sep 17 00:00:00 2001 From: rladenson Date: Thu, 5 Dec 2024 17:54:59 -0700 Subject: [PATCH] docs: add proxy switch add to docs --- docs/content/command-list.md | 2 +- docs/content/user-guide.md | 9 +++++++++ 2 files changed, 10 insertions(+), 1 deletion(-) diff --git a/docs/content/command-list.md b/docs/content/command-list.md index bc8178cb..17263733 100644 --- a/docs/content/command-list.md +++ b/docs/content/command-list.md @@ -148,7 +148,7 @@ You can have a space after `pk;`, e.g. `pk;system` and `pk; system` will do the - `pk;config split IDs [on|off]` - Toggles whether to display 6-letter IDs with a hyphen, to ease readability. - `pk;config capitalize IDs [on|off]` - Toggles whether to display IDs as capital letters, to ease readability. - `pk;config pad IDs [left|right|off]` - Toggles whether to pad (add a space) 5-character IDs in lists. -- `pk;config proxy switch [on|off]` - Toggles whether to log a switch whenever you proxy as a different member. +- `pk;config proxy switch [on|add|off]` - Toggles whether to log a switch whenever you proxy as a different member (or add member to recent switch in add mode). - `pk;config name format [format]` - Changes your system's username formatting. ## Server owner commands diff --git a/docs/content/user-guide.md b/docs/content/user-guide.md index 0f624dc8..cfa01980 100644 --- a/docs/content/user-guide.md +++ b/docs/content/user-guide.md @@ -548,6 +548,15 @@ To log a switch, use the `pk;switch` command with one or more members. For examp Note that the order of members are preserved (this is useful for indicating who's "more" at front, if applicable). If you want to specify a member with multiple words in their name, remember to encase the name in "double quotes". +### Automatic Switching +If you want PluralKit to automatically log a new switch whenever you [proxy](/guide/#proxying), you can tell it do so using the following command: + + pk;config proxy switch on + +Alternatively, if you want PluralKit to *add* the proxied member to the current switch instead of logging a new one, you can use this command: + + pk;config proxy switch add + ### Switching out If you want to log a switch with *no* members, you can log a switch-out as follows: