⚙️Configuration

Check the instructions below.

The primary configuration file is config.lua. Below is a detailed explanation of all the settings.


General Settings

Setting
Description
Default Value

Config.UseKmh

Set the speed unit (kmh or mph).

"kmh"

Config.ComehereModSpeed

Speed for the /comehere command.

40.0

Config.ComehereModDriveStyle

Drive style for the /comehere command.

262701

Config.EmergencyLocation

Coordinates for emergency mode.

{x = 298.0, y = -584.0, z = 43.3}

Config.EmergencyDrivingStyle

Driving style for emergency mode.

262692


Autopilot Settings

Setting
Description
Default Value

Config.speedMultiplier

Speed multipliers for different driving modes: ecomode, sportmode, sportPlus, emergency.

Varies

Config.Vehicles

List of vehicle models with autopilot enabled.

neon, dilettante, etc.


Fixed Locations

Define fixed destinations that can be used for navigation.

Config.FixedLocations = {
    policeStation = {
        coords = {x = 402.81, y = -1021.98, z = 28.69},
        icon = "directions/fixedlocations",
    },
    hospital = {
        coords = {x = 298.0, y = -584.0, z = 43.3},
        icon = "directions/fixedlocations",
    },
    ...
}

Controls

Customize the key bindings for autopilot functions.

Key
Function
Default Value

Config.Keys["E"]

Submit park position.

38 (E)

Config.Keys["H"]

Cancel parking.

74 (H)

Config.Keys["K"]

Open cursor on autopilot screen.

311 (K)

Config.Keys["U"]

Cancel trip.

303 (U)


Notify Texts

Customizable notification messages for various events.

Event
Default Text

parkingPilot

"Parking Pilot Activated."

parkingPilot_stop

"Parking Pilot Stopped."

autoPilot_start

"AutoPilot %s Activated."

autoPilot_stop

"AutoPilot %s Stopped."

reach_destination

"We've reached our destination."

vehicle_came_to_you

"%s arrived to you"

not_in_vehicle

"You are not in vehicle"

cant_come

"We've lost contact with your vehicle"


Speed Limits

Define street-specific speed limits. These limits will dynamically adapt to the autopilot's driving style.

Example configuration:

Config.SpeedLimits = {
    ["East Joshua Road"] = "50",
    ["Marina Dr"] = "35",
    ["Great Ocean Hwy"] = "60",
    ...
}

Custom Notify Function

You can replace the default notification system with your custom logic:

function Notify(text, type, time)
    if QBCore ~= nil then
        QBCore.Functions.Notify(text, type or "primary", time or 5000)
    elseif ESX ~= nil then
        ESX.ShowNotification(text, type or "info", time or 5000)
    else
        -- Custom notification logic here
    end
end

Last updated