We must configure the resource with the framework and SQL script used for our server. So for that, let's make some changes.
List of supported frameworks
Framework Name
Framework Input
ESX Old (1.1)
ESX
ESX Legacy
ESX-Legacy
QB-Core
QB-Core
List of supported SQL scripts
Script Name
Script Input
MySQL Async
mysql-async
OxMySQL
oxmysql
Example
config.lua
Config.Settings = {
Framework = 'ESX', -- The Framework Input
FrameworkEvent = 'esx:getSharedObject', -- Only works if using ESX as a Framework.
FrameworkName = 'es_extended', -- The name of the Framework resource.
MySQL = 'mysql-async', -- The SQL script input
}
Setting up your notification system
We must configure the resource with the notification system used for our server. So for that, let's make some changes.
In here, you can manage on how the garage system will work. You can decide if you want to make that when the script starts up, the vehicles are automatically stored, so the players can join the server and have their vehicles back again. You can also decide if the players can take their vehicles from any garage. This means that if we store a vehicle in garage A, we can take out the vehicle from the garage B.
Example
Config.Settings = {
StoreOnLoad = true, -- The script will store all vehicles on start up.
TakeOutEverywhere = true, -- The script will allow the players to take out vehicles from any garage without checking if it is stored there.
}
Commands Configuration
Sometimes, in your server, it can happen that you have the same commands that the ones from our script, and that can be a real problem. We thought of that and we implemented a way to change those commands. You can change every command that is on the configuration file.
Example
Config = {
Commands = {
JobVehicle = 'jobvehicle', -- The command to set a vehicle into your job garage.
GiveKeys = 'givekeys', -- The command to give the vehicle keys. Works with the personal vehicles and the jobs vehicles.
LockVehicle = {
Name = 'lockvehicle', -- The command to lock the vehicle doors. Works with the personal vehicles and the jobs vehicles.
DefaultKey = 'U', -- The default key to use this command as a bind. Can be changed into the personnal FiveM settings.
DefaultMapper = 'keyboard' -- The default mapper of the default key to use in FiveM.
}
},
}
Plates Configuration
While using our garages, you may notice that for the jobs garages, you have the option to generate a random plate. In here, you can manage on how the generator will work by setting the format of the plates. If you want, you can have a static plate or you can have letters and numbers in any position you want.
The plates can't bypass the maximum of 8 characters (letters, numbers & spaces included).
Format of the plates
Format Letter
Description
&
By using this symbol, it will get replaced by a random letter.
$
By using this symbol, it will get replaced by a random number.
Example
config.lua
Config.Settings = {
Plates = {
PlateFormat = '&&& $$$' -- This will have 3 letters, a space and 3 numbers (Example: ABC 123)
},
}
Impounds Configuration
For the impounds configuration, you can manage if the players must pay a fine before unimpounding the vehicles. You can also manage how much they must pay and also manage the durations of the impounds. It is possible to manage also the jobs that have access to the impound menu.
Impounds Duration Type
Type
Type Name
Description
h
Hour(s)
By using this duration type, the time that you insert will be X hour(s) for the impound.
d
Day(s)
By using this duration type, the time that you insert will be X day(s) for the impound.
Example
config.lua
Config.Settings = {
Impounds = {
PayForImpound = true, -- Enable/disable the option to pay a fine to the vehicles impounded.
ImpoundPrice = 1500, -- Price to pay for the impounded vehicles.
Jobs = { -- List of jobs that can use the impound vehicle menu (/impound).
'police', 'sheriff'
},
Durations = { -- List of durations for the impounds (types supported: h = Hours, d = Days).
{ Name = '0 Hour - Can unimpound instantanly', Time = 0, Type = 'h' },
{ Name = '1 Hour', Time = 1, Type = 'h' },
{ Name = '2 Hours', Time = 2, Type = 'h' },
{ Name = '3 Hours', Time = 3, Type = 'h' },
{ Name = '4 Hours', Time = 4, Type = 'h' },
{ Name = '5 Hours', Time = 5, Type = 'h' },
{ Name = '6 Hours', Time = 6, Type = 'h' },
{ Name = '7 Hours', Time = 7, Type = 'h' },
{ Name = '8 Hours', Time = 8, Type = 'h' },
{ Name = '1 Day', Time = 1, Type = 'd' },
{ Name = '2 Days', Time = 2, Type = 'd' },
{ Name = '3 Days', Time = 3, Type = 'd' },
{ Name = '4 Days', Time = 4, Type = 'd' },
{ Name = '5 Days', Time = 5, Type = 'd' },
{ Name = '6 Days', Time = 6, Type = 'd' },
{ Name = '7 Days', Time = 7, Type = 'd' }
}
}
}
Configuring the Garages
How are the garages working
Before we see on how to add more garages, let's take an overview about how the garages are made and what are the contents of the tables.
Overview of a Garage:
Config.Garages = {
-- The 'A' is the garage ID.
-- This will be used to verify
-- the garages that the vehicles
-- are stored and impounded and it
-- must be unique.
['A'] = {
Name = 'Garage A', -- The name of the garage.
Type = 'car', -- The type of the garage (car, boat, plane, ...)
ShowBlip = true, -- Should this garage show into the blip?
NPC = {
Coords = vector4(215.2367, -811.0994, 29.7208, 339.9762), -- The coordinates of the NPC.
Model = 's_m_y_valet_01', -- The model of the NPC.
Gender = 'male', -- The gender of the NPC.
Scenario = false, -- The scenario of the NPC.
Animation = {
Dict = 'move_m@generic_idles@std', -- The animation dictionary of the NPC.
Name = 'idle' -- The animation name of the NPC.
}
},
Coords = {
Garage = vector4(215.2367, -811.0994, 29.7208, 339.9762), -- The coords of where you can access the garage.
TakeOut = vector4(231.1404, -794.6561, 30.5893, 156.7345), -- The coords of when the vehicle to spawn when removing from the garage.
Park = vector3(215.0569, -789.9626, 30.8383) -- The coords of the position to park the vehicle.
}
},
}
List of the table contents for the garage:
Name of the content
Type of the content
Description of the content
Name
string
This is the name of the garage that will be shown on the menus and the map blips.
Type
string
This is the type of the vehicle that should be shown on the garages (car, boats, planes, etc.)
ShowBlip
boolean
This will enable/disable the blip on the player map of this garage.
NPC
This is to set the settings about the NPC on where you will be able to access the garage.
Coords
This is to set the settings about the coordinates of the garage for the vehicles.
List of the table content's NPC for the garage:
Name of the content
Type of the content
Description of the content
Coords
vector4
This is the coordinates of the NPC in vector4. We must put on vector4 so we can apply the heading of the NPC also.
Model
string
This is the name of the model of the NPC to use.
Gender
string (male/female)
This is the gender of the NPC.
Scenario
string
This is the scenario for the animations. If you wish to not use this system, put false or nil in the value.
Animation
This is to set the settings about the animation of the NPC.
List of the table content's Animations for the content's NPC for the garage:
Name of the content
Type of the content
Description of the content
Dict
string
This is the animation dictionary name for the NPC to play. If you wish to not use this, put false or nil to disable this.
Name
string
This is the animation name for the NPC to play. If you wish to not use this, put false or nil to disable this.
List of the table content's Coords for the garage:
Name of the content
Type of the content
Description of the content
Garage
vector3/vector4
This is the coordinates to access this garage. It is recommended to set the same coordinates as the NPC.
TakeOut
vector4
This is the coordinates to spawn the vehicle when the player takes out a vehicle from the garage.
Park
vector3
This is the coordinates to be able to park the vehicle in the garage.
Example of a new garage
Config.Garages = {
['B'] = {
Name = 'Garage B', -- The name of the garage.
Type = 'car', -- The type of the garage (car, boat, plane, ...)
ShowBlip = true, -- Should this garage show into the map?
NPC = {
Coords = vector4(277.1916, -345.5277, 43.9198, 343.7253), -- The coordinates of the NPC.
Model = 's_m_y_valet_01', -- The model of the NPC.
Gender = 'male', -- The gender of the NPC.
Scenario = false, -- The scenario of the NPC.
Animation = {
Dict = 'move_m@generic_idles@std', -- The animation dictionary of the NPC.
Name = 'idle' -- The animation name of the NPC.
}
},
Coords = {
Garage = vector4(277.1916, -345.5277, 43.9198, 343.7253), -- The coords of where you can access the garage.
TakeOut = vector4(290.3562, -337.6393, 44.9610, 161.4680), -- The coords of when the vehicle to spawn when removing from the garage.
Park = vector3(275.5069, -331.1602, 44.9199) -- The coords of the position to park the vehicle.
}
}
}
Configuring the Impounds
How are the impounds working
Before we see on how to add more impounds, let's take an overview about how the impounds are made and what are the contents of the tables.
Overview of an Impound:
Config.Impounds = {
-- The 'A' is the impound ID.
-- This will be used to verify
-- the impounds that the vehicles
-- are impounded and it must be unique.
['A'] = {
Name = 'Garage A', -- The name of the garage.
Type = 'car', -- The type of the garage (car, boat, plane, ...)
ShowBlip = true, -- Should this garage show into the blip?
NPC = {
Coords = vector4(215.2367, -811.0994, 29.7208, 339.9762), -- The coordinates of the NPC.
Model = 's_m_y_valet_01', -- The model of the NPC.
Gender = 'male', -- The gender of the NPC.
Scenario = false, -- The scenario of the NPC.
Animation = {
Dict = 'move_m@generic_idles@std', -- The animation dictionary of the NPC.
Name = 'idle' -- The animation name of the NPC.
}
},
Coords = {
Garage = vector4(215.2367, -811.0994, 29.7208, 339.9762) -- The coords of where you can access the impound.
},
Jobs = { -- List of jobs that have access to all the vehicles impounded in this location.
'police',
'sheriff'
}
},
}
List of the table contents for the impound:
Name of the content
Type of the content
Description of the content
Name
string
This is the name of the impound that will be shown on the menus and the map blips.
Type
string
This is the type of the vehicle that should be shown on the impounds (car, boats, planes, etc.)
ShowBlip
boolean
This will enable/disable the blip on the player map of this impound.
NPC
This is to set the settings about the NPC on where you will be able to access the impound.
Jobs
table
This is to set the list of jobs that have authorization to view all the vehicles impounded here.
List of the table content's NPC for the impound:
Name of the content
Type of the content
Description of the content
Coords
vector4
This is the coordinates of the NPC in vector4. We must put on vector4 so we can apply the heading of the NPC also.
Model
string
This is the name of the model of the NPC to use.
Gender
string (male/female)
This is the gender of the NPC.
Scenario
string
This is the scenario for the animations. If you wish to not use this system, put false or nil in the value.
Animation
This is to set the settings about the animation of the NPC.
List of the table content's Coords for the impound:
Name of the content
Type of the content
Description of the content
Garage
vector4/vector3
This is the coordinates to access this garage. It is recommended to set the same coordinates as the NPC.
List of the table content's Animations for the content's NPC for the impound:
Name of the content
Type of the content
Description of the content
Dict
string
This is the animation dictionary name for the NPC to play. If you wish to not use this, put false or nil to disable this.
Name
string
This is the animation name for the NPC to play. If you wish to not use this, put false or nil to disable this.
Example of a new impound
Config.Impounds = {
['B'] = {
Name = 'Sheriff Impound', -- The name of the garage.
Type = 'car', -- The type of the garage (car, boat, plane, ...)
ShowBlip = true, -- Should this garage show into the map?
NPC = {
Coords = vector4(277.1916, -345.5277, 43.9198, 343.7253), -- The coordinates of the NPC.
Model = 's_m_y_valet_01', -- The model of the NPC.
Gender = 'male', -- The gender of the NPC.
Scenario = false, -- The scenario of the NPC.
Animation = {
Dict = 'move_m@generic_idles@std', -- The animation dictionary of the NPC.
Name = 'idle' -- The animation name of the NPC.
}
},
Coords = {
Garage = vector4(277.1916, -345.5277, 43.9198, 343.7253) -- The coords of where you can access the impound.re you can
},
Jobs = { -- List of jobs that have access to all the vehicles impounded in this locatio
'sheriff'
}
}
}
Configuring the Job Garages
How are the job garages working
Before we see on how to add more job garages, let's take an overview about how the job garagesare made and what are the contents of the tables.
Overview of an Impound:
Config.JobsGarages = {
-- The 'police' is the garage ID.
-- This will be used to verify
-- the garage that the vehicles
-- are stored and impounded and it
-- must be unique.
['police'] = {
Name = 'Police Garage', -- The name of the garage.
Type = 'car', -- The type of the garage (car, boat, plane, ...)
AllowPersonalVehicles = false, -- Should this garage allow personal vehicles to be added?
PersonalVehiclesRequiredGrade = 0, -- The grade level required to use the job vehicle command.
CheckGang = false, -- Should this garage check the job or the gang? (QB-Core Only)
NPC = {
Coords = vector4(459.2178, -1008.0123, 27.2590, 85.6658), -- The coordinates of the NPC.
Model = 's_m_y_cop_01', -- The model of the NPC.
Gender = 'male', -- The gender of the NPC.
Scenario = false, -- The scenario of the NPC.
Animation = {
Dict = 'move_m@generic_idles@std', -- The animation dictionary of the NPC.
Name = 'idle' -- The animation name of the NPC.
}
},
Coords = {
Garage = vector4(459.2178, -1008.0123, 27.2590, 85.6658), -- The coords of where you can access the garage.
TakeOut = vector4(444.0743, -1020.8702, 28.5533, 90.6041), -- The coords of when the vehicle to spawn when removing from the garage.
Park = vector3(444.0743, -1020.8702, 28.5533) -- The coords of the position to park the vehicle.
},
Jobs = { -- List of jobs/gangs that have access to this garage.
'police',
'sheriff'
},
Vehicles = { -- The list of default vehicles that the job garage starts with.
{
Name = 'Police Cruiser', -- The name of the vehicle.
Model = 'police', -- The model of the vehicle.
RandomPlate = true, -- Should this vehicle get a random plate?
Plate = nil, -- The plate of the vehicle (set nil if using random plates).
Livery = 0, -- The livery of the vehicle.
Grades = {
Enabled = false, -- Should this vehicle be authorized with a grade level?
GradeRequired = 0 -- Grade required to get access to this vehicle.
}
},
{
Name = 'Police Cruiser #2', -- The name of the vehicle.
Model = 'police', -- The model of the vehicle.
RandomPlate = false, -- Should this vehicle get a random plate?
Plate = "POLICE", -- The plate of the vehicle (set nil if using random plates).
Livery = 0, -- The livery of the vehicle.
Grades = {
Enabled = false, -- Should this vehicle be authorized with a grade level?
GradeRequired = 0 -- Grade required to get access to this vehicle.
}
},
{
Name = 'Riot', -- The name of the vehicle.
Model = 'riot', -- The model of the vehicle.
RandomPlate = false, -- Should this vehicle get a random plate?
Plate = "POLICE", -- The plate of the vehicle (set nil if using random plates).
Livery = 0, -- The livery of the vehicle.
Grades = {
Enabled = true, -- Should this vehicle be authorized with a grade level?
GradeRequired = 2 -- Grade required to get access to this vehicle.
}
},
}
}
}
List of the table contents for the job garage:
Name of the content
Type of the content
Description of the content
Name
string
This is the name of the job garage that will be shown on the menus.
Type
string
This is the type of the vehicle that should be shown on the job garages (car, boats, planes, etc.)
AllowPersonalVehicles
boolean
This will enable/disable the system that allows to put personal vehicles in the job garage.
PersonalVehiclesRequiredGrade
number
This is to set the grade required to use the system for the personal vehicles on the job garage.
CheckGang
boolean
(QB-CORE ONLY) This will specify that if the job garage must be checked via the player job or the player gang.
NPC
This is to set the settings about the NPC on where you will be able to access the garage.
Coords
This is to set the settings about the coordinates of the garage for the vehicles
Jobs
table
This is to set the list of jobs that have authorization to view the job garage.
Vehicles
This is to set the default vehicles that the garage has in the job garage.
List of the table content's NPC for the job garage:
Name of the content
Type of the content
Description of the content
Coords
vector4
This is the coordinates of the NPC in vector4. We must put on vector4 so we can apply the heading of the NPC also.
Model
string
This is the name of the model of the NPC to use.
Gender
string (male/female)
This is the gender of the NPC.
Scenario
string
This is the scenario for the animations. If you wish to not use this system, put false or nil in the value.
Animation
This is to set the settings about the animation of the NPC.
List of the table content's Animations for the content's NPC for the job garage:
Name of the content
Type of the content
Description of the content
Dict
string
This is the animation dictionary name for the NPC to play. If you wish to not use this, put false or nil to disable this.
Name
string
This is the animation name for the NPC to play. If you wish to not use this, put false or nil to disable this.
List of the table content's Coords for the job garage:
Name of the content
Type of the content
Description of the content
Garage
vector4/vector3
This is the coordinates to access this garage. It is recommended to set the same coordinates as the NPC.
TakeOut
vector4
This is the coordinates to spawn the vehicle when the player takes out a vehicle from the garage.
Park
vector3
This is the coordinates to be able to park the vehicle in the garage.
List of the table content's Vehicles for the job garage:
Name of the content
Type of the content
Description of the content
Name
string
This is the name of the vehicle that will show on the garage.
Model
string
This is the model of the vehicle that will be used to spawn on the garage.
RandomPlate
boolean
This will define if this vehicle should be using the random plate generator system.
Plate
string
This will define the plate of the vehicle (If you wish to use the random plate system, you must put false or nil).
Grades
This is the settings of the grade system for this vehicle.
List of the table content's Grades of the table content's Grades for the job garage:
Name of the content
Type of the content
Description of the content
Enabled
boolean
This will define if this vehicle should appear only if the member has the grade level required.
GradeRequired
number
This is the grade level required to show the vehicle on the garage.
Example of a new job garage
Config.Impounds = {
['mafia'] = {
Name = 'Mafia Garage', -- The name of the garage.
Type = 'car', -- The type of the garage (car, boat, plane, ...)
AllowPersonalVehicles = true, -- Should this garage allow personal vehicles to be added?
PersonalVehiclesRequiredGrade = 0, -- The grade level required to use the job vehicle command.
CheckGang = true, -- Should this garage check the job or the gang? (QB-Core Only)
NPC = {
Coords = vector4(962.9706, -1820.2717, 30.0748, 267.4859), -- The coordinates of the NPC.
Model = 'csb_ramp_gang', -- The model of the NPC.
Gender = 'male', -- The gender of the NPC.
Scenario = false, -- The scenario of the NPC.
Animation = {
Dict = 'move_m@generic_idles@std', -- The animation dictionary of the NPC.
Name = 'idle' -- The animation name of the NPC.
}
},
Coords = {
TakeOut = vector4(974.1718, -1821.1034, 31.1345, 83.8898), -- The coords of when the vehicle to spawn when removing from the garage.
Park = vector3(974.1718, -1821.1034, 31.1345) -- The coords of the position to park the vehicle.
},
Jobs = { -- List of jobs/gangs that have access to this garage.
'mafia',
},
Vehicles = { -- The list of default vehicles that the job garage starts with.
{
Name = 'Kuruma', -- The name of the vehicle.
Model = 'kuruma', -- The model of the vehicle.
RandomPlate = true, -- Should this vehicle get a random plate?
Plate = nil, -- The plate of the vehicle (set nil if using random plates).
Grades = {
Enabled = false, -- Should this vehicle be authorized with a grade level?
GradeRequired = 0 -- Grade required to get access to this vehicle.
}
}
}
}
}
Configuring the Map Blips
For our garage system, you can modify the blips that are display. Modifying is changing the icon, colors and more. Here is the table of it:
Config.Blips = {
Garages = {
Sprite = 357, -- The sprite of the blip on the map for the garages.
ShortRange = true, -- Should the blips be visible on short range?
Scale = 0.8, -- Scale of the blip for the garages.
Color = 3 -- Color of the blip for the garages.
},
Impounds = {
Sprite = 357, -- The sprite of the blip on the map for the impounds.
ShortRange = true, -- Should the blips be visible on short range?
Scale = 0.8, -- Scale of the blip for the impounds.
Color = 5 -- Color of the blip for the impounds.
}
}
Configuring a Custom Notification System
You can always use a custom notification system in our scripts. To do that, please refer to the code bellow:
Config.Notify = {
ClientNotify = function (notifyData)
--###########################################################################--
-- Here you can set your own notification system in case you don't use those --
-- that we support. --
-- --
-- [[ Parameters Content ]] --
-- notifyData: table --
-- notifyData.title: string --
-- notifyData.description: string --
-- notifyData.type: string --
-- notifyData.time: number --
-- --
-- [[ Example ]] --
-- local title = notifyData.title --
-- local description = notifyData.description --
-- local type = notifyData.type --
-- local time = notifyData.time --
-- --
-- exports['ug-notify']:CreateNotify(title, description, type, time) --
--###########################################################################--
local title = notifyData.title -- This is the title of the notification.
local description = notifyData.description -- This is the description of the notification.
local type = notifyData.type -- This is the type of the notification.
local time = notifyData.time -- This is the time of the notification.
-- Put here the event/export that you use for your notification script.
-- Example: exports['ug-notify']:CreateNotify(title, description, type, time)
end,
ServerNotify = function (source, notifyData)
--##############################################################################################--
-- Here you can set your own notification system in case you don't use those that we support. --
-- --
-- [[ Parameters Content ]] --
-- source: playerSrc --
-- notifyData: table --
-- notifyData.title: string --
-- notifyData.description: string --
-- notifyData.type: string --
-- notifyData.time: number --
-- --
-- [[ Example ]] --
-- local title = notifyData.title --
-- local description = notifyData.description --
-- local type = notifyData.type --
-- local time = notifyData.time --
-- --
-- TriggerClientEvent('ug-notify:CreateNotify', source, title, description, type, time) --
--##############################################################################################--
local title = notifyData.title -- This is the title of the notification.
local description = notifyData.description -- This is the description of the notification.
local type = notifyData.type -- This is the type of the notification.
local time = notifyData.time -- This is the time of the notification.
-- Put here the event/export that you use for your notification script.
-- TriggerClientEvent('ug-notify:CreateNotify', source, title, description, type, time)
end
}
