diff --git a/docs/advanced-relay-config.md b/docs/advanced-relay-config.md index dc641e7..343c5bb 100644 --- a/docs/advanced-relay-config.md +++ b/docs/advanced-relay-config.md @@ -14,7 +14,9 @@ a: ### Custom Clientbot Styles -Custom Clientbot styles can be applied for any of Clientbot's supported events, by defining keys in the format `relay::clientbot_styles::`. See below for a list of supported events and their default values (as of 1.3-beta1). +Custom Clientbot styles can be applied for any of Clientbot's supported events, by defining keys in the format `relay::clientbot_styles::`. See below for a list of supported events and their default values (as of 1.3.0). + +A common use case for this feature is to turn off or adjust colors/formatting; this is explicitly documented [below](#disabling-colorscontrol-codes). These options take template strings as documented here: https://docs.python.org/3/library/string.html#template-strings. Supported substitution values differ by event, but usually include the [hook values for each](technical/hooks-reference.md#irc-command-hooks), *plus* the following: @@ -35,8 +37,6 @@ These options take template strings as documented here: https://docs.python.org/ To disable relaying for any specific event, set the template string to an empty string (`''`). -To disable colors for events, see [below](#disabling-colorscontrol-codes). - #### List of supported events |Event name|Default value| @@ -63,7 +63,7 @@ If you don't want the messages PyLink sends for clientbot messages to be embolde remove all escape sequences (e.g. `\x02`) from the format template and replace the colored variants of applicable substitutions with their non-colored versions. -This is a example clientbot_styles config block, which you can copy into your `relay` configuration block. +This is a example clientbot_styles config block, which you can copy *into* your `relay` configuration block. (*Do not* make multiple `relay` config blocks, or duplicate any config blocks with the same name!) ```yaml diff --git a/docs/faq.md b/docs/faq.md index ade697e..e9991d4 100644 --- a/docs/faq.md +++ b/docs/faq.md @@ -86,6 +86,9 @@ However, if the nick mentioned is legal on IRC, this issue is likely caused by a Load the `relay_clientbot` plugin. https://github.com/GLolol/PyLink/blob/e1fab8c/example-conf.yml#L303-L306 +### How do I turn off colors in Clientbot? +See https://github.com/GLolol/PyLink/blob/master/docs/advanced-relay-config.md#custom-clientbot-styles, especially the section "Disabling Colors/Control Codes". + ### Relay is occasionally dropping users from channels! This usually indicates a serious bug in either Relay or PyLink's protocol modules, and should be reported as an issue. When asking for help, please state which IRCds your PyLink instance is linking to: specifically, which IRCd the missing users are *from* and which IRCd the users are missing *on*. Also, be prepared to send debug logs as you reproduce the issue!