> For the complete documentation index, see [llms.txt](https://devmosaic.gitbook.io/devmosaic/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://devmosaic.gitbook.io/devmosaic/resources/devmosaic-dm-chat.md).

# Dm Chat

A modern FiveM chat with proximity roleplay commands, 3D action popups, emojis, GIFs, media playback and the standard chat API.

`dm-chat` replaces the default FiveM chat with a command-focused NUI. It adds proximity roleplay messages, animated popups above players, emoji and GIF reactions, media cards, command suggestions, history, and compatibility with the standard FiveM chat events and exports.

{% hint style="success" %}
**Quick start:** [install the resource](/devmosaic/resources/devmosaic-dm-chat/installation.md), remove the default `chat` resource from your start list, then edit `config.lua`.
{% endhint %}

## What is included

* Styled chat messages with automatic fading
* `/say`, `/ooc`, `/me`, and `/do` roleplay commands
* Five-second `/me` and `/do` popups anchored above the speaking player
* Emoji picker and proximity emoji popups
* Direct GIF popups through `/gif`
* Direct audio and YouTube playback through `/music`
* YouTube video cards through `/video`
* Command autocomplete, input history, and chat-feed scrolling
* Join and leave messages controlled by server convars
* Standard chat messages, suggestions, templates, modes, and server hooks

## Find what you need

<table data-view="cards"><thead><tr><th></th><th></th><th></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td><i class="fa-download">:download:</i></td><td><strong>Install it</strong></td><td>Replace the default chat, set permissions, and start the resource.</td><td><a href="/devmosaic/resources/devmosaic-dm-chat/installation.md">Installation</a></td></tr><tr><td><i class="fa-sliders">:sliders:</i></td><td><strong>Configure behavior</strong></td><td>Change distances, timers, feature switches, and message visibility.</td><td><a href="/devmosaic/resources/devmosaic-dm-chat/configuration.md">Configuration</a></td></tr><tr><td><i class="fa-terminal">:terminal:</i></td><td><strong>Use the chat</strong></td><td>See every command, permission, key, and input shortcut.</td><td><a href="/devmosaic/resources/devmosaic-dm-chat/commands-and-controls.md">Commands And Controls</a></td></tr><tr><td><i class="fa-photo-film">:photo-film:</i></td><td><strong>Use popups and media</strong></td><td>Understand proximity bubbles, GIF URLs, music, and YouTube playback.</td><td><a href="/devmosaic/resources/devmosaic-dm-chat/proximity-popups-and-media.md">Proximity Popups And Media</a></td></tr><tr><td><i class="fa-palette">:palette:</i></td><td><strong>Restyle the UI</strong></td><td>Configure every colour group and customize the emoji list.</td><td><a href="/devmosaic/resources/devmosaic-dm-chat/ui-theme-and-emojis.md">UI Theme And Emojis</a></td></tr><tr><td><i class="fa-code">:code:</i></td><td><strong>Integrate another script</strong></td><td>Use messages, suggestions, templates, modes, and server hooks.</td><td><a href="/devmosaic/resources/devmosaic-dm-chat/exports-and-integrations.md">Exports And Integrations</a></td></tr><tr><td><i class="fa-wrench">:wrench:</i></td><td><strong>Fix a problem</strong></td><td>Solutions for duplicate chat, input, proximity, media, and UI issues.</td><td><a href="/devmosaic/resources/devmosaic-dm-chat/troubleshooting.md">Troubleshooting</a></td></tr></tbody></table>

## Requirements

| Requirement     | Notes                                                                      |
| --------------- | -------------------------------------------------------------------------- |
| FiveM           | Uses a Cerulean manifest and NUI                                           |
| `ox_lib`        | Loaded by `@ox_lib/init.lua` and must start first                          |
| Internet access | Required for the bundled web fonts, icons, remote GIFs, audio, and YouTube |

All normal settings are in `config.lua`. The included HTML, CSS, and JavaScript are ready to run, so there is no Node.js or frontend build step.