From cef84493ffaeacdab916c74105be77c1312e9afb Mon Sep 17 00:00:00 2001 From: Tulir Asokan Date: Tue, 31 May 2022 00:34:33 +0300 Subject: [PATCH] Document displayname_template variables and remove the suffix by default --- example-config.yaml | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/example-config.yaml b/example-config.yaml index fa95737..508801e 100644 --- a/example-config.yaml +++ b/example-config.yaml @@ -69,8 +69,13 @@ bridge: # {{.}} is replaced with the internal ID of the Discord user. username_template: discord_{{.}} # Displayname template for Discord users. - # TODO: document variables - displayname_template: '{{.Username}}#{{.Discriminator}} (D){{if .Bot}} (bot){{end}}' + # Available fields: + # .ID - Internal user ID + # .Username - User's displayname on Discord + # .Discriminator - The 4 numbers after the name on Discord + # .Bot - Whether the user is a bot + # .System - Whether the user is an official system user + displayname_template: '{{.Username}}#{{.Discriminator}} {{if .Bot}} (bot){{end}}' channelname_template: '{{if .Guild}}{{.Guild}} - {{end}}{{if .Folder}}{{.Folder}} - {{end}}{{.Name}} (D)' portal_message_buffer: 128