Installation

Complete guide for installing nox-chat on your FiveM server.

Prerequisites

• FiveM Server
• oxmysql (database driver)
• QBCore / ESX / Standalone framework

Step 1: Download

1. Purchase and download nox-chat from noxcore.tebex.io
2. Extract the downloaded archive

Step 2: Database Setup

Run this SQL query in your database:

CREATE TABLE IF NOT EXISTS `nox_chat_player_tags` (
    `id` INT AUTO_INCREMENT PRIMARY KEY,
    `identifier` VARCHAR(100) NOT NULL UNIQUE,
    `tag_text` VARCHAR(50) DEFAULT NULL,
    `tag_color` VARCHAR(20) DEFAULT '#ffffff',
    `created_at` TIMESTAMP DEFAULT CURRENT_TIMESTAMP,
    `updated_at` TIMESTAMP DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP
);

Step 3: Install Resource

1. Place the nox-chat folder in your server's resources directory
2. Add to your server.cfg:

ensure oxmysql
ensure nox-chat

⚠️ Important: nox-chat must start AFTER oxmysql

Step 4: Configure Framework

Edit config.lua and set your framework:

Config.framework = 'qbcore'  -- 'qbcore', 'esx', 'esx-legacy', or 'standalone'

Step 5: Discord Integration (Optional)

To enable Discord role-based features:

1. Create a Discord bot at discord.com/developers
2. Enable "Server Members Intent" in Bot settings
3. Get your bot token and add it to server/tag_handler.lua:

DISCORD_BOT_TOKEN = "your_bot_token_here"

4. Set your Guild ID in config.lua:

Config.discordRoles = {
    enabled = true,
    guildId = "your_discord_server_id",
}

Step 6: Restart Server

refresh
ensure nox-chat

File Structure

nox-chat/
├── config.lua              # Main configuration (editable)
├── fxmanifest.lua         # Resource manifest
├── client/
│   └── client.lua         # Client-side (encrypted)
├── server/
│   ├── server.lua         # Server-side (encrypted)
│   └── tag_handler.lua    # Custom tag handler (editable)
├── lang/
│   ├── en.lua            # English translations (editable)
│   └── ko.lua            # Korean translations (editable)
└── ui/                    # Vue.js UI (built)

Editable Files

Troubleshooting

Chat not appearing

1. Check if oxmysql is running
2. Verify database table was created
3. Check server console for errors

Discord roles not syncing

1. Verify bot token is correct
2. Check if bot has "Server Members Intent" enabled
3. Ensure bot is in your Discord server

TTS not working

1. Verify xsound resource is installed (required for TTS)
2. Check if TTS is enabled in config

Last updated: January 28, 2026