diff --git a/docs/1-user-guide.md b/docs/1-user-guide.md index c9ca3963..006e5fbb 100644 --- a/docs/1-user-guide.md +++ b/docs/1-user-guide.md @@ -159,6 +159,23 @@ If you want to change the name of a member, you can use the `pk;member rename` c pk;member John rename Joanne 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 +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. + +In such cases you can set the member's *display name*. Which will, well, display that name instead. You can set +a display name using the `pk;member displayname` command, like so: + + pk;member John displayname Jonathan + pk;member Robert displayname Bob (he/him) + +To remove a display name, just use the same command with no last parameter, eg: + + pk;member John displayname + +This will remove the display name, and thus the member will be proxied with their canonical name. + ### 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: diff --git a/docs/2-command-list.md b/docs/2-command-list.md index 72bc9897..14b61656 100644 --- a/docs/2-command-list.md +++ b/docs/2-command-list.md @@ -28,7 +28,8 @@ Words in \ are *required parameters*. Words in [square brackets] - `pk;member ` - Shows information about a member. - `pk;member new ` - Creates a new system member. - `pk;member rename ` - Changes the name of a member. -- `pk;member description [description` - Changes the description of a member. +- `pk;member displayname ` - Changes the display name of a member. +- `pk;member description [description]` - Changes the description of a member. - `pk;member avatar [avatar url]` - Changes the avatar of a member. - `pk;member proxy [tags]` - Changes the proxy tags of a member. - `pk;member pronouns [pronouns]` - Changes the pronouns of a member.