Chat Manager

A plugin for Unturned servers that enhances chat appearance with customizable colors, icons, and text formatting.

Features

• Server Customization:

  • Change default server message color for ALL plugin messages
  • Set custom server icon
  • Enable rich text formatting for ALL plugin translations and messages
  • Create text replacements (useful for XML compatibility)

• Player Customization:

  • Change default player message color
  • Set custom player icons
  • Enable rich text formatting for player messages

• Chat Formatting:

  • Customize chat message structure
  • Display player group prefixes and suffixes with colors
  • Add special indicators for different chat modes (Global, Area, Group)
  • Show multiple prefixes/suffixes from permission groups

Configuration Options

Server and Player Appearance

• EnableDefaultServerColor: Turn on/off custom server message color
• DefaultServerColor: Color name for server messages (e.g., "yellow")
• EnableDefaultPlayersColor: Turn on/off custom player message color
• DefaultPlayersColor: Color name for player messages (e.g., "white")
• EnableGlobalServerRichText: Allow formatting tags in ALL server and plugin messages
• EnablePlayersRichText: Allow formatting tags in player messages

Icons

• EnableDefaultServerIconUrl: Use a default icon for server messages
• OverrideServerIconUrl: Force the default icon even if another one exists
• DefaultServerIconUrl: URL to the server icon image
• EnableDefaultPlayersIconUrl: Use a default icon for player messages
• OverridePlayersIconUrl: Force the default player icon
• DefaultPlayersIconUrl: URL to the default player icon image

Message Formatting

• DisableRocketWrapMessage: Prevent RocketMod from wrapping messages
• ServerTextReplaces: Convert text in server messages (useful for XML compatibility where you can use [[ instead of < since XML escapes angle brackets)
• EnableChatFormat: Turn on custom chat message formatting (IMPORTANT: Must be set to true for all chat formatting options below to work)
• ChatFormat: Template for message structure using variables:
  • {CHAT_MODE}: Indicates message type (global, area, group)
  • {PREFIXES}: Player group prefixes
  • {PLAYER_NAME}: Player's name
  • {SUFFIXES}: Player group suffixes
  • {MESSAGE}: The actual message content

Chat Mode Indicators

Note: These settings only work when EnableChatFormat is set to true

• ChatModePrefixes: Text to show before messages in different chat modes:
  • Global: For global chat
  • Area: For local area chat (default: "[A] ")
  • Group: For group chat (default: "[G] ")

Group Prefixes and Suffixes

Note: All options below require EnableChatFormat to be set to true to work

• EnablePrefixes: Show group prefixes for players
• DisplayMultiplePrefixes: Show all prefixes if player is in multiple groups
• PrefixesFormat: How prefixes appear (default: "[] ")
• PrefixFormat: Format for each prefix (default: "}{/color}")
• EnableSuffixes: Show group suffixes for players
• DisplayMultipleSuffixes: Show all suffixes if player is in multiple groups
• IncludeParentGroups: Include prefixes/suffixes from parent groups
• SuffixesFormat: How suffixes appear (default: " []")
• SuffixFormat: Format for each suffix (default: "}{/color}")

Example Configuration

<?xml version="1.0" encoding="utf-8"?>
<ChatManagerConfiguration xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <EnableDefaultServerColor>true</EnableDefaultServerColor>
  <DefaultServerColor>yellow</DefaultServerColor>
  <EnableDefaultPlayersColor>false</EnableDefaultPlayersColor>
  <DefaultPlayersColor>white</DefaultPlayersColor>
  <EnableGlobalServerRichText>true</EnableGlobalServerRichText>
  <EnablePlayersRichText>false</EnablePlayersRichText>
  <EnableDefaultServerIconUrl>true</EnableDefaultServerIconUrl>
  <OverrideServerIconUrl>false</OverrideServerIconUrl>
  <DefaultServerIconUrl>https://i.imgur.com/AakRtbb.png</DefaultServerIconUrl>
  <EnableDefaultPlayersIconUrl>false</EnableDefaultPlayersIconUrl>
  <OverridePlayersIconUrl>false</OverridePlayersIconUrl>
  <DefaultPlayersIconUrl>https://i.imgur.com/lLTpjL2.png</DefaultPlayersIconUrl>
  <DisableRocketWrapMessage>true</DisableRocketWrapMessage>
  <ServerTextReplaces>
    <TextReplace OldValue="[[" NewValue="&lt;" />
    <TextReplace OldValue="]]" NewValue="&gt;" />
  </ServerTextReplaces>
  <!-- Set to TRUE to enable chat formatting options below -->
  <EnableChatFormat>false</EnableChatFormat>
  <ChatFormat>{CHAT_MODE}{PREFIXES}{PLAYER_NAME}{SUFFIXES}: {MESSAGE}</ChatFormat>
  <ChatModePrefixes>
    <Global />
    <Area>[A] </Area>
    <Group>[G] </Group>
  </ChatModePrefixes>
  <EnablePrefixes>true</EnablePrefixes>
  <DisplayMultiplePrefixes>true</DisplayMultiplePrefixes>
  <PrefixesFormat>[{PREFIXES}] </PrefixesFormat>
  <PrefixFormat>{color={COLOR}}{PREFIX}{/color}</PrefixFormat>
  <EnableSuffixes>true</EnableSuffixes>
  <DisplayMultipleSuffixes>true</DisplayMultipleSuffixes>
  <IncludeParentGroups>true</IncludeParentGroups>
  <SuffixesFormat> [{SUFFIXES}]</SuffixesFormat>
  <SuffixFormat>{color={COLOR}}{SUFFIX}{/color}</SuffixFormat>
</ChatManagerConfiguration>

Chat Formatting and Permissions Example

For the chat formatting features to work with group prefixes and suffixes, you need to configure your permission groups properly. Here's an example of how to set up your Permissions.config.xml file with groups that have prefixes, suffixes, and colors:

<?xml version="1.0" encoding="utf-8"?>
<RocketPermissions xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <DefaultGroup>default</DefaultGroup>
  <Groups>
    <Group>
      <Id>default</Id>
      <DisplayName>Player</DisplayName>
      <Prefix>PLAYER</Prefix>
      <Suffix>P</Suffix>
      <Color>white</Color>
      <Priority>100</Priority>
      <Permissions>
        <!-- Permissions here -->
      </Permissions>
    </Group>
    <Group>
      <Id>vip</Id>
      <DisplayName>VIP</DisplayName>
      <Prefix>VIP</Prefix>
      <Suffix>V</Suffix>
      <Color>yellow</Color>
      <ParentGroup>default</ParentGroup>
      <Priority>50</Priority>
      <Permissions>
        <!-- VIP Permissions here -->
      </Permissions>
    </Group>
    <Group>
      <Id>admin</Id>
      <DisplayName>Admin</DisplayName>
      <Prefix>ADMIN</Prefix>
      <Suffix>A</Suffix>
      <Color>red</Color>
      <Priority>1</Priority>
      <Permissions>
        <!-- Admin Permissions here -->
      </Permissions>
    </Group>
  </Groups>
</RocketPermissions>

With the above permission configuration and Chat Manager's chat formatting enabled, here's how chat messages would appear:

• Default player: [<span style="color:white">PLAYER</span>] PlayerName [<span style="color:white">P</span>]: Hello everyone!
• VIP player: [<span style="color:yellow">VIP</span>] PlayerName [<span style="color:yellow">V</span>]: Hello everyone!
• Admin: [<span style="color:red">ADMIN</span>] PlayerName [<span style="color:red">A</span>]: Hello everyone!
• Player with all ranks and DisplayMultiplePrefixes enabled: [<span style="color:red">ADMIN</span>, <span style="color:yellow">VIP</span>, <span style="color:white">PLAYER</span>] PlayerName [<span style="color:red">A</span>, <span style="color:yellow">V</span>, <span style="color:white">P</span>]: Hello everyone!

Each prefix and suffix will be colored according to the group's color setting. When a player belongs to multiple groups, the prefixes and suffixes will be ordered by the Priority value of each group (lower numbers display first). The example above shows multiple prefixes and suffixes ordered by priority (Admin: 1, VIP: 50, Default: 100).

Troubleshooting

• If chat formatting doesn't work even when EnableChatFormat is set to true, this plugin may be conflicting with other chat plugins. Try disabling other chat/formatting plugins to identify conflicts.
• Make sure your permission group prefixes and suffixes are properly configured in your permissions configuration.