Config Files
Preview Of Config Files
```lua
Config = {
Debug = false, -- Enable debug mode (needs to be true if you want to restart the script without re-logging)
Framework = {
Type = 'qb',
ResourceName = 'qb-core',
},
Events = {
["Client:PlayerLoaded"] = "QBCore:Client:OnPlayerLoaded",
["Server:PlayerLoaded"] = "QBCore:Server:PlayerLoaded",
["Client:OnJobUpdate"] = "QBCore:Client:OnJobUpdate",
["Server:OnJobUpdate"] = "QBCore:Server:OnJobUpdate",
},
TextUI = "ox",
Radial = "ox",
Fuel = "LegacyFuel", -- The fuel system to use: "LegacyFuel
VehicleKeys = "qb-vehiclekeys",
Notifications = "ox", -- The notification system to use: (Currently supporting "qb", "ox", "okok", "qs-interface" or "custom")
Progressbar = "ox",
OpeningMethod = "textui", -- The method of opening the garage: "textui" or "radial",
ZoneMethod = "PolyZone", -- DON'T CHANGE IT, SOON WILL HAVE A SUPPORT FOR A MARKER
SaveVehicleMods = true, -- Save vehicle mods when storing the vehicle (true or false)
SaveVehicleDamage = true, -- Save vehicle damage when storing the vehicle (true or false)
UseServerSetter = true, -- Spawning the vehicle on the server side (Highly recommended), If you encounter any problems with the garages, try setting this to false
TransferGarages = {
Enabled = true, -- The ability to transfer garages
Price = 5000, -- The price to transfer the garage
Currency = "bank", -- The currency to use for the transfer
},
Depot = { -- "Depot" is making any destroyed or abondanded (entity deleted / despawned, not stored after server restart) vehicles stored in the impound
Enabled = true, -- If disabled, any destroyed or abandoned vehicles will be returned to the garages
RetrievalPrice = 500, -- The price to retrieve the vehicle from the depot (only if Depot is enabled)
Currency = "bank", -- The currency to use for the retrieval
ResetStats = true -- Reset the vehicle stats when retrieving from the depot (Engine health, Body health and Fuel)
},
Blips = {
Unique = { -- Creates a blip for each garage (Only for garages)
Enabled = true, -- Recommended to keep enabled
Category = { -- For more info: https://docs.fivem.net/natives/?_0x234CDD44D996FD9A
Category = 10,
CategoryHash = "BLIP_PROPCAT",
CategoryLabel = "Garages",
},
},
Options = {
Garages = {
Car = {
Sprite = 357,
Color = 3,
Scale = 0.6,
Name = "Garage", -- The name of the blip (Only if Unique is set to false)
},
Boat = {
Sprite = 356,
Color = 3,
Scale = 0.6,
Name = "Boat Garage", -- The name of the blip (Only if Unique is set to false)
},
Planes = {
Sprite = 427,
Color = 3,
Scale = 0.6,
Name = "Plane Garage", -- The name of the blip (Only if Unique is set to false)
},
Heli = {
Sprite = 360,
Color = 3,
Scale = 0.6,
Name = "Helicopter Garage", -- The name of the blip (Only if Unique is set to false)
},
},
Impounds = {
Sprite = 68,
Color = 5,
Scale = 0.7,
Name = "Impound", -- The name of the blip (Only if Unique is set to false)
},
}
},
CreationPerms = "god", -- The permission to create garages (if you want to use the garage creator)
Commands = {
Creator = { -- The command to open the garage creator menu (it will use the "CreationPerms" permission)
name = "garagecreator",
description = "Opens the garage creator menu",
args = {},
},
Impound = {
enabled = false, -- The command to open the impound menu
name = "impound",
description = "Opens the impound menu",
args = {},
}
},
CustomVehicles = { -- If you have custom vehicles without any name (name shows as null), put it here and the script will automatically giveit the name you choose
["vehiclemodel"] = "name"
}
}
```
```lua
Config.Locations = {
Garages = {
["legionsquare"] = {
Label = "Legion Square",
ZoneType = "Poly", -- (Only if ZoneMethod is set to "PolyZone") The type of zone: "Box", "Circle", or "Poly", (PolyZone recommended)
VehicleType = "car", -- The type of vehicle that can be spawned in this garage (car, boat, helicopter, plane)
Zone = {
Poly = { -- If ZoneType is set to "Poly", you need to set the points of the zone. If ZoneType is set to "Box" or "Circle", you can leave this empty.
BlipCoords = vector3(221.5046, -791.8495, 30.7374), -- The coordinates of the blip
Points = {
vector2(219.33413696289, -754.76727294922),
vector2(264.76126098633, -770.07183837891),
vector2(258.41311645508, -786.76330566406),
vector2(252.724609375, -784.79724121094),
vector2(239.87539672852, -820.42498779297),
vector2(200.05744934082, -805.74554443359)
},
MinZ = 29.0,
MaxZ = 32.0,
},
Box = { -- If ZoneType is set to "Box", you need to set the coordinates of the zone. If ZoneType is set to "Poly" or "Circle", you can leave this empty.
Coords = vector3(0.0, 0.0, 0.0),
MinZ = 0.0, -- The minimum Z coordinate of the zone
MaxZ = 0.0, -- The maximum Z coordinate of the zone
Width = 0.0, -- The width of the zone
Length = 0.0, -- The length of the zone
Heading = 0.0, -- The heading of the zone
},
Circle = { -- If ZoneType is set to "Circle", you need to set the coordinates of the zone. If ZoneType is set to "Poly" or "Box", you can leave this empty.
Coords = vector3(0.0, 0.0, 0.0), -- The coordinates of the zone (only if ZoneType is set to "Box", "Circle" or if ZoneMethod is set to "marker")
MinZ = 0.0, -- The minimum Z coordinate of the zone
MaxZ = 0.0, -- The maximum Z coordinate of the zone
Radius = 0.0, -- The radius of the zone
},
Marker = { -- If ZoneMethod is set to "marker", you need to set the coordinates of the zone. If ZoneType is set to "Poly", "Box" or "Circle", you can leave this empty.
Coords = vector3(0.0, 0.0, 0.0), -- The coordinates of the zone (only if ZoneType is set to "Box", "Circle" or if ZoneMethod is set to "marker")
Radius = 0.0, -- The radius of the zone
}
},
Spawns = { -- The coordinates of the spawn points (x, y, z, heading)
vector4(215.8397, -804.3382, 30.3769, 68.2296),
vector4(206.3964, -800.8099, 30.5748, 248.6397),
vector4(207.6522, -798.6400, 30.5517, 247.8735),
vector4(216.4369, -801.9312, 30.3685, 68.3629),
vector4(221.7290, -804.0094, 30.2582, 249.1331),
vector4(220.9876, -806.4854, 30.2603, 250.0432),
vector4(219.8478, -808.8682, 30.2581, 248.2030),
vector4(231.1153, -810.5448, 30.0097, 68.6349),
vector4(231.9452, -807.9769, 30.0212, 67.6774),
vector4(236.8945, -812.6904, 29.8592, 248.4091),
vector4(237.5616, -810.2947, 29.8775, 248.5383)
},
HideBlip = false,
Job = "all", -- The job that will be able to access this garage (if set to "all", all jobs will be able to access this garage)
},
["elgineave"] = {
Label = "Elgin Ave",
ZoneType = "Poly", -- (Only if ZoneMethod is set to "PolyZone") The type of zone: "Box", "Circle", or "Poly", (PolyZone recommended)
VehicleType = "car", -- The type of vehicle that can be spawned in this garage (car, boat, helicopter, plane)
Zone = {
Poly = { -- If ZoneType is set to "Poly", you need to set the points of the zone. If ZoneType is set to "Box" or "Circle", you can leave this empty.
BlipCoords = vector3(128.4763, -1071.4108, 29.1920), -- The coordinates of the blip
Points = {
vector2(96.162246704102, -1078.1395263672),
vector2(112.63620758057, -1084.2110595703),
vector2(164.15615844727, -1084.8646240234),
vector2(167.96192932129, -1084.0079345703),
vector2(172.46705627441, -1083.9357910156),
vector2(172.27719116211, -1072.2192382812),
vector2(157.5221862793, -1066.2298583984),
vector2(157.04708862305, -1067.3747558594),
vector2(155.32461547852, -1067.2326660156),
vector2(150.67858886719, -1064.8952636719),
vector2(151.00129699707, -1063.9035644531),
vector2(146.92054748535, -1060.7680664062),
vector2(143.056640625, -1058.9990234375),
vector2(127.0376739502, -1054.0628662109),
vector2(126.30777740479, -1054.05859375),
vector2(126.91122436523, -1051.6080322266),
vector2(119.52244567871, -1049.4255371094),
vector2(117.34883117676, -1048.9011230469),
vector2(110.08473205566, -1046.1666259766)
},
MinZ = 27.0,
MaxZ = 32.0,
},
Box = { -- If ZoneType is set to "Box", you need to set the coordinates of the zone. If ZoneType is set to "Poly" or "Circle", you can leave this empty.
Coords = vector3(0.0, 0.0, 0.0),
MinZ = 0.0, -- The minimum Z coordinate of the zone
MaxZ = 0.0, -- The maximum Z coordinate of the zone
Width = 0.0, -- The width of the zone
Length = 0.0, -- The length of the zone
Heading = 0.0, -- The heading of the zone
},
Circle = { -- If ZoneType is set to "Circle", you need to set the coordinates of the zone. If ZoneType is set to "Poly" or "Box", you can leave this empty.
Coords = vector3(0.0, 0.0, 0.0), -- The coordinates of the zone (only if ZoneType is set to "Box", "Circle" or if ZoneMethod is set to "marker")
MinZ = 0.0, -- The minimum Z coordinate of the zone
MaxZ = 0.0, -- The maximum Z coordinate of the zone
Radius = 0.0, -- The radius of the zone
},
Marker = { -- If ZoneMethod is set to "marker", you need to set the coordinates of the zone. If ZoneType is set to "Poly", "Box" or "Circle", you can leave this empty.
Coords = vector3(0.0, 0.0, 0.0), -- The coordinates of the zone (only if ZoneType is set to "Box", "Circle" or if ZoneMethod is set to "marker")
Radius = 0.0, -- The radius of the zone
}
},
Spawns = { -- The coordinates of the spawn points (x, y, z, heading)
vector4(104.2886, -1077.9949, 28.7690, 340.6927),
vector4(107.8394, -1079.9042, 28.7694, 340.4357),
vector4(111.5875, -1080.7030, 28.7687, 338.3393),
vector4(106.0488, -1062.9773, 28.7818, 243.4754),
vector4(107.7135, -1059.6920, 28.7774, 247.5759),
vector4(109.2689, -1056.5034, 28.7725, 246.8227),
},
HideBlip = false,
Job = "all", -- The job that will be able to access this garage (if set to "all", all jobs will be able to access this garage)
},
["vespucciheli"] = {
Label = "Vespucci Helipad",
ZoneType = "Poly", -- (Only if ZoneMethod is set to "PolyZone") The type of zone: "Box", "Circle", or "Poly", (PolyZone recommended)
VehicleType = "heli", -- The type of vehicle that can be spawned in this garage (car, boat, helicopter, plane)
Zone = {
Poly = { -- If ZoneType is set to "Poly", you need to set the points of the zone. If ZoneType is set to "Box" or "Circle", you can leave this empty.
BlipCoords = vector3(-736.7449, -1454.6594, 5.0005), -- The coordinates of the blip
Points = {
vector2(-680.04162597656, -1442.4400634766),
vector2(-679.77935791016, -1452.5269775391),
vector2(-691.68603515625, -1464.857421875),
vector2(-698.58715820312, -1472.9013671875),
vector2(-707.25860595703, -1485.0769042969),
vector2(-709.76293945312, -1489.58203125),
vector2(-719.44024658203, -1492.6961669922),
vector2(-725.71893310547, -1493.1115722656),
vector2(-728.49761962891, -1494.4836425781),
vector2(-760.44415283203, -1467.0974121094),
vector2(-767.09710693359, -1472.7103271484),
vector2(-788.31182861328, -1457.8232421875),
vector2(-749.95294189453, -1411.6588134766),
vector2(-743.95404052734, -1416.4934082031),
vector2(-733.6748046875, -1406.0450439453),
vector2(-729.53839111328, -1400.1280517578)
},
MinZ = 3.0,
MaxZ = 8.0,
},
Box = { -- If ZoneType is set to "Box", you need to set the coordinates of the zone. If ZoneType is set to "Poly" or "Circle", you can leave this empty.
Coords = vector3(0.0, 0.0, 0.0),
MinZ = 0.0, -- The minimum Z coordinate of the zone
MaxZ = 0.0, -- The maximum Z coordinate of the zone
Width = 0.0, -- The width of the zone
Length = 0.0, -- The length of the zone
},
Circle = { -- If ZoneType is set to "Circle", you need to set the coordinates of the zone. If ZoneType is set to "Poly" or "Box", you can leave this empty.
Coords = vector3(0.0, 0.0, 0.0), -- The coordinates of the zone (only if ZoneType is set to "Box", "Circle" or if ZoneMethod is set to "marker")
MinZ = 0.0, -- The minimum Z coordinate of the zone
MaxZ = 0.0, -- The maximum Z coordinate of the zone
Radius = 0.0, -- The radius of the zone
},
Marker = { -- If ZoneMethod is set to "marker", you need to set the coordinates of the zone. If ZoneType is set to "Poly", "Box" or "Circle", you can leave this empty.
Coords = vector3(0.0, 0.0, 0.0), -- The coordinates of the zone (only if ZoneType is set to "Box", "Circle" or if ZoneMethod is set to "marker")
Radius = 0.0, -- The radius of the zone
}
},
Spawns = { -- The coordinates of the spawn points (x, y, z, heading)
vector4(-723.7527, -1443.0399, 4.7371, 142.5394),
},
HideBlip = false,
Job = "all", -- The job that will be able to access this garage (if set to "all", all jobs will be able to access this garage)
},
["vespuccidoc"] = {
Label = "Vespucci Dock",
ZoneType = "Box", -- (Only if ZoneMethod is set to "PolyZone") The type of zone: "Box", "Circle", or "Poly", (PolyZone recommended)
VehicleType = "boat", -- The type of vehicle that can be spawned in this garage (car, boat, helicopter, plane)
Zone = {
Poly = { -- If ZoneType is set to "Poly", you need to set the points of the zone. If ZoneType is set to "Box" or "Circle", you can leave this empty.
BlipCoords = vector3(0.0, 0.0, 0.0), -- The coordinates of the blip
Points = {
vector2(0.0, 0.0),
vector2(0.0, 0.0),
vector2(0.0, 0.0),
},
MinZ = 0.0,
MaxZ = 0.0,
},
Box = { -- If ZoneType is set to "Box", you need to set the coordinates of the zone. If ZoneType is set to "Poly" or "Circle", you can leave this empty.
Coords = vector3(-787.77, -1498.15, 3.75),
MinZ = -1.5, -- The minimum Z coordinate of the zone
MaxZ = 4.0, -- The maximum Z coordinate of the zone
Width = 21.6, -- The width of the zone
Length = 34.8, -- The length of the zone,
Heading = 20,
},
Circle = { -- If ZoneType is set to "Circle", you need to set the coordinates of the zone. If ZoneType is set to "Poly" or "Box", you can leave this empty.
Coords = vector3(0.0, 0.0, 0.0), -- The coordinates of the zone (only if ZoneType is set to "Box", "Circle" or if ZoneMethod is set to "marker")
MinZ = 0.0, -- The minimum Z coordinate of the zone
MaxZ = 0.0, -- The maximum Z coordinate of the zone
Radius = 0.0, -- The radius of the zone
},
Marker = { -- If ZoneMethod is set to "marker", you need to set the coordinates of the zone. If ZoneType is set to "Poly", "Box" or "Circle", you can leave this empty.
Coords = vector3(0.0, 0.0, 0.0), -- The coordinates of the zone (only if ZoneType is set to "Box", "Circle" or if ZoneMethod is set to "marker")
Radius = 0.0, -- The radius of the zone
}
},
Spawns = { -- The coordinates of the spawn points (x, y, z, heading)
vector4(-723.7527, -1443.0399, 4.7371, 142.5394),
},
HideBlip = false,
Job = "all", -- The job that will be able to access this garage (if set to "all", all jobs will be able to access this garage)
},
["policmrpd"] = {
Label = "Mission Row Garage",
ZoneType = "Box", -- (Only if ZoneMethod is set to "PolyZone") The type of zone: "Box", "Circle", or "Poly", (PolyZone recommended)
VehicleType = "heli", -- The type of vehicle that can be spawned in this garage (car, boat, helicopter, plane)
Zone = {
Poly = { -- If ZoneType is set to "Poly", you need to set the points of the zone. If ZoneType is set to "Box" or "Circle", you can leave this empty.
BlipCoords = vector3(0.0, 0.0, 0.0), -- The coordinates of the blip
Points = {
vector2(0.0, 0.0),
vector2(0.0, 0.0),
vector2(0.0, 0.0),
},
MinZ = 0.0,
MaxZ = 0.0,
},
Box = { -- If ZoneType is set to "Box", you need to set the coordinates of the zone. If ZoneType is set to "Poly" or "Circle", you can leave this empty.
Coords = vector3(454.23, -1018.62, 28.39),
MinZ = 27.0, -- The minimum Z coordinate of the zone
MaxZ = 30.0, -- The maximum Z coordinate of the zone
Width = 11.8, -- The width of the zone
Length = 4.6, -- The length of the zone
Heading = 0.0
},
Circle = { -- If ZoneType is set to "Circle", you need to set the coordinates of the zone. If ZoneType is set to "Poly" or "Box", you can leave this empty.
Coords = vector3(0.0, 0.0, 0.0), -- The coordinates of the zone (only if ZoneType is set to "Box", "Circle" or if ZoneMethod is set to "marker")
MinZ = 0.0, -- The minimum Z coordinate of the zone
MaxZ = 0.0, -- The maximum Z coordinate of the zone
Radius = 0.0, -- The radius of the zone
},
Marker = { -- If ZoneMethod is set to "marker", you need to set the coordinates of the zone. If ZoneType is set to "Poly", "Box" or "Circle", you can leave this empty.
Coords = vector3(0.0, 0.0, 0.0), -- The coordinates of the zone (only if ZoneType is set to "Box", "Circle" or if ZoneMethod is set to "marker")
Radius = 0.0, -- The radius of the zone
}
},
Spawns = { -- The coordinates of the spawn points (x, y, z, heading)
vector4(-723.7527, -1443.0399, 4.7371, 142.5394),
},
HideBlip = true,
Job = "police", -- The job that will be able to access this garage (if set to "all", all jobs will be able to access this garage)
},
},
Impounds = {
["legionsquare"] = {
Label = "Mission Row Impound",
ZoneType = "Box", -- (Only if ZoneMethod is set to "PolyZone") The type of zone: "Box", "Circle", or "Poly", ("Poly" recommended)
Zone = {
Poly = { -- If ZoneType is set to "Poly", you need to set the points of the zone. If ZoneType is set to "Box" or "Circle", you can leave this empty.
BlipCoords = vector3(0.0, 0.0, 0.0), -- The coordinates of the blip
Points = {
vector2(0.0, 0.0),
vector2(0.0, 0.0),
vector2(0.0, 0.0),
},
MinZ = 0.0,
MaxZ = 0.0,
},
Box = { -- If ZoneType is set to "Box", you need to set the coordinates of the zone. If ZoneType is set to "Poly" or "Circle", you can leave this empty.
Coords = vector3(436.35, -1027.43, 28.74),
MinZ = 26.0, -- The minimum Z coordinate of the zone
MaxZ = 30.0, -- The maximum Z coordinate of the zone
Width = 4.4, -- The width of the zone
Length = 21.4, -- The length of the zone
Heading = 6, -- The heading of the zone
},
Circle = { -- If ZoneType is set to "Circle", you need to set the coordinates of the zone. If ZoneType is set to "Poly" or "Box", you can leave this empty.
Coords = vector3(0.0, 0.0, 0.0), -- The coordinates of the zone (only if ZoneType is set to "Box", "Circle" or if ZoneMethod is set to "marker")
MinZ = 0.0, -- The minimum Z coordinate of the zone
MaxZ = 0.0, -- The maximum Z coordinate of the zone
Radius = 0.0, -- The radius of the zone
},
Marker = { -- If ZoneMethod is set to "marker", you need to set the coordinates of the zone. If ZoneType is set to "Poly", "Box" or "Circle", you can leave this empty.
Coords = vector3(0.0, 0.0, 0.0), -- The coordinates of the zone (only if ZoneType is set to "Box", "Circle" or if ZoneMethod is set to "marker")
Radius = 0.0, -- The radius of the zone
}
},
Spawns = {
vector4(432.8270, -1027.1969, 28.4674, 358.6703), -- The coordinates of the spawn points (x, y, z, heading)
vector4(427.4425, -1027.9377, 28.5639, 7.2138),
},
HideBlip = false,
},
["hayes"] = {
Label = "Mission Row Impound",
ZoneType = "Poly", -- (Only if ZoneMethod is set to "PolyZone") The type of zone: "Box", "Circle", or "Poly", ("Poly" recommended)
Zone = {
Poly = { -- If ZoneType is set to "Poly", you need to set the points of the zone. If ZoneType is set to "Box" or "Circle", you can leave this empty.
BlipCoords = vector3(480.2066, -1318.2565, 28.7801), -- The coordinates of the blip
Points = {
vector2(479.89077758789, -1301.4887695312),
vector2(490.10690307617, -1302.4947509766),
vector2(496.23129272461, -1314.3508300781),
vector2(489.32208251953, -1316.3441162109),
vector2(484.64218139648, -1316.9497070312),
vector2(487.53601074219, -1323.4346923828),
vector2(479.46853637695, -1326.9069824219),
vector2(471.39492797852, -1308.9743652344),
vector2(478.7353515625, -1305.5520019531)
},
MinZ = 28.0,
MaxZ = 31.0,
},
Box = { -- If ZoneType is set to "Box", you need to set the coordinates of the zone. If ZoneType is set to "Poly" or "Circle", you can leave this empty.
Coords = vector3(0.0, 0.0, 0.0),
MinZ = 0.0, -- The minimum Z coordinate of the zone
MaxZ = 0.0, -- The maximum Z coordinate of the zone
Width = 0.0, -- The width of the zone
Length = 0.0, -- The length of the zone
Heading = 0, -- The heading of the zone
},
Circle = { -- If ZoneType is set to "Circle", you need to set the coordinates of the zone. If ZoneType is set to "Poly" or "Box", you can leave this empty.
Coords = vector3(0.0, 0.0, 0.0), -- The coordinates of the zone (only if ZoneType is set to "Box", "Circle" or if ZoneMethod is set to "marker")
MinZ = 0.0, -- The minimum Z coordinate of the zone
MaxZ = 0.0, -- The maximum Z coordinate of the zone
Radius = 0.0, -- The radius of the zone
},
Marker = { -- If ZoneMethod is set to "marker", you need to set the coordinates of the zone. If ZoneType is set to "Poly", "Box" or "Circle", you can leave this empty.
Coords = vector3(0.0, 0.0, 0.0), -- The coordinates of the zone (only if ZoneType is set to "Box", "Circle" or if ZoneMethod is set to "marker")
Radius = 0.0, -- The radius of the zone
}
},
Spawns = {
vector4(480.2066, -1318.2565, 28.7801, 298.5417), -- The coordinates of the spawn points (x, y, z, heading)
},
HideBlip = false,
}
}
}
```
Last updated