Configuration Guide

This guide explains how to configure LC Thrusters to fit your FiveM server's needs. All settings are found in the config.lua file.


Vehicles

The spawn names of the vehicles that come with the thruster package installed. Every vehicle of these models has thrusters.

Config.Vehicles = {
    ["raiden"] = true,
    ["virtue"] = true,
}

The nozzles are placed automatically from each vehicle's size and wheels, so any car model works without extra settings.


Database

The database is optional. With it enabled, admins (and other scripts, through the exports) can install the package on single vehicles by plate, on top of Config.Vehicles, and the tank level of installed and player-owned vehicles is saved, so a respawned car keeps it. With it disabled, only Config.Vehicles have the package and every tank starts full after a restart.

Config.Database = {
    enabled = false,
    installCommand = "thrusters_install",   -- Installs the package on the vehicle the admin sits in
    removeCommand = "thrusters_remove",     -- Removes it
}

Admin commands

The commands act on the vehicle the admin is sitting in. They are restricted: give the ACE permission command.<name> to the groups that can use them.

server.cfg
add_ace group.admin command.thrusters_install allow
add_ace group.admin command.thrusters_remove allow
โš ๏ธ

Vehicles that have the package by model (Config.Vehicles) can't have it removed by plate.


Air Tank

The compressed air tank is shared by every thruster. It's refilled by an onboard compressor while someone drives the vehicle. The last 20% of the tank is reserved for the flight assists: the player's own actions (boost, lift, stunts, fan) stop there.

Config.Tank = {
    capacity = 50.0,            -- Tank size
    rechargeRate = 1.0,         -- Refilled per second by the onboard compressor while someone drives the vehicle
}

Boost

The 4 rear thrusters push the car forward while the key is held. Fired too long, they overheat and stay locked until fully cooled down.

Config.Boost = {
    enabled = true,
    key = "LSHIFT",             -- Default keybind
    maxSpeed = 350.0,           -- km/h above which the boost stops pushing
    maxDuration = 1000,         -- ms of firing before it overheats
    cooldown = 3000,            -- ms to cool down from empty. Overheated, it's locked until fully cooled
}

Lift and Flight Assists

The lift makes the car climb while the key is held. The flight assists can be allowed or blocked for the whole server here. Each driver can also turn them off for themselves in the control panel.

Config.Flight = {
    enabled = true,
    key = "SPACE",              -- Default keybind, hold it to climb
    climbSpeed = 6.0,           -- m/s upward while the key is held
    maxClimbTime = 2000,        -- ms of climbing per flight (resets when the car is back on the ground)
    stabilityControl = true,    -- In every jump: keeps the car level and pointing where it travels. Off: only in flights started with the key
    landingAssist = true,       -- Falling: free fall, then a late burn for a soft touchdown
    stunts = true,              -- In the air, A/D roll and W/S pitch the car with the thrusters (kickflips, flips)
}

maxClimbTime limits how high a car can go in one flight. Raise it to let the cars fly higher.


Underbody Fan

The fan sucks the car to the surface under it, so it can drive on banked, vertical and upside-down track.

Config.Suction = {
    enabled = true,
    key = "LCONTROL",           -- Default keybind, press to toggle the fan
}

Interface

The driving readout shows the thrusters while driving a car with the package, and the control panel lets each driver turn the assists and the fan on or off. Drivers can hide the readout and move it to another corner. Their choices are remembered.

Config.Interface = {
    hud = true,                     -- Readout of the thrusters while driving a car with the package
    hudPosition = "bottom-right",   -- Default corner: "top-left", "top-right", "bottom-left" or "bottom-right"
    hudKey = "F9",                  -- Default keybind to hide or show the readout
    panelKey = "F7",                -- Default keybind to open the control panel
}

Effects

Thruster plumes and sounds, seen and heard by every player near the vehicle.

Config.Effects = {
    enabled = true,
    groundSmoke = true,         -- Smoke on the ground under the car while it lifts near it
    volume = 0.5,               -- Thruster sound volume (0..1, 0 = no sound)
}

Keybinds

โš ๏ธ

The key settings are only the default keys. FiveM saves each player's key bindings, so changing them in the config doesn't change the keys of players who already joined. They can rebind them in GTA settings > Key Bindings > FiveM.