Koja Scripts
KOJA-LIB

Configuration

All configuration lives in editable/shared/config.lua.

Configuration

All configuration lives in editable/shared/config.lua. This is the only file you need to edit for basic setup.

Config.Framework

Controls which server framework koja-lib uses.

Config.Framework = "auto"
ValueBehaviour
"auto"Detects es_extended, qbx_core, or qb-core automatically (in that order)
"esx"Force ESX
"qb"Force QBCore / Qbox
"custom"Use your own implementation in editable/custom/framework_*.lua

Config.Inventory

Controls which inventory system koja-lib uses.

Config.Inventory = "auto"
ValueBehaviour
"auto"Detects the running inventory resource automatically
"ox_inventory"Force ox_inventory
"qb-inventory"Force qb-inventory
"qs-inventory"Force qs-inventory
"codem-inventory"Force codem-inventory
"jaksam_inventory"Force jaksam_inventory
"custom"Use your own implementation in editable/custom/inventory_*.lua

Config.Notify

Controls which notification system is used by KOJA.Client.SendNotify and KOJA.Server.SendNotify.

Config.Notify = "esx"
ValueSystem
"esx"ESX built-in notifications
"qb"QBCore notifications
"ox"ox_lib notify
"lib"koja-lib built-in notify

Config.PoliceGroups

A map of job names that are considered police. Used by KOJA.Server.GetCopCount().

Config.PoliceGroups = {
    ["police"] = true,
    ["sheriff"] = true,
    ["fbi"]     = true,
}

Config.Laser

Configuration for the built-in laser pointer command.

Config.Laser = {
    enable  = true,
    command = 'laser',
}

Config.SaveVehicleConfig

Controls how license plates are generated by KOJA.Server.GeneratePlate().

Config.SaveVehicleConfig = {
    Charset       = "ABCDEFGHIJKLMNOPQRSTUVWXYZ",
    NumberCharset = "0123456789",
    Letters       = 4,    -- number of letters
    Numbers       = 4,    -- number of digits
    Separator     = "",   -- character between letters and digits
}

Example plate with default config: ABCD1234

Config.UI

Appearance settings for the progress bar and Text UI.

Config.UI = {
    ProgressBar = {
        theme        = "darkBlack",  -- orange | darkGray | darkBlack | navy | green | purple | red
        bottomOffset = 1,            -- distance from bottom in vw
    },
    TextUI = {
        theme        = "darkBlack",
        bottomOffset = 5.5,
    },
}

Config.Debug

Enables console output for internal errors and debug messages.

Config.Debug = false
  • Installation — Dependency Required Notes ----------------------- -------- ---------------------------------- oxmysql Yes Database driver esextended No Required only for ESX framework qb-core o…
  • Getting Started — back to the section overview