Content generated with AI — it may contain mistakes.

ExyliaStaff/GuidesUpdated in v1.8.0

Set up staff chat

Give staff a private channel across every server, and let them read chats other plugins keep isolated.

Page 10 of 384 min read
  

ExyliaStaff has two chat tools. Staff chat is a private channel: what a staff member writes there reaches every staff member on the network and nobody else. Global chat lets a staff member read every chat on the server, even the ones other plugins keep isolated (matches, arenas, events), and optionally every other server's chat too.

Before you start#

  • Give staff chat to the rank: exyliastaff.staffchat. For global chat give exyliastaff.globalchat.
  • The module switches are modules.staff-chat and modules.global-chat in plugins/ExyliaStaff/config.yml.
  • Across servers it needs the same database and Redis on every server, like the rest of ExyliaStaff. With one server and no Redis it works the same.

Steps#

Talk in staff chat

Run /sc (alias /staffchat) to switch it on: everything you type now goes to staff, not to public chat. Run /sc again to go back. Or click the STAFF CHAT writable book (slot 28) in the staff mode hotbar.

Send a single line

Run /sc <message> to send one line without changing the switch. The console can do this too.

Read every chat on the server

Run /globalchat (alias /chatbypass), or click the GLOBAL CHAT bell (slot 30). It cycles three modes: off, global, network.

Check that it works#

Switch staff chat on with /sc, type a line, and have another staff member (on any server) confirm they see it as [SC] <server> » <you> » <message> while a normal player sees nothing. Run /sc again and confirm your next line shows in public chat.

Going further#

How staff chat behaves#

There is no prefix character such as @: the switch and the command are the two ways in. The switch is saved, so it survives a relog and follows the player to other servers. It turns off when the player leaves staff mode or loses exyliastaff.staffchat.

While it is on, what the staff member types is taken out of public chat before any other plugin reads it, a Discord bridge included. Lines are delivered to every online player holding exyliastaff.staffchat, and also printed to the console while console is on.

The three global chat modes#

ModeWhat you readWho reads you
OffThe chat around you, like any player.Like any player.
GlobalEvery chat on this server, whatever another plugin isolates.Everyone on the server, past every rule.
NetworkThe same, plus every other server's public chat.Only your server. What you say never leaves it.

The mode is saved and restored on join. Unlike staff chat it is not turned off when you leave staff mode; losing exyliastaff.globalchat resets it to off. Only reading crosses servers. Lines another plugin cancelled (a mute, or staff chat itself) are never relayed.

To keep one server out of the others' network view, set relay: false in its globalchat config. Its own staff still read the other servers.

On the SurvivalCore client#

A player on the SurvivalCore client mod gets a red Staff tab in the chat panel while they hold exyliastaff.staffchat. Every staff chat line from every server shows there, and a line typed into the tab goes to staff chat like /sc. Other clients are unaffected.

Commands and permissions#

CommandWhat it doesPermission
/staffchat [message]Send a message to staff chat, or switch your chat to it.exyliastaff.staffchat
/globalchatCycle how much chat you read: off, global, network.exyliastaff.globalchat
PermissionWho has itWhat it allows
exyliastaff.staffchatAdmins (op)Read and write the staff chat.
exyliastaff.globalchatAdmins (op)Read every chat on the server, isolated ones included, and be read back.
Configuration and messages
plugins/ExyliaStaff/modules/staffchat/config.yml
yaml
console: true
plugins/ExyliaStaff/modules/globalchat/config.yml
yaml
relay: true
KeyDefaultWhat it does
console (staffchat)trueAlso print staff chat lines to this server's console.
relay (globalchat)truePublish this server's public chat so staff in network mode elsewhere can read it.

How a line looks is text, so it lives in lang/<language>/modules/<module>/messages.yml, not in the config. Both files have a format with %server%, %player% and %message%:

yaml
format: '{letters_black}[{primary}SC{letters_black}] {muted}%server% {letters_black}» {highlight}%player% {letters_black}» {letters}%message%'

%server% is the sender's server id from database.yml. Staff chat also has toggled-on, toggled-off, permission-lost, console-needs-message, status-on and status-off. Global chat has toggled-on, toggled-network, toggled-off, permission-lost, status-on, status-network and status-off, and its format uses [NET]. See ExyliaLib messages and colours.

PlaceholderShowsExample
%exyliastaff_staff_staffchat_toggled%The staff chat status text.ON
%exyliastaff_staff_staffchat_active%true while staff chat is on for you.true
%exyliastaff_staff_globalchat_toggled%The global chat status text (off, on or network).NETWORK
%exyliastaff_staff_globalchat_active%true in global or network mode.true
%exyliastaff_staff_globalchat_network%true in network mode.false
%exyliastaff_staff_globalchat_mode%OFF, GLOBAL or NETWORK.GLOBAL

See also Placeholders.

Something missing on this page? Tell us on Discord