Event System

Chat Global Message

chat.global_message

A player sent a global chat message that RAT parsed from telnet output.

Source: telnet parsed via telnet.chat.global_message.

Event variables

Templates

Help command logger

Tracks the last player who used !help and logs the normalized message.

# Capture simple help commands
set local.message = trim($chat_content)

if starts_with(lower(local.message), "!help") then
  set global.last_help_player = $player.name
  set global.last_help_at = $current_datetime
  log(format("Help requested by {0}: {1}", $player.name, local.message))
else
  debug(format("Ignored chat from {0}", $player.name))
end

Quiet mode filter

Suppresses most chat when quiet mode is enabled in shared state.

# Use global.quiet_mode to suppress normal chat
set local.message = trim($chat_content)

if global.quiet_mode == true and not starts_with(local.message, "!") then
  debug(format("Suppressed chat from {0}", $player.name))
else
  log(format("{0}: {1}", $player.name, local.message))
end

Chat Server Message

chat.server_message

A server-originated chat line that RAT parsed from telnet output.

Source: telnet parsed via telnet.chat.server_message.

Event variables

Templates

Announcement tracker

Stores the latest server announcement in shared state.

set global.last_server_announcement = $chat_content
set global.last_server_announcement_at = $current_datetime
log(format("Server said: {0}", $chat_content))

Discord Message

discord.message_received

A Discord message received from a configured channel mapping.

Source: Discord gateway via discord.message_received.

Event variables

Templates

Discord logger

Logs Discord messages received from a configured event source mapping.

log(format("[Discord:{0}] {1}: {2}", $discord_channel_key, $discord_author_name, $chat_content))

Discord Message Updated

discord.message_updated

A Discord message was edited in a configured channel mapping.

Source: Discord gateway via discord.message_updated.

Event variables

Templates

No template is shipped for this event type. Start with a focused condition and one observable action such as log(...).

Discord Message Deleted

discord.message_deleted

A Discord message was deleted from a configured channel mapping.

Source: Discord gateway via discord.message_deleted.

Event variables

Templates

No template is shipped for this event type. Start with a focused condition and one observable action such as log(...).

Discord Reaction Added

discord.reaction_added

A reaction was added to a Discord message in a configured channel mapping.

Source: Discord gateway via discord.reaction_added.

Event variables

Templates

No template is shipped for this event type. Start with a focused condition and one observable action such as log(...).

Discord Reaction Removed

discord.reaction_removed

A reaction was removed from a Discord message in a configured channel mapping.

Source: Discord gateway via discord.reaction_removed.

Event variables

Templates

No template is shipped for this event type. Start with a focused condition and one observable action such as log(...).

Player Joined

player.joined

A player joined the game according to telnet output.

Source: telnet parsed via telnet.player.joined.

Event variables

Templates

Join tracker

Records the latest player join in shared state and writes a friendly log line.

set global.last_joined_player = $player.name
set global.last_joined_at = $current_datetime
log(format("Player joined: {0}", $player.name))

Player Left

player.left

A player left the game according to telnet output.

Source: telnet parsed via telnet.player.left.

Event variables

Templates

Departure tracker

Records the latest player departure and logs the event.

set global.last_left_player = $player.name
set global.last_left_at = $current_datetime
log(format("Player left: {0}", $player.name))

Entity Killed

entity.killed

An entity was killed according to telnet output, including the killed entity and the killer identity details.

Source: telnet parsed via telnet.entity.killed.

Event variables

Templates

Killer tracker

Tracks the latest resolved kill and logs the raw kill line.

set global.last_killed_entity = $killed_entity_name
set global.last_kill_at = $current_datetime

if not empty($killed_player_name) then
  set global.last_killed_entity = $killed_player_name
end

if not empty($killer_player_name) then
  set global.last_killer_name = $killer_player_name
else
  set global.last_killer_name = $killer_name
end

log(format("{0} killed by {1}", global.last_killed_entity, global.last_killer_name))

Server Unresponsive

server.unresponsive

The running game server stopped producing valid telnet command responses.

Source: runtime matcher via rat.telnet_health.unresponsive.

Event variables

Templates

No template is shipped for this event type. Start with a focused condition and one observable action such as log(...).

Server Responsive

server.responsive

The game server produced a valid telnet response after being declared unresponsive.

Source: runtime matcher via rat.telnet_health.responsive.

Event variables

Templates

No template is shipped for this event type. Start with a focused condition and one observable action such as log(...).

Text Match

text.match

Fires for every raw telnet console line, providing the unmodified line as a token. Use script conditions to filter for lines of interest.

Source: runtime matcher via .

Event variables

Templates

Pattern filter

Matches lines containing a specific phrase and logs them.

if contains($raw_line, "INF StartGame") then
  log(format("Game started: {0}", $raw_line))
end

Backup Started

backup.started

A backup operation has started.

Source: internally emitted via internal.backup.started.

Event variables

Templates

No template is shipped for this event type. Start with a focused condition and one observable action such as log(...).

Backup Completed

backup.completed

A backup operation completed successfully.

Source: internally emitted via internal.backup.completed.

Event variables

Templates

No template is shipped for this event type. Start with a focused condition and one observable action such as log(...).

Backup Failed

backup.failed

A backup operation failed.

Source: internally emitted via internal.backup.failed.

Event variables

Templates

No template is shipped for this event type. Start with a focused condition and one observable action such as log(...).

Server Ready

server.ready

The game server is ready and accepting player connections.

Source: internally emitted via internal.server.ready.

Event variables

Templates

No template is shipped for this event type. Start with a focused condition and one observable action such as log(...).

Server Restart

server.restarting

The game server is restarting.

Source: internally emitted via internal.server.restarting.

Event variables

Templates

No template is shipped for this event type. Start with a focused condition and one observable action such as log(...).

Server Start

server.started

The game server process has started.

Source: internally emitted via internal.server.started.

Event variables

Templates

No template is shipped for this event type. Start with a focused condition and one observable action such as log(...).

Server Stop

server.stopped

The game server process has stopped.

Source: internally emitted via internal.server.stopped.

Event variables

Templates

No template is shipped for this event type. Start with a focused condition and one observable action such as log(...).

New Player Joined

player.new_joined

A player joined the game and RAT created their player record for the first time.

Source: internally emitted via internal.player.new_joined.

Event variables

Templates

Welcome new player

Logs a welcome message for a player joining for the first time.

log(format("Welcome, {0}!", $player.name))

Bloodmoon Started

bloodmoon.started

A blood moon has started for the reported in-game day.

Source: telnet parsed via telnet.bloodmoon.started.

Event variables

Templates

Workbench starter

Starter template scaffolded from the developer workbench.

# Review before enabling in production
log("Implement this event handler")

Bloodmoon Ended

bloodmoon.ended

A blood moon has ended.

Source: telnet parsed via telnet.bloodmoon.ended.

Event variables

Templates

Workbench starter

Starter template scaffolded from the developer workbench.

# Review before enabling in production
log("Implement this event handler")

Player Backpack Location

custom.backpack_location

A player's backpack location

Source: telnet parsed via telnet.custom.backpack_location.

Event variables

Templates

Workbench starter

Starter template scaffolded from the developer workbench.

# Review before enabling in production
log("Implement this event handler")

Preparing Quit

custom.preparing_quit

The server is shutting down

Source: telnet parsed via telnet.custom.preparing_quit.

Event variables

Templates

Workbench starter

Starter template scaffolded from the developer workbench.

# Review before enabling in production
log("Implement this event handler")

Game Server Stats

custom.server_stats

Get the server stats like fps, heap, max, chunks, etc.

Source: telnet parsed via telnet.custom.server_stats.

Event variables

Templates

Workbench starter

Starter template scaffolded from the developer workbench.

# Review before enabling in production
log("Implement this event handler")

Start Game

custom.start_game

Fires when the game server starts up and is ready for players to join.

Source: telnet parsed via telnet.custom.start_game.

Event variables

Templates

Workbench starter

Starter template scaffolded from the developer workbench.

#

Player Connected

player.connected

A player has connected to the game server, but not yet spawned into the game world.

Source: telnet parsed via telnet.player.connected.

Event variables

Templates

Workbench starter

Starter template scaffolded from the developer workbench.

# Review before enabling in production
log("Implement this event handler")

Player Died

player.died

A player died

Source: telnet parsed via telnet.player.died.

Event variables

Templates

Workbench starter

Starter template scaffolded from the developer workbench.

# Review before enabling in production
log("Implement this event handler")

Player Disconnected

player.disconnected

A player disconnected from the game server

Source: telnet parsed via telnet.player.disconnected.

Event variables

Templates

Workbench starter

Starter template scaffolded from the developer workbench.

# Review before enabling in production
log("Implement this event handler")

Player Kicked

player.kicked

A player was kicked from the game server, including the kick kind, optional message, and player identity details reported by telnet.

Source: telnet parsed via telnet.player.kicked.

Event variables

Templates

Workbench starter

Starter template scaffolded from the developer workbench.

# Review before enabling in production
log("Implement this event handler")

Player Banned

player.banned

A player was banned from the game server, including the ban expiration, optional reason, and player identity details reported by telnet.

Source: telnet parsed via telnet.player.banned.

Event variables