Configuration#

Options live in editable/config.lua. Server hooks are in editable/server.lua and client hooks in editable/client.lua. Restart the resource after a change.

General#

Theme#

Config.Theme = {
    style = 'appearance',
    accent = nil,
    playerChoice = true,
}

Speech bubbles#

Config.Bubbles = {
    enabled = true,
    max = 6,
    distance = 18.0,
    duration = 7000,
    showSelf = true,
    channels = { ['local'] = true },
}

Overhead text and typing indicator#

Config.OverheadText = { enabled = true, duration = 7000, distance = 15.0 }
Config.TypingIndicator = { enabled = true, distance = 12.0 }

OverheadText is the plain GTA 3D text for /me, /do and /try. It is used when Config.Bubbles.enabled is false. TypingIndicator shows ... above players who have the chat open, as a bubble or as 3D text. It uses the player state kojaTyping.

Images#

Config.Images = {
    enabled = true,
    hosts = { 'i.imgur.com', 'cdn.discordapp.com', 'media.discordapp.net', 'media.tenor.com', 'i.ibb.co' },
    paste = {
        enabled = true,
        maxSide = 720,
        maxKB = 180,
        cooldown = 10,
    },
}

The server accepts only PNG, JPEG and WebP data, never URLs, SVG or HTML.

Binds#

Config.Binds = { enabled = true, max = 20 }

enabled = false turns off /bind, /unbind and /binds. max is the number of binds per player.

Developer mode#

Config.DevMode = {
    enabled = false,
    ace = 'koja-chat.dev',
    execute = false,
    backlog = 200,
    clientConsole = true,
}

The Console tab needs RegisterConsoleListener on the server build. Without it the console prints a warning and the tab only shows the commands. Executed commands are printed to the server console and logged to Discord under console.

add_ace group.admin koja-chat.dev allow

Permissions#

Departments#

Config.Departments = {
    police = { label = 'LSPD', color = '#3b82f6', jobs = { 'police', 'sheriff' } },
    ems = { label = 'EMS', color = '#ef4444', jobs = { 'ambulance' } },
    mechanic = { label = 'MECH', color = '#f59e0b', jobs = { 'mechanic' } },
}
Config.DepartmentsRequireDuty = false

A channel with department = true (the /dep command) shows the department label and colour of the player, and players only see messages of their own department. DepartmentsRequireDuty = true puts a player in the department only while on duty. Tabs are refreshed when the job or duty changes on ESX and QBCore.

Channels#

Each entry is a tab. The order is the tab order.

Config.Channels = {
    { id = 'local', label = 'ch_local', color = '#a78bfa', icon = 'users', range = 20.0 },
    { id = 'ooc', label = 'ch_ooc', color = '#94a3b8', icon = 'globe', nameMode = 'player' },
    { id = 'social', label = 'ch_social', color = '#38bdf8', icon = 'megaphone' },
    { id = 'dep', label = 'ch_dep', color = '#3b82f6', icon = 'shield', department = true },
    { id = 'admin', label = 'ch_admin', color = '#ef4444', icon = 'crown', admin = true, nameMode = 'player' },
    { id = 'system', label = 'ch_system', color = '#f59e0b', icon = 'bell', readonly = true, hidden = true },
}

Icons: users, globe, megaphone, shield, crown, bell, at, mask, mail, flag, info, alert, radio, siren, star, heart, wrench, newspaper, sparkles, clock, mute.

Other resources add channels with RegisterChannel.

Commands#

Config.Commands is keyed by command name. Set enabled = false to remove one. A command with a channel posts its text to that channel:

The other commands (pm, r, report, mute, poll and so on) have their own logic in server/commands.lua, and commands with client = true run on the client. See Commands for the defaults.

Moderation#

Staff bypass all of it.

Config.AntiSpam = {
    enabled = true,
    interval = 700,
    burst = 5,
    window = 8,
    duplicate = true,
    duplicateWindow = 15,
    autoMute = { strikes = 5, minutes = 5 },
}

Config.Filter = {
    enabled = true,
    block = false,
    replace = '*',
    blockLinks = false,
    words = {},
}

/slowmode works even when AntiSpam.enabled is false. Mutes are stored by license in the resource KVP, so they survive reconnects and restarts.

Discord logs#

Config.Logs = {
    enabled = false,
    webhook = '',
    channels = {},
    pm = true,
    reports = true,
    moderation = true,
}

Every entry shows the player, the channel, the character name and the license and Discord identifiers.

Editable files#

editable/server.lua

info is { id, name, player, job, jobLabel, grade, gradeLabel, onDuty, department, admin }.

editable/client.lua