Docs · mod build 5.8

Chat

Slow mode, /s staff chat, and in-game chat to Discord.

The Chat tab has everything about in-game chat: slow mode, staff chat and the Discord relay. Each part only shows if you have its permission.

Slow mode

Like Discord's: one message every so many seconds per player. While someone is waiting, their chat box counts down in red under where they type (Slow mode: 7s), and what they typed stays in the box so they don't lose it. It needs Turn chat slow mode on or off (manage_slow_mode), moderators and up to start with.

  • Turn Slow Mode On / Off flips it straight away, for busy moments.
  • Seconds between messages, 2 to 600, 10 to start with.
  • On these channels: Global, Faction, Group, Local, Vehicle, all ticked to start with.
  • Leave staff alone, on to start with. Staff testing it on themselves need to untick this, the tab says so when it applies to you.
  • Tell everyone when it goes on or off, with your own messages (%seconds% becomes the number). On to start with.

The server drops anything sent too early, with a second's slack for lag. Global chat never passes through the server's scripts, so for Global the player's own game holds the message back, the same way mutes work. Commands (/s, #save) are never slowed. Turning it on or off goes in the admin log and to Discord's Admin used an action.

Discord relay

Which in-game chat goes to your Discord, where it goes and how it looks. It needs Choose which chat goes to Discord (edit_chat_relay). Owners and admins have it by default.

Where it goes: a channel with its own webhook (below) always posts there. A channel without one uses Game Chat's webhook from the Notifications tab, and that only works while Game Chat is switched on there. The tab says under each channel if it has nowhere to go.

Only text is sent. Server commands like #login never go to Discord, so an admin password can't leak, and nothing from a muted player does either.

Channels

Tick the ones to send:

Channel To start with
Global On
Faction On
Group On
Local On
Vehicle On
Staff chat (/s, below) Off. Give it its own webhook to a staff-only Discord channel before turning it on

Each channel can post to its own webhook, for example faction chat into a staff-only Discord channel. That's all it needs. Leave it blank and it uses Game Chat's webhook (or your default one), as long as Game Chat is on in Notifications. Paste a new link to replace it, or press Clear to go back to Game Chat's. Like every webhook, it's never shown in full: the tab only shows enough of it to tell which it is.

Global chat is reported by the sender's own game, since the game doesn't pass it through anything a mod can see on the server. The other channels are seen by the server itself.

Private messages aren't relayed: the game has no working way for players to send one in this version.

Staff chat

Staff type /s and their message in any channel:

/s anyone free to check the airfield?

It goes to every staff member online with the Staff chat permission (staff_chat, moderators and up to start with) and to nobody else. Players never receive it, whatever their game does. A player who tries it is told it's for staff only.

It shows in chat as its own line, [Staff] ozzie: anyone free to check the airfield? in orange to start with. On this tab you can change:

  • How the line looks, with %name% for who sent it and %message% for what they said. It has to have %message% in it.
  • Its colour: click one of the 12 swatches, or type any hex. FF9833 (orange) to start with.
  • Show staff their own line too, on to start with.

Every staff message goes in the admin log (server messages). To see them on Discord, tick Staff chat in Channels and give it its own webhook, somewhere only staff can read. Don't send staff messages under Filters doesn't apply to it.

It isn't a channel you can switch to with the channel key: the game builds that list from its own files, so staff chat is a command instead.

Look

  • Colour: each post in the sender's side colour (the faction's own colour, modded factions included, grey for no side), or one colour of your choice: click a swatch or type any hex, like 5AA9E6.
  • Style: Full post (their name and the channel as the title, the message, and their side), or Compact, one line each, like [Faction] (US) Bob: moving to the church. Compact is easier to follow on a busy server.
  • Show their side and Show the channel, on to start with.
  • Show their Steam ID and GUID, off to start with (full posts only).

Filters

  • Don't send staff messages, off to start with.
  • Shortest message to send, 1 to start with, so everything goes.
  • Words to blank out, comma between them. They show as stars on Discord whatever case they're typed in. Whole words only, so ass doesn't touch class or assist, which also means a variant needs its own entry (fag as well as faggot, fucking as well as fuck). Nothing changes in game.

Discord formatting characters in a message (* _ ~ | > and backticks) show as typed, so nobody can bold or spoiler their line on your Discord. Posts are batched on busy servers (up to 10 at a time every couple of seconds) so Discord doesn't start refusing them, and pings like @everyone never ping anyone.

Files

The settings, channel webhooks included, are in Chat/chat_relay.json. Keep it private like Notifications/Webhooks.json. See Config files.