esx_rpchat

esx_rpchat adds the classic roleplay chat commands to an ESX Legacy server: /me and /do for nearby players, a global OOC channel, /twt and /anontwt "tweets", and /msg private messages. Every command is rate limited on the server, and proximity messages are filtered by distance and routing bucket.

OverviewCopy Anchor Link

InstallationCopy Anchor Link

ensure chat
ensure esx_lib
ensure es_extended
ensure esx_rpchat

CommandsCopy Anchor Link

• /me describes an action ("/me opens the trunk"); /do describes the scene or answers a /me ("/do The trunk is empty").
• /me and /do text is cut to ProximityMaxLength characters (UTF-8 aware). /msg uses the same limit.
• /msg ignores empty messages, messages to yourself and invalid ids. It uses FiveM names, not character names.
• None of the commands can be used from the server console.

ConfigurationCopy Anchor Link

The server also reads Config.MsgCooldown for /msg. It is not in the shipped config.lua, so it falls back to 1000. Add it if you want a different value. Setting any cooldown to 0 disables that limit.

A rate-limited player gets a red SYSTEM message like "Please wait 3 seconds before sending another message."

EventsCopy Anchor Link

esx_rpchat:sendProximityMessage (client)Copy Anchor Link

The server sends /me and /do to nearby players through this event:

-- server
xLib.triggerClientEvent('esx_rpchat:sendProximityMessage', targets, title, message, color)

The target list comes from ESX.OneSync.GetPlayersInArea in the sender's routing bucket, so players in other instances (apartments, garages) do not see the message.

The client handler also accepts an older 4-argument form (playerId, title, message, color) and then checks the distance to that player locally. You can reuse the 3-argument form from your own server scripts to send any styled chat line to a list of players:

local targets = { source, otherId }
xLib.triggerClientEvent('esx_rpchat:sendProximityMessage', targets, 'radio | Dispatch', '10-4, units en route', { 0, 200, 0 })

Integration tipsCopy Anchor Link

• Logging: /anontwt is anonymous to players but not to the server. If you need moderation, add a log call in the anontwt command in server/main.lua.
• Localization: prefixes contain chat color codes (^0, ^4, ^5). Edit locales/<lang>.lua to restyle them.
• Custom chat UIs: messages are sent through chat:addMessage, so any chat resource that implements it works.

Common issuesCopy Anchor Link

• OOC messages show twice: another resource also re-broadcasts chatMessage. Disable one of them.
• /me not visible to a nearby player: the player is in a different routing bucket, or OneSync is off (ESX.OneSync.GetPlayersInArea needs OneSync).
• Names show as FiveM names: the player has no character name yet, or EnableESXIdentity is false.

RelatedCopy Anchor Link

• esx_identity
• esx_chat_theme
• OneSync functions
• Commands

Frequently asked questions