Skip to content

Features

Themes, commands, 3D bubbles, tags, proximity, and in-chat extras.

Open chat with T (players can rebind it in FiveM settings). Type normally or start a command; suggestions appear as you type. Use ↑ / ↓ to cycle the last few messages you sent.

See Installation if the resource is not set up yet.


Themes and editor#

Players pick from six themes: default, compact, glow, v3, bubble, and flat. Choices are saved per client.

From the plus menu → settings / editor they can:

  • Scale and reposition the chat panel
  • Change theme colors
  • Pick a font (Plus Jakarta Sans, Inter, Manrope, Poppins)
  • Set visibility: New Message, Always Show, On Message, or Hidden
  • Toggle the notification sound (when notification is enabled in config)
  • See an unread badge while Hidden mode is on and chat is closed

Conversation mode (config) puts your own messages on one side and others on the opposite side. It only applies on themes that support it.


Commands#

Command names are configurable in config/main.lua → commands. Defaults:

CommandWho can use itWhat it does
/meEveryoneRoleplay action; proximity + optional 3D
/doEveryoneEnvironment description; proximity + optional 3D
/oocEveryone (if enabled)Out-of-character chat — local proximity or global
/pmEveryone (if enabled)Private message: /pm <serverId> <message>
/clearEveryoneClears messages on your client only
/songEveryone (if enabled)Plays a YouTube track in the chat player
/imgEveryone (if enabled)Posts an image to nearby chat
/announcementFramework admin or ACEGlobal announcement (admin message type)

/img needs a full HTTPS image URL (with a normal image extension). /song needs a valid YouTube URL. Both respect cooldowns from config.

Announcements require framework admin or ACE command.<announcementCommand>. Everyone else is denied.


Plus menu extras#

Besides settings, the plus menu can open:

  • Emoji picker (categories + recent)
  • Image / Song shortcuts (same rules as the commands)
  • Dice and rock-paper-scissors — proximity game results with animations (game message type)

3D world text#

When a message type has show3D = true, nearby players can see a bubble above the sender’s head. Typing shows three dots while chat is open (typingIndicator).

  • Typewriter — bubbles can appear letter by letter (typeWriter3D)
  • Mask detection — masked players show as Anonymous on /me and /do when enabled
  • Server ID — optional [id] next to the author name (showServerId)

Durations for screen text and 3D are set under durations in Configuration.


Author tags#

With tags.enabled, messages can show colored labels:

  • Job tags — map job names (e.g. police → LSPD) in tags.job.data. Optional autoDetect labels unknown jobs automatically.
  • ACE tags — map ACE principals (e.g. chat.admin → Admin) in tags.ace.data

Edit the lists in config or in escrow-open modules/tag/server.lua if you need custom logic.


Proximity#

RP messages, OOC (when oocProximity is true), images, and games use proximityDistance (default 22.5 m).

With useServerProximity, the server decides who is in range (harder for cheaters to snoop map-wide). Pair it with proximityCatchUp so someone who teleports into range still gets active nearby messages for a short time.


Message types#

Built-in types include system, ooc, me, do, pm, admin, game, and image. Each has a color and optional 3D / hide-author flags. You can add custom types for scripts that call addMessage — see Exports/Events and Configuration.