diff --git a/docs/source/Concepts/Internationalization.md b/docs/source/Concepts/Internationalization.md index 1db1753dd2..733d28dd86 100644 --- a/docs/source/Concepts/Internationalization.md +++ b/docs/source/Concepts/Internationalization.md @@ -17,7 +17,7 @@ updated after May 2021 will be missing some translations. +===============+======================+==============+ | es | Spanish | Aug 2019 | +---------------+----------------------+--------------+ -| fr | French | Nov 2018 | +| fr | French | Mar 2022 | +---------------+----------------------+--------------+ | it | Italian | Feb 2015 | +---------------+----------------------+--------------+ diff --git a/evennia/comms/comms.py b/evennia/comms/comms.py index 990cd2b5ee..31e36a2279 100644 --- a/evennia/comms/comms.py +++ b/evennia/comms/comms.py @@ -19,15 +19,33 @@ class DefaultChannel(ChannelDB, metaclass=TypeclassBase): create different types of communication channels. Class-level variables: - - `send_to_online_only` (bool, default True) - if set, will only try to - send to subscribers that are actually active. This is a useful optimization. - - `log_file` (str, default `"channel_{channelname}.log"`). This is the - log file to which the channel history will be saved. The `{channelname}` tag - will be replaced by the key of the Channel. If an Attribute 'log_file' - is set, this will be used instead. If this is None and no Attribute is found, - no history will be saved. - - `channel_prefix_string` (str, default `"[{channelname} ]"`) - this is used - as a simple template to get the channel prefix with `.channel_prefix()`. + - `send_to_online_only` (bool, default True) - if set, will only try to + send to subscribers that are actually active. This is a useful optimization. + - `log_file` (str, default `"channel_{channelname}.log"`). This is the + log file to which the channel history will be saved. The `{channelname}` tag + will be replaced by the key of the Channel. If an Attribute 'log_file' + is set, this will be used instead. If this is None and no Attribute is found, + no history will be saved. + - `channel_prefix_string` (str, default `"[{channelname} ]"`) - this is used + as a simple template to get the channel prefix with `.channel_prefix()`. It is used + in front of every channel message; use `{channelmessage}` token to insert the + name of the current channel. Set to `None` if you want no prefix (or want to + handle it in a hook during message generation instead. + - `channel_msg_nick_pattern`(str, default `"{alias}\\s*?|{alias}\\s+?(?P.+?)") - + this is what used when a channel subscriber gets a channel nick assigned to this + channel. The nickhandler uses the pattern to pick out this channel's name from user + input. The `{alias}` token will get both the channel's key and any set/custom aliases + per subscriber. You need to allow for an `` regex group to catch any message + that should be send to the channel. You usually don't need to change this pattern + unless you are changing channel command-style entirely. + - `channel_msg_nick_replacement` (str, default `"channel {channelname} = $1"` - this + is used by the nickhandler to generate a replacement string once the nickhandler (using + the `channel_msg_nick_pattern`) identifies that the channel should be addressed + to send a message to it. The `` regex pattern match from `channel_msg_nick_pattern` + will end up at the `$1` position in the replacement. Together, this allows you do e.g. + 'public Hello' and have that become a mapping to `channel public = Hello`. By default, + the account-level `channel` command is used. If you were to rename that command you must + tweak the output to something like `yourchannelcommandname {channelname} = $1`. """