Skip to content

Configuration

How do I change the task cancellation button?#


lua
---@field table Key configuration for canceling actions.
--- Defines which key is used to cancel active actions (e.g., crafting, progress bars).
--- index: GTA key index | https://docs.fivem.net/docs/game-references/controls/
--- name: Display name shown to player
--- code: Key code reference | https://www.toptal.com/developers/keycode
--- Default: X key
Config.CancelKey = {
    index = 73, 
    name = "X",
    code = "KeyX",
}

How to enabled and customize Drawtext#


lua
---@field string Text drawing system for UI elements.
--- Determines which system is used to display interaction text on screen.
--- Supported: ox_lib, okokTextUI, ps-ui, qb-core
--- Use "auto" to automatically detect an available system.
--- Default: auto
Config.DrawText = "auto"

---@field string Interaction key label displayed to players.
--- This text appears on screen when the player can interact with something.
--- Example: "[E]"
--- Default: [E]
Config.InteractionKeyLabel = "[E]"

---@field number Interaction key index.
--- GTA control index for the interaction key.
--- Default corresponds to "E".
--- Default: 38
Config.InteractionKeyIndex = 38

How to enabled and customize Target#


lua
---@field boolean Whether to use a target system for interactions.
--- If enabled, interactions will be handled via a target system instead of key press.
--- Disable if you are not using qb-target or ox_target.
--- Default: true
Config.UseTarget = true

---@field string Target system to use.
--- Defines which target script handles interactions.
--- Supported: ox_target, qb-target
--- Ignored if UseTarget is set to false.
--- Default: ox_target
Config.Target = "ox_target"

How to enabled and customize Radialmenu#


lua
---@field boolean Whether to use radial menu for interactions.
--- If enabled, interactions can be accessed via a radial menu instead of direct interaction.
--- Default: false
Config.UseRadialMenu = false

---@field string Radial menu system to use.
--- Defines which script provides radial menu functionality.
--- Supported: ox_lib
--- Default: ox_lib
Config.RadialMenu = "ox_lib"

What is the purpose of bot rental settings?#


lua
---@field table Boat rental system configuration.
--- Controls the boat rental feature where players can rent a boat from an NPC to go fishing in deeper waters.
--- isEnabled: Enable or disable the boat rental system entirely (true/false)
--- feeAmount: The cost in game currency for renting a boat
--- vehicle: Table containing the boat model information (hash, model name, display label)
--- ped: Table containing the NPC model that acts as the boat rental vendor
--- locations: List of rental locations, each with pedCoords (NPC position) and vehicleCoords (boat spawn position)
Config.BoatRental = {
    isEnabled = true,
    feeAmount = 5000,
    vehicle = {
        hash = `dinghy3`,
        model = "dinghy3",
        displayLabel = "Dinghy 3",
    },
    ped = {
        model = `a_m_y_jetski_01`,
    },
    locations = {
        {
            pedCoords = vec4(-1807.62, -1236.06, 0.62, 333.19),
            vehicleCoords = vec4(-1798.51, -1230.46, 0.14, 146.78),
        },
        {
            pedCoords = vec4(-3112.59, -75.97, 4.58, 327.59),
            vehicleCoords = vec4(-3121.64, -65.44, 0.91, 149.13),
        },
        {
            pedCoords = vec4(-3425.55, 951.72, 8.35, 3.68),
            vehicleCoords = vec4(-3421.74, 946.44, 0.21, 94.81),
        },
        {
            pedCoords = vec4(-2688.26, 3692.17, 4.52, 261.13),
            vehicleCoords = vec4(-2682.44, 3704.71, 0.4, 83.51),
        },
        {
            pedCoords = vec4(-1604.96, 5256.53, 2.07, 297.9),
            vehicleCoords = vec4(-1603.32, 5259.8, 0.12, 22.9),
        },
        {
            pedCoords = vec4(2946.2, -644.98, 4.47, 92.14),
            vehicleCoords = vec4(2941.17, -658.05, 0.5, 263.93),
        }
    }
}