Skip to content

Features

Chat

Chat format with rank and tag, mute and slow mode, world-based filters, network staff and admin channels, and mentions with sound.

The chat module is configured in chat.yml and reloaded with /sofycore module chat reload. Public chat is local to each server.

Format

chat.ymlYAML
format:
  enabled: true

The template is messages.chat-format in the language file:

lang/en.ymlYAML
chat-format: '{prefix}{name_color}{player}{suffix}&8: &f{message}'
TokenValue
{player}Real nickname
{rank}Label of the visible rank
{prefix}, {suffix}, {name_color}Appearance of the visible rank
{world}Sender's world
{message}Player's text (required)

PlaceholderAPI placeholders in the template are expanded when installed. The player's own text never runs & codes or placeholders. With format.enabled: false, mute, slow mode and filters keep working.

Mute and slow mode

/chat mute blocks the public chat of the server and /chat slow <seconds> sets a minimum delay between messages. Each has its own permission, which is also its bypass.

Filters

chat.ymlYAML
filters:
  enabled: true
  worlds:
    mode: ALL        # ALL, INCLUDE or EXCLUDE
    names: []
  ip-addresses: true
  links:
    enabled: true
    allowed-domains:
      - example.com
      - '*.example.com'
    allowed-urls:
      - 'https://other.example/Rules'
  words:
    enabled: true
    blocked-phrases:
      - 'forbidden-word'

Filters detect IPv4/IPv6 literals, http/https addresses, www and visible domains. Words and phrases are whole, case-insensitive literals. A blocked message is not delivered; only its author receives a notice. sofycore.chat.filter.bypass skips all filters.

Staff and admin channels

Always network-wide through Redis. Use /staffchat <message> or start a message with !; use /adminchat <message> or start with @. /staffchat or /adminchat without text toggles the channel, and /chat channel <general|staff|admin> selects it. The selection is reset on quit, restart or reload.

Mentions

Writing a player's full name in public chat plays a sound for them (once per message, with a cooldown). Players turn it off with /mentions off.