eightball/PluralKit
1
0
Fork 0
mirror of https://github.com/PluralKit/PluralKit.git synced 2026-02-04 13:06:50 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 1

Add documentation for keepproxy feature

Browse source
This commit is contained in:
Ske 2019-10-30 13:59:22 +01:00
parent 49dc25ee02
commit 9211ce0e7f
3 changed files with 14 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

13
docs/1-user-guide.md
View file

@ -266,7 +266,18 @@ To add a proxy tag to a member, use the `pk;member proxy add` command:
To remove a proxy tag from a member, use the `pk;member proxy remove` command:
pk;member John proxy remove {text}
pk;member Craig proxy remove C:text
### Keeping your proxy tags
If you'd like your proxied messages to include the proxy tags, you can enable the "keep proxy tags" option for a given member, like so:
pk;member John keepproxy on
Turning the option off is similar - replace "on" with "off" in the command. The default value for every member is off. When proxying
a member with multiple proxy tags, the proxy tag used to trigger a given proxy will be included.
The practical effect of this is:
* **Keep proxy tags on:** `[Message goes here]` -> [Message goes here]
* **Keep proxy tags off:** `[Message goes here]` -> Message goes here
### Querying message information
If you want information about a proxied message (eg. for moderation reasons), you can query the message for its sender account, system, member, etc.