CrimsonEcho

CrimsonEcho

A comprehensive chat messaging mod that enhances player engagement through automated notifications and announcements.

Key features include:

• Player Activity Notifications - Announces when players join/leave the server
• New Player Onboarding - Welcome messages and announcements for first-time players
• Automated Messaging System - Rotating messages sent at configurable intervals
• Daily Random Messages - Daily tips, quotes, or flavorful/themed text for players
• Scheduled Announcements - Scheduled messages that broadcast at specific times/days
• Clan Integration - Optional clan member listings and clanless player notifications
• MOTD Support - Message of the Day functionality for important server information

The mod is highly configurable with hot-reloadable JSON configuration files, allowing server administrators to customize all messaging without server restarts. It includes granular toggle controls for each notification type and supports both local server time and UTC scheduling for announcements.

Ideal for server administrators who want to create a more engaging and informative player experience through automated communication systems.

Config

Note: All JSON config files will automatically reload on server when changed without requiring server restart or any commands in-game.

CrimsonEcho.cfg

Toggles - Provides toggles for each standard notification type

## If true the mod will be usable; otherwise it will be disabled.
# Setting type: Boolean
# Default value: true
Toggle = true

## If true, the player online message will be shown.
# Setting type: Boolean
# Default value: true
TogglePlayerOnline = true

## If true, the player offline message will be shown.
# Setting type: Boolean
# Default value: true
TogglePlayerOffline = true

## If true, the MOTD message will be shown.
# Setting type: Boolean
# Default value: true
ToggleMOTD = true

## If true, the random message will be shown.
# Setting type: Boolean
# Default value: true
ToggleRandom = true

## If true, the clan printout message will be shown on connection with list of members.
# Setting type: Boolean
# Default value: false
ToggleClanPrintout = false

## If true, the clanless message will be shown.
# Setting type: Boolean
# Default value: false
ToggleClanless = false

Onboarding - Provides toggles for each onboarding (new player) notification type

## If true, the new player welcome message will be shown.
# Setting type: Boolean
# Default value: true
ToggleNewPlayerWelcome = true

## If true, the new player announce message will be shown.
# Setting type: Boolean
# Default value: true
ToggleNewPlayerAnnounce = true

## If true, the new player MOTD message will be shown.
# Setting type: Boolean
# Default value: true
ToggleNewPlayerMOTD = true

## If true, the random message will be shown for new players.
# Setting type: Boolean
# Default value: true
ToggleNewPlayerRandom = true

Customization - Settings for altering the behaviour and styling of the mod

## If true, times in config files will be read as UTC times instead of the server's local time.
# Setting type: Boolean
# Default value: false
TimesInUTC = false

## The interval in minutes between auto messages.
# Setting type: Int32
# Default value: 30
AutoMessageInterval = 30

## If true, admins will not broadcast online and offline messages.
# Setting type: Boolean
# Default value: false
ShadowAdmins = false

## The hex color value of the clan printout label.
# Setting type: String
# Default value: #def
ClanPrintoutAccentColor = #def

## The hex color value of the clan printout leader tag.
# Setting type: String
# Default value: #b7309c
ClanPrintoutLeaderTagColor = #b7309c

CrimsonEcho/messages.json

These are the contextual messages that will be sent to players if their corresponding config toggles are enabled.

The dynamic placeholder {player} will be replaced with the name of the player that triggered the message.

[
  {
    "Key": "PlayerOnline",
    "Value": "{player} is now online."
  },
  {
    "Key": "PlayerOffline",
    "Value": "{player} is now offline."
  },
  {
    "Key": "NewPlayerWelcome",
    "Value": "Welcome to the server {player}!"
  },
  {
    "Key": "NewPlayerAnnounce",
    "Value": "{player} has joined the server for the first time. Say hello!"
  },
  {
    "Key": "NewPlayerMOTD",
    "Value": ""
  },
  {
    "Key": "MOTD",
    "Value": ""
  },
  {
    "Key": "Clanless",
    "Value": "Consider joining a clan!"
  }
]

CrimsonEcho/automessages.json

This is a list of rotating messages that will be sent to all players on the interval AutoMessageInterval in CrimsonEcho.cfg.

The first message in the list with isFirst set to true will be the first message sent, and it will proceed onto the following messages from there.

When you edit this file while the server is live, remember to move isFirst being set to true to whichever message you would like the automessages to continue from.

If, instead, you want the sending of automessages to proceed from where it left off before the edit, you can set isFirst to false before saving.

[
  {
    "Content": "Join our discord for more information!",
    "isFirst": true
  },
  {
    "Content": "VAMP Powered Development!"
  }
]

CrimsonEcho/dailyrandoms.json

This list defines daily messages shown to players when they login. Each message corresponds to a specific day and is automatically rotated so that all players see the same message on any given day.

This can be used to provide a daily tip, flavorful/themed quotes, or other messages.

[
    "Dracula's Generals laugh at your attempts.",
    "But can you pet the Winged Horror?",
    "Who can be trusted when all creatures