Content generated with AI — it may contain mistakes.

ExyliaClans/GuidesguideUpdated in v1.4.0

Set up clan chat and mail

Three chat channels, two one-character shortcuts, and a clan mailbox that survives a logout.

Page 13 of 295 min read
  

Give clan members a private chat in one keystroke, a channel shared with allies, and a mailbox that is still there tomorrow.

Before you start#

  • The player must be in a clan; the channel resets to GLOBAL when they leave it.
  • Mail to the whole clan needs the SEND_CLAN_MAIL rank permission: see Ranks. Allies come from Relations.

Steps#

Switch channel

Run /clan chat. Each run cycles GLOBAL, CLAN, CLAN_AND_ALLIES. While it is not GLOBAL, everything you type goes to that channel.

Send one line without switching

Run /clan chat <message>, or type .message for the clan and @message for the clan and its allies.

Send mail

Run /clan mail send <member> <message> for one member or /clan mail sendclan <message> for everybody. /clan mail opens the inbox.

Check that it works#

With a second member online, type .hello in normal chat: only the clan sees it, and your channel stays GLOBAL. Then run /clan mail sendclan test, log the other member out and in again: they are told how many unread mails they have, and the inbox shows it.

Channels#

/clan chat

Cycles the player's channel. There are three, in order:

ChannelReachesFormat key
GLOBALNormal server chat—
CLANThe clanclan.chat-format
CLAN_AND_ALLIESThe clan and every allied clanclan.ally-chat-format

While the channel is anything but GLOBAL, everything the player types is captured and sent there instead. The channel is per session — it resets to GLOBAL on logout, and also resets itself if the player stops being in a clan.

Chat format keys in messages.yml
yaml
clan:
  chat-format: "{success}[CLAN] {muted}%player%{muted}: {letters}%message%"
  ally-chat-format: "{info}[ALLY] {muted}%player%{muted}: {letters}%message%"

/clan chat <message> sends one line to the current channel without switching to it.

A clan line is taken out of public chat on the chat event the server actually uses, before any other listener reads it, so a Discord bridge or a chat logger never sees the clan channel. On a network linked through Redis, clan and ally chat reach members on every server.

On the SurvivalCore client a clan member also gets Clan and Allies tabs in the chat panel. What they type there goes to the same channel as . or @, and each tab shows the lines of its channel.

Quick prefixes#

yaml
settings:
  chat:
    quick-clan-prefixes: ["."]
    quick-ally-prefixes: ["@"]

Typing .on my way in normal chat sends on my way to the clan; @push now sends push now to the clan and its allies. The channel is not changed — the next line goes wherever it was going before.

Both lists take as many prefixes as you like, and either can be emptied to disable that shortcut.

A prefix swallows the start of a normal message

. is a common way to start a sentence. Anybody who types ... or .gg is talking to their clan without meaning to. Two- or three-character prefixes (c:, !!) are far less surprising; picking them is a one-line change.

Messages are inserted as literal text: MiniMessage tags and % are neutralised, so a player cannot inject a colour, a click event or a placeholder into what their clan reads. The same holds for the rest of what players type and others read — rank names, mail subjects and bodies, LFP descriptions and applications, and log details.

Mail#

/clan mail                              open the inbox
/clan mail send <member> <message>      one member
/clan mail sendclan <message>           the whole clan

Mail is stored, so it is what clan chat is not: a message that is still there when the recipient logs in tomorrow. Sending to the whole clan needs SEND_CLAN_MAIL; sending to one member needs nothing beyond being in the same clan.

mail settings in config.yml
yaml
mail:
  expiry-days: 14
  expiry-check-interval-minutes: 30
  max-message-length: 256
  max-mails-per-clan: 100
  send-cooldown-seconds: 30
SettingWhat it does
expiry-daysDays before a mail is deleted. 0 never expires.
expiry-check-interval-minutesHow often expired mail is purged.
max-message-lengthLongest body, in characters.
max-mails-per-clanHow many a clan keeps. The oldest unpinned are pruned past this. 0 disables.
send-cooldown-secondsWait per player between two mails, to one member or the clan. Refused with mail.error-cooldown. 0 is off.

Read, deleted and pinned#

Read and deleted are tracked per member: the same clan mail can be unread for one player, read by another and deleted by a third, all from one row. Deleting is therefore only ever your own copy — the mail stays in everybody else's inbox.

Pinning is clan-wide. A pinned mail sits at the top of the inbox and is exempt from the max-mails-per-clan prune, which is what makes it the right place for the rules of a raid or a schedule.

The inbox menu also offers mark all read. On join, a player with unread mail is told how many they have, and %exyliaclans_clan_mail_unread% is the number for a scoreboard.

Composing goes through chat, not an anvil

Sending from the menu asks for the subject and then the body as chat input, using the prompts in mail.subject-prompt and mail.message-prompt. The command form skips the subject and uses mail.default-subject.

Something missing on this page? Tell us on Discord