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

Add website documentation for servername

Browse Source
This commit is contained in:
Ske 2019-12-27 11:43:18 +01:00
parent 18dc1664db
commit 8e1b27e5fd
2 changed files with 10 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -161,7 +161,7 @@ If you want to change the name of a member, you can use the `pk;member rename` c
pk;member "Craig Smith" rename "Craig Johnson"
### Member display names
Normally, when proxying a member, the name displayed in the proxied message will the the member's name. However, in some cases
Normally, when proxying a member, the name displayed in the proxied message will be the member's name. However, in some cases
you may want to display a different name. For example, you may want to include a member's pronouns inside the proxied name,
indicate a subsystem, include emojis or symbols that don't play nice with the command syntax, or just in general show a different name from the member's "canonical" name.
@ -177,6 +177,14 @@ To remove a display name, just use the same command with no last parameter, eg:
This will remove the display name, and thus the member will be proxied with their canonical name.
### Member server display names
If you'd like to set a display name (as above), but only for a specific server, you can set the member's *server display name*.
This functions just like global display names, but only in the same server you set them in. For example:
pk;member John servername AdminJohn
The server name applies to the same server you run the command in, so naturally this command doesn't function in DMs (as you cannot proxy in DMs).
### Member description
In the same way as a system can have a description, so can a member. You can set a description using the `pk;member description` command, like so:

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

@ -31,6 +31,7 @@ Words in \<angle brackets> are *required parameters*. Words in [square brackets]
- `pk;member new <name>` - Creates a new system member.
- `pk;member <name> rename <new name>` - Changes the name of a member.
- `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> proxy [tags]` - Changes the proxy tags of a member. use below add/remove commands for members with multiple tag pairs.