ngd-chat

# Discord webhook for chat logging (required if Config.UseDiscordLog = true)
set ngd_chat_webhook "https://discord.com/api/webhooks/YOUR_WEBHOOK_HERE"

# FiveManage API key for log ingest (required if Config.UseFivemanageLog = true)
set ngd_chat_fivemanage_key "YOUR_API_KEY"

mychannel = {
    command = {'mychannel', 'mc'},
    color = '#ff6b6b',
    label = 'MY CHANNEL',
    description = 'A custom channel',
    scope = 'all',          -- 'all', 'proximity', 'job', 'staff'
    -- distance = 15.0,     -- required for 'proximity' scope
    -- jobs = {'police'},   -- required for 'job' scope
    -- permission = 'command', -- required for 'staff' scope
    -- cooldown = 30,       -- optional cooldown in seconds
    -- bubble = true,       -- show as 3D bubble above head
    -- bubbleOnly = true,   -- only show as bubble, not in chat
    -- icon = 'myicon.png', -- image from /icons folder
    -- animated = true,     -- snake border animation
}

Config.DefaultChannel = 'global'     -- channel used when typing without a /prefix
Config.MaxMessageLength = 256        -- max characters per message
Config.BubbleDuration = 8            -- seconds /me and /do bubbles stay visible
Config.StaffPermission = 'command'   -- framework permission group for staff tools
Config.ShowPlayerIdForStaff = true   -- show [ID] next to names for staff members

Config.RateLimit = {
    messages = 3,    -- max messages allowed
    seconds = 3,     -- within this time window
}

Config.WordFilter = {
    enabled = true,
    action = 'censor',    -- 'censor' replaces with ***, 'block' prevents the message
    words = {
        'badword',
        'slur',
    },
}

-- Discord webhook logging
Config.UseDiscordLog = true

-- FiveManage log ingest
Config.UseFivemanageLog = false

Config.TimedMessages = {
    enabled = true,
    interval = 15,              -- minutes between each message
    name = 'Server',            -- display name
    color = '#3fb0e5',          -- message color (CSS hex)
    messages = {
        'Join our Discord at discord.gg/example!',
        'Report bugs using /report in-game.',
        'Check out our store at store.example.com!',
    },
}

Config.AnnouncePosition = 'top-center'  -- toast position on screen
Config.AnnounceDuration = 8             -- seconds the toast stays visible
Config.AnnounceSound = true             -- play chime sound

Config.CustomEmojis = {
    { emoji = '🏎️', name = 'race car' },           -- unicode emoji
    { image = 'PepeHands.png', name = 'pepecry' },  -- image emoji
}

Config.DefaultSettings = {
    x = 20,               -- pixels from left edge
    y = 20,               -- pixels from top edge
    width = 500,          -- chat window width (px)
    height = 400,         -- chat window height (px)
    visibility = 'fade',  -- 'fade', 'always', 'hidden'
    fadeTimeout = 10,     -- seconds before chat fades
    fontSize = 14,        -- font size (px)
}

function OnMessageSent(source, channel, message, playerName)
    -- source: number — server ID of the sender
    -- channel: string — channel name (e.g., 'global', 'police', 'anon')
    -- message: string — the message text (post-filter, post-sanitize)
    -- playerName: string — real display name, even for anonymous messages
end

function OnPlayerMuted(source, targetSource, muted)
    -- source: number — server ID of the staff member
    -- targetSource: number — server ID of the muted/unmuted player
    -- muted: boolean — true if muted, false if unmuted
end

function OnMessageDeleted(source, msgId)
    -- source: number — server ID of the staff member
    -- msgId: number — the message ID that was deleted
end

function OnChatCleared(source, global)
    -- source: number — server ID of the staff member
    -- global: boolean — true if /clearchat (all players), false if /clear (self only)
end

function OnChatOpen()
    -- Use this to hide HUD elements, pause systems, etc.
end

function OnChatClose()
    -- Use this to restore HUD elements, resume systems, etc.
end

function OnBubbleShow(serverId, channel, text)
    -- serverId: number — server ID of the player with the bubble
    -- channel: string — 'me' or 'do'
    -- text: string — the bubble text
end