NL-Chat

NL-Chat - Advanced Discord-Integrated Chat System for FiveM

📖 Table of Contents

• Installation
• Configuration
• Features
• Commands
• Permissions
• Discord Bot Setup
• Webhook Logging
• Troubleshooting
• Screenshots

🛠 Installation

1. Download & Extract

   Ensure ox_lib is installed: https://overextended.dev/ox_lib
   Drag [NL-Solutions]/nl-chat folder into your resources/
   

2. Add to server.cfg

   ensure ox_lib
   ensure nl-chat
   

3. Restart server or refresh + start nl-chat

4. Setup Discord Bot (required for tags/avatars) - See below

Done! Chat is now fully replaced. Press T to type.

⚙️ Configuration

All settings in chatconfig.lua (server-side only).

Discord Integration

northline.Config.ChatDiscord = {
    Enabled     = true,
    BotToken    = 'YOUR_BOT_TOKEN',  -- Create bot below
    GuildId     = '123456789012345678',  -- Copy Server ID (right-click server icon)
    CacheTTL    = 300,  -- Refresh roles every 5 min
}

Role-Based Tags (Highest priority first)

northline.Config.ChatTags = {
    Default = { tag = 'User', color = '222,222,222' },
    Tags = {
        { tag = 'Owner', color = '0,255,102', role = '123456789012345678' },  -- Discord role ID
        { tag = 'Admin', color = '255,0,0',   role = '123456789012345679' },
        -- Add more...
    },
    Custom = {
        AllowedRole = '123456789012345678',  -- Who can use /chattag custom
        MinLength = 2, MaxLength = 15,
        Blacklist = { 'admin', 'owner', 'mod' }
    }
}

Chat Settings

northline.Config.ChatSettings = {
    AntiSpam       = 5,    -- Seconds between messages
    MaxCharacters  = 300,
    ProximityRange = 15.0, -- /me /do range (meters)
    AutoAds = {
        'Join Discord.gg/Northline',
        'Apply at forms.Northline.lol'
    }
}

Webhooks (Optional - per channel)

northline.Config.ChatWebhooks = {
    Master = 'https://discord.com/api/webhooks/...',  -- ALL channels mirror here
    OOC    = 'https://discord.com/api/webhooks/...',
    Me     = '',
    Twitter = 'https://discord.com/api/webhooks/...',
    -- etc.
}

✨ Features

⌨️ Commands

T           - Open chat input
/chattag    - Tag selection menu (roles + custom)
/chathelp   - List all commands
/togglechat - Hide/show chat messages
/clear      - Clear your local chat

📢 CHANNELS:
ooc [msg]     - Global out-of-character
me [action]   - Local emote (nearby players)
gme [action]  - Global emote (everyone)
do [desc]     - Local action description
tw [msg]      - Twitter-style post
ad [msg]      - Server-wide advertisement
darkweb [msg] - Dark web channel
dm [id] [msg] - Private message player ID

🛠 STAFF:
clearchat     - Clear everyone's chat
announce [msg]- Staff broadcast (big red banner)

Examples:

/me waves hello
/do *The door creaks open slowly*
dm 5 Hey, meet at the docks?
twt Breaking: LSPD corruption scandal! #news

🔐 Permissions

Staff Commands (/clearchat, /announce)

Either:

• Discord role ID in ChatStaff.ClearChatRole
• FiveM ACE: chat.clearchat

Custom Tags

• Discord role ID in ChatTags.Custom.AllowedRole

🤖 Discord Bot Setup (5 minutes)

1. Go to Discord Developer Portal
2. New Application → Name it 'NL-Chat'
3. Bot tab → Add Bot → Copy Token (paste in config)
4. Privileged Gateway Intents → Enable 'SERVER MEMBERS INTENT'
5. OAuth2 → URL Generator:
   • Scopes: bot
   • Permissions: Read Messages/View Channels + View Audit Log
6. Copy generated URL → Invite bot to your Discord server
7. Copy your Server ID: Right-click server icon → Copy ID → Paste in config

✅ Bot ready! Roles/tags/avatars will appear automatically.

📊 Webhook Logging

Every message type logs to Discord with rich embeds:

Player: [ID] Name  🖥️
Discord: @username
Message: Hello world!
Server: Northline | 2024-10-01 12:34

Separate webhook per channel + master mirror.

🐛 Troubleshooting

Console Errors? Check fxserver.log for Discord API issues.

Support: Issues? https://discord.gg/j4YwdCcvB7

© Northline Solutions