liz/PluralKit
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Add avatar preview with no arguments

Browse Source
This commit is contained in:
Ske
2019-12-28 12:23:52 +01:00
parent 30c0fc9b43
commit 468241c92f
4 changed files with 39 additions and 13 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
docs/1-user-guide.md
View File

@@ -208,9 +208,13 @@ To clear a member color, use the command with no color code argument (eg. `pk;me
If you want your member to have an associated avatar to display on the member information card and on proxied messages, you can set the member avatar. To do so, use the `pk;member avatar` command. You can either supply it with an direct URL to an image, or attach an image directly. For example.
pk;member John avatar http://placebeard.it/512.jpg
pk;member "Craig Johnson" avatar [with attached image]
pk;member "Craig Johnson" avatar (with an attached image)
To clear your avatar, simply use the command with no attachment or link (eg. `pk;member John avatar`).
To preview the current avatar (if one is set), use the command with no arguments:
pk;member John avatar
To clear your avatar, use the subcommand `avatar clear` (eg. `pk;member John avatar clear`).
### Member pronouns
If you want to list a member's preferred pronouns, you can use the pronouns field on a member profile. This is a free text field, so you can put whatever you'd like in there (with a 100 character limit), like so:

2
docs/2-command-list.md
View File

@@ -33,7 +33,7 @@ Words in \<angle brackets> are *required parameters*. Words in [square brackets]
- `pk;member <name> displayname <new display name>` - Changes the display name of a member.
- `pk;member <name> servername <new server name>` - Changes the display name of a member, only in the current serve.
- `pk;member <name> description [description]` - Changes the description of a member.
- `pk;member <name> avatar [avatar url]` - Changes the avatar of a member.
- `pk;member <name> avatar <avatar url|@mention|clear>` - Changes the avatar of a member.
- `pk;member <name> proxy [tags]` - Changes the proxy tags of a member. use below add/remove commands for members with multiple tag pairs.
- `pk;member <name> proxy add [tags]` - Adds a proxy tag pair to a member.
- `pk;member <name> proxy remove [tags]` - Removes a proxy tag from a member.