ns-chat — Installation

Requirements

• FiveM server with OneSync enabled
• Optional: Qbox, QBCore or ESX (character names, 911 jobs, per-character statuses). Without a framework ns-chat runs standalone.

No database and no other dependency is needed.

Steps

1. Download the resource from your Cfx portal (Keymaster → Granted Assets) and put the ns-chat folder in your resources folder. Keep the folder name ns-chat.

2. Open server.cfg and replace the default chat:

   # ensure chat
   ensure ns-chat
   

   Copy

   Put ensure ns-chat where ensure chat was, before your framework and other resources. Resources that call exports.chat:* (for example qbx_chat_theme) need ns-chat to be started first.

3. Restart the server (a full restart, not only restart ns-chat, the first time).

4. In game press Enter (or T) to open the chat and type me test.

Notes

• The manifest declares provide 'chat', so resources with dependency 'chat' keep working.
• Messages sent with chat:addMessage / exports.chat:addMessage (txAdmin announcements, join / quit messages, MOTD) are shown as system lines. Turn them off with Config.ExternalMessages = false.
• Templates registered with chat:addTemplate / exports.chat:addTemplate are used for messages that name them with templateId ({0}, {1} ... are replaced by the arguments). HTML in templates and messages is shown as plain text.
• Qbox: the join / quit messages come from qbx_chat_theme. Set qbx_chat:joinMessage / qbx_chat:quitMessage to "" in server.cfg if you do not want them.
• Players can rebind the open keys in Settings → Key Bindings → FiveM.

Updating

Replace every file except config.lua (and your edited shared/locale.lua), then compare your config.lua with the new one for new options listed in CHANGELOG.md.

Troubleshooting