Configuration

⚙️ Configuration Documentation – Tire Wear System

This page documents all configurable options available in the config.lua file for the Tire Wear System. Adjust these settings to control tire degradation behavior, grip loss, UI visibility, and more.

---

🔧 Config.Balancers

You can define the balancer locations and their appearance in the Config.Balancers table. Each entry contains:

• id: A unique identifier for the balancer

• coords: World coordinates (vector3) where the prop should be spawned

• heading: The direction the prop should face

• prop: The object model (e.g., imp_prop_wheel_balancer_01a)

Config.Balancers = {
    {
        id = 'test',
        coords = vector3(746.1563, -887.7756, 25.0749),
        heading = 357.5883,
        prop = 'imp_prop_wheel_balancer_01a'
    }
}

---

🔧 Config.Divisions

Defines how much tire health is reduced per check cycle under various conditions.

Config.Divisions = {
    drift = 0.1,
    burnout = 0.1,
    speedlow = 0.0025,
    speedhigh = 0.005
}

• drift: HP loss per cycle while drifting

• burnout: HP loss during burnout

• speedlow: HP loss at medium speeds (Lowspeed–Highspeed)

• speedhigh: HP loss at high speed (above Highspeed)

---

🔥 Config.TireGripLevels

Defines average tire health thresholds that determine grip levels.

Config.TireGripLevels = {
    high = 80,
    medium = 60,
    low = 30,
    critical = 0
}

Used to determine the current grip state (high, medium, low, critical).

---

🎯 Config.GripMultipliers

Grip multipliers applied to vehicle handling based on the grip level.

Config.GripMultipliers = {
    high = 1.0,
    medium = 0.95,
    low = 0.85,
    critical = 0.45
}

• Values < 1.0 simulate reduced grip due to tire wear.

• Applied directly to fTractionCurveMin, fTractionCurveMax.

---

⛽ Config.TractionLossBase

Additional traction loss modifier when grip is lowered.

Config.TractionLossBase = 0.5

Multiplied by the grip reduction to increase fLowSpeedTractionLossMult.

---

🔔 Config.SendNotify

Controls whether a notification is shown when grip level changes.

Config.SendNotify = {
    high = true,
    medium = true,
    low = true,
    critical = true
}

---

📈 Config.Lowspeed and Config.Highspeed

Speed thresholds in km/h used to determine tire wear rates.

Config.Lowspeed = 60.0
Config.Highspeed = 110.0

---

💥 Config.PopOnZero

Whether tires should pop when their health reaches 0.

Config.PopOnZero = true

---

⏱️ Config.CheckInterval

How frequently tire checks and degradation occur (in milliseconds).

Config.CheckInterval = 100

---

🗺️ Config.LoadDistance

Not currently used, but can be reserved for future optimizations.

Config.LoadDistance = 50.0

---

🧾 Config.Locale

Localizable notification and label strings.

Config.Locale = {
    ['wheel_fl'] = 'Front left tire on/off',
    ['medium_notify'] = 'The vehicle\'s tires are slightly worn...',
    ...
}

You may customize these for multilingual support.

---

🛠️ Config.BalancerProp

Prop hash used for visual tire balancing machine.

Config.BalancerProp = `imp_prop_wheel_balancer_01a`

---

🖥️ UI Options

Config.UseTireUI = true
Config.UseDebugUI = false

• UseTireUI: Show tire wear UI overlay.

• UseDebugUI: Show debug interface (only for testing).

---

🔔 Notification System

You may define a custom notification handler if desired.

Config.CustomNotify = nil

Or here is an example how can you use custom notify:

Config.CustomNotify = function(message, type)
    exports['mythic_notify']:SendAlert(type, message)
end

If not defined, default GTA notification will be used.

Config.NotifyTypes = {
    medium = 'info',
    low = 'warning',
    critical = 'error'
}

---

🧑‍💻 Config.WhiteList

Whitelist of player identifiers who can use the system.

Config.WhiteList = {
    '573264cb30c49f55905a14ab061d6549d2ed9495'
}

---

Under this line is the LibConfig (lib_config.lua)

If you dont know what to do, go to this ox docs site: https://overextended.dev/ox_lib/Modules/Interface/Client/progress

---

🖥️ Progressbar Options

• LibConfig.UseLinearProg: Use ox_lib default linear progress bar.

• LibConfig.UseRadialProg: Use ox_lib radial/circle progress bar.

Config.UseTireUI = true
Config.UseDebugUI = false

---

🧮 LibConfig.ProgBarTable

Progressbar settings. Here is an example:

LibConfig.ProgBarTable = {
    duration = Config.ChangeTime*1000, -- DONT EDIT
    label = Config.Locale['change_wheel'], -- DONT EDIT
    useWhileDead = false,
    canCancel = false,
    disable = {
        move = true,
        car = true,
        combat = true,
        mouse = true,
        sprint = true,
    },
    anim = {
        scenario = 'WORLD_HUMAN_INSPECT_CROUCH',
    },
}

---

🎯 LibConfig.TargetIcon

The icon used for target interactions.

LibConfig.TargetIcon = 'fa-solid fa-wrench'