Chat

Features

• Chat box or command-only: one option (Config.ChatBox.enabled). As a chat box, typed text is sent as a chat message. Command-only, the bar only runs /commands.
• Chat channels as commands: /ooc, /looc (nearby only), staff-only /announce and /staff. Add your own with any tag, color, range and staff lock, and turn any command off with one setting.
• /me and /do shown above the player's head to people nearby.
• Never gets stuck: tabbing out of the game while the chat is open no longer locks players. The chat takes its focus back, or closes cleanly so it can be opened again.
• Typing stays in the chat: while it's open, no key reaches the game (no getting into a car by typing an F).
• Command suggestions with help text, for every command the player is allowed to use, updated live.
• Message history (Up / Down), Tab to complete a command, Page Up / Down to scroll.
• Character names (ESX, QBCore, Qbox) or FiveM names, with or without server id.
• Anti-spam cooldowns and a word filter.
• Three chat modes on the L key: Visible, Visible when active, Hidden. Saved per player. Opening the chat (T) always shows it, whatever the mode. Clear it with /clear; hidden automatically in the pause menu.
• Fully compatible with the default chat API: chat:addMessage, chatMessage, suggestions, templates, ^1 color codes and the addMessage export.
• Discord logs for chat messages, staff messages and /me /do.
• Customisable look: position, size, colors, font, input under the chat or at the top of the screen.
• Lightweight: nothing runs while the chat is closed except a pause-menu check twice a second.
• Standalone: no other resources required.

Requirements

Only orynt_bridge (free, from Orynt Development). ESX, QBCore and Qbox are detected automatically (only used for character names and staff groups). OneSync is recommended for ranged channels (/looc) and /me /do, but not required.

Files

orynt_chat/
├── config.lua            Settings, channels, look (editable)
├── fxmanifest.lua
├── README.md             This file
├── LICENSE.md            Terms of use
├── locales/
│   └── en.lua            All text (editable, copy to translate)
├── shared/
│   └── text.lua          Loads the language
├── client/
│   └── main.lua          Opening, focus fix, /me /do drawing
├── server/
│   ├── sv_config.lua     Discord and console logs (editable, server only)
│   ├── bridge.lua        Character names and staff groups (editable)
│   ├── logs.lua          Discord webhook sender
│   └── main.lua          Channels, filter, cooldowns
└── html/                 The chat window

Every file is open and readable. Files marked editable are the ones meant for configuring.

Installation

1. Put the orynt_chat folder in your resources folder.
2. Remove the default chat and any other chat resource. Orynt Chat replaces the default chat resource: - In server.cfg, replace ensure chat with ensure orynt_bridge and ensure orynt_chat under it (keep them in the same early spot). - Remove chat themes (e.g. esx_chat_theme) and other chat or /me scripts (e.g. esx_rpchat).
3. Staff access (for /announce and /staff): admins in your framework's admin, superadmin or god group already have it. To give access by ace instead (or as well, and on standalone servers): cfg add_ace group.admin orynt_chat.staff allow
4. Restart the server. You should see: [Orynt Chat] Started (chat box)

Resources that list chat as a dependency keep working: Orynt Chat provides chat.

Using the chat

Press T to open it (players can change the key in Settings > Key Bindings > FiveM).

Modes (each player's choice is saved):

Commands (default):

With Config.ChatBox.enabled = true, typing text without a / sends it as an OOC message (by default). With the chat box off (command-only), /ooc and /looc are off too. Any command can be turned off in config.lua.

Configuration (config.lua)

1. Opening and the chat window

2. Chat box

3. Chat commands

Config.ChatCommands: each entry is a command that sends a message to a channel.

Config.StaffAce ('orynt_chat.staff') and Config.StaffGroups ({ 'admin', 'superadmin', 'god' }) decide who is staff.

4. /me and /do

Config.Text3D: range, duration, max length, cooldown, text size and font, and the commands themselves (enabled, command, color, prefix, suffix, help). Set enabled = false to turn a command off, or copy a line to add your own (e.g. /think).

5. Word filter

Config.WordFilter: set enabled = true and list words in words. They're replaced with replaceWith in chat messages and /me /do (not case sensitive).

6. Language and look

Server configuration (server/sv_config.lua)

Never sent to players, so webhook links stay private.

Discord logs

1. In Discord: Server Settings → Integrations → Webhooks → New Webhook, pick the channel, Copy Webhook URL.
2. In server/sv_config.lua, paste it into SvConfig.Logs.webhook and set enabled = true.
3. Optional: a webhook per channel in webhooks (chat, staff, text3d).
4. ensure orynt_chat.

Keep webhook links private.

For developers

Orynt Chat supports the default chat API, so existing scripts work without changes:

-- server or client
TriggerClientEvent('chat:addMessage', -1, { args = { 'Bank', 'You received $500' }, color = { 62, 207, 142 } })
TriggerClientEvent('chat:addMessage', -1, { tag = 'NEWS', tagColor = '#7018ff', author = 'Weazel', text = 'Breaking news...' })
TriggerClientEvent('chatMessage', -1, 'SYSTEM', { 255, 0, 0 }, 'Hello')
TriggerEvent('chat:addSuggestion', '/mycommand', 'What it does', { { name = 'id', help = 'Player id' } })
exports.orynt_chat:addMessage(-1, { args = { 'Hello everyone' } })   -- server

Typed chat messages trigger the standard server event chatMessage (source, name, message) first. Call CancelEvent() in a handler to stop the message from being sent.

Translating

All text is in locales/en.lua. Copy it to e.g. locales/de.lua, change Locales['en'] to Locales['de'], translate it (keep the words in {braces}), set Config.Locale = 'de', then refresh and ensure orynt_chat. Anything left out falls back to English. Command help texts are in config.lua.

Updating

Replace the resource folder with the new version and start it (refresh, then ensure orynt_chat, or restart the server). Nothing to copy over:

• Your settings come back by themselves. Every start, config.lua, server/sv_config.lua and your own translation are copied to the server (its KVP, outside the resource folder). When the new version starts with the files from the download, yours are put back and the resource restarts once to load them.
• New options your config doesn't have yet use their defaults, and the console lists them once (the changelog below says what they do).
• Changed any of the open code files (server/bridge.lua...)? The new version's file is used (it may need it), and yours is saved next to it as <file>.before-update so you can move your changes over. The console says so.
• Keep the resource's name (orynt_chat): the saved settings belong to it.

To let it restart itself after putting your settings back, add this to server.cfg (without it, the console asks you to type ensure orynt_chat once):

add_ace resource.orynt_chat command.ensure allow

To go back to the default settings on purpose: type orynt_chat:resetsettings in the server console, put the files from the download back and restart the resource.

Updating from a version before 1.1.0: those don't save your settings yet, so this one time keep a copy of your config.lua, server/sv_config.lua and language files, and put them back after replacing the folder. From 1.1.0 on, updates keep them by themselves.

Troubleshooting

Changelog

• 1.2.0: now runs on orynt_bridge, the free Orynt resource that handles your framework (character names and staff groups) for every Orynt script. Install it once (see Installation); your settings and data stay.
• 1.1.0: new Orynt look (Orynt purple, new emblem, rounded message cards, soft channel tags, a new input bar and command list). Fixed: keys typed in the chat (e.g. F next to a vehicle) no longer reach the game. Updates keep your settings now: replace the folder and your config comes back by itself (see Updating).
• 1.0.0: first release.

License

Free and open: every file is readable and editable. See LICENSE.md. In short: use and change it on your own servers; don't reupload or resell it; keep the Orynt Development branding.

© Orynt Development