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

Update user-guide.md

Browse source 
- added proxy tags to the list of member privacy fields (and the fact that "proxy tags" doesn't work while "proxy" or "tag" do)
- also added note to import/export section about Mobile users aim for the links bc Discord tends to break the json file

Note: Proxy still needs to be added to the list of subjects in the privacy command usage error (command usage: pk;m <m> privacy <list of subjects*> <pub|priv> )
This commit is contained in:
multimasks 2024-05-29 09:59:11 -04:00 • committed by GitHub
parent d57dfc96bc
commit c5fa0d24f2
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 3 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

4
docs/content/user-guide.md
View file

@ -712,6 +712,7 @@ There are also some options for configuring member privacy:
- Pronouns - Pronouns
- Metadata *(message count, creation date, last message timestamp, etc)* - Metadata *(message count, creation date, last message timestamp, etc)*
- Visibility *(whether the member shows up in member lists)* - Visibility *(whether the member shows up in member lists)*
- Proxy tags
As with system privacy, each can be set to **public** or **private**. The same rules apply for how they are shown, too. When set to **public**, anyone who queries your system (by account or system ID, or through the API), will see this information. When set to **private**, the information will only be shown when *you yourself* query the information. The cards will still be displayed in the channel the commands are run in, so it's still your responsibility not to pull up information in servers where you don't want it displayed. As with system privacy, each can be set to **public** or **private**. The same rules apply for how they are shown, too. When set to **public**, anyone who queries your system (by account or system ID, or through the API), will see this information. When set to **private**, the information will only be shown when *you yourself* query the information. The cards will still be displayed in the channel the commands are run in, so it's still your responsibility not to pull up information in servers where you don't want it displayed.
@ -731,6 +732,7 @@ To update a member's privacy, you can use the command:
* `pronouns` * `pronouns`
* `metadata` * `metadata`
* `visiblity` * `visiblity`
* `proxy` or `tag` (*not* `proxy tag`)
* `all` (to change all subjects at once) * `all` (to change all subjects at once)
* `level` is either `public` or `private` * `level` is either `public` or `private`
@ -743,7 +745,7 @@ For example:
pk;member Skyler privacy all private pk;member Skyler privacy all private
## Importing and exporting data ## Importing and exporting data
If you're a user of another proxy bot (e.g. Tupperbox), or you want to import a saved system backup, you can use the importing and exporting commands. If you're a user of another proxy bot (e.g. Tupperbox), or you want to import a saved system backup, you can use the importing and exporting commands. Note, if you are on a mobile device, please aim to use the links - using the .json file from either bot is questionable as Discord tends to break the file on download/upload.
### Importing from Tupperbox ### Importing from Tupperbox
If you're a user of the *other proxying bot* Tupperbox, you can import system and member information from there. This is a fairly simple process: If you're a user of the *other proxying bot* Tupperbox, you can import system and member information from there. This is a fairly simple process: