Beerchat

Beerchat

Standalone chat channel mod

Features

• Chat channels
• Whispering ($ hello there)
• Shortcommands (#channel hello @player hello)
• Optionally protected chat channels
• Message cleanup tools like control code and Discord custom emoji tag cleaner
• Moderation tools like channel banning and restricting chat features
• Matterbridge-integration (IRC/Discord/matrix/etc)

Selectable components

• mute is enabled by default. Allows players to mute other players.
• me is enabled by default. Allows sending special formatted "/me message here" messages to channel.
• hash is enabled by default. Allows switching channels with "#channelname" and sending to channel with "#channelname message here".
• pm is enabled by default. Allows "@player message here" to send private messages to players.
• whisper is enabled by default. Allows "$ message here" to send message to nearby players.
• jail is disabled by default. Adds "/chat_jail playername" and "/chat_unjail playername" commands.
• ban is disabled by default. Adds "/channel_ban [#channel] playername" and "/channel_unban [#channel] playername" commands.
• remote_mute is disabled by default. Allow muting remote users.
• cleaner is disabled by default. Removes control characters from incoming messages.
• override is enabled by default. Overrides for message handlers provided by other mods.
• colorize is enabled by default. Allows colorizing messages on specified channels.
• announce is disabled by default. Set server wide announcements.
• force2channel is enabled by default. Adds command "/force2channel channel,player".
• password is enabled by default. Adds complaints for bad password (default or empty).
• event-logging is enabled by default. Adds logging and info messages for certain events.
• alias is disabled by default. Allows linking channels through channel aliases.

To enable or disable components use beerchat.enable_<name> in Minetest configuration file. For example to enable server wide announcement feature and disable whispering you should add following to the Minetest configuration file:

beerchat.enable_announce = true
beerchat.enable_whisper = false

Some of the selectable features either require or can use more configuration options, unfortunately many of these are currently undocumented but fortunately most are found from top of the said feature source code file. All of these source files are within plugin directory.

Using selectable features

Whisper, in addition to what is in short description, also allows setting range with $10 hello there! so only players closer than 10 nodes will see messages. Default is 32 nodes, maximum is 200 nodes. Additionally you can toggle whisper mode with preset range by using dollar-range command without any message, for example $10 to activate whisper mode with 10 node range. When in whisper mode you do not need to use any commands or dollar sign to whisper, every message you send is automatically whispered. To return back to normal chat mode, use dollar without range or message, for example $.

Jail default channel name is grounded. Jailing locks players to that channel and disallows channel switching, channel joining, private messages, whispering. Jailed players can only talk publicly in jail channel. Unjailing removes these restrictions, removes player from jail channel and returns player to to their original channel. Normally anyone can join jail channel if they want but joining can be restricted with password. Forcing player out of the jail channel with force2channel will also remove jail restrictions from target player.

More documentation

Some of the commands added through selectable features have usable documentation included in game, this is available with built in /help command. For example /help server-announce will display basic information on how to use that command and is often enough to efficiently use said command. On the other hand we have to admit that there is more features than what is documented, to find these either read the code or if you know what you want you can very well come ask if feature you are looking for is hidden under the hood.

Some incomplete documentation and installation instructions for extended use are available here: https://github.com/mt-mods/beerchat/