The FiveM Developer Handbook

{
  "runtime.version": "Lua 5.4",
  "workspace.userThirdParty": ["C:/lua-addons"],
  "workspace.library": ["../[libs]/ox_lib"],
  "diagnostics.globals": ["lib", "cache"]
}

local price = 250                    -- always local
local name = 'Adder'
local owned = false

-- only nil and false are falsy: 0 and '' are true
if price > 100 and not owned then
    print(('%s costs $%d'):format(name, price))
end

-- arrays start at 1
local garages = { 'pillbox', 'legion', 'airport' }
for i = 1, #garages do print(i, garages[i]) end

-- dictionaries
local prices = { adder = 1000000, sultan = 45000 }
for model, p in pairs(prices) do print(model, p) end

-- functions are values
local function tax(amount) return math.floor(amount * 0.15) end

local pos = vector3(215.8, -810.1, 30.7)   -- a real vector type
local here = GetEntityCoords(PlayerPedId())
local dist = #(here - pos)                   -- distance, fast

if GetEntityModel(veh) == `adder` then end  -- compile-time hash

local data = json.decode('{"a":1}')       -- json is global

nc_garage/
  fxmanifest.lua
  config.lua          shared settings
  server/config.lua   server-only settings (secrets, rewards)
  client/main.lua
  server/main.lua
  locales/en.json
  web/dist/           built NUI
  sql/install.sql
  README.md

fx_version 'cerulean'
game 'gta5'
lua54 'yes'

name 'nc_garage'
author 'you'
version '1.0.0'

shared_scripts { '@ox_lib/init.lua', 'config.lua' }
client_scripts { 'client/*.lua' }
server_scripts { '@oxmysql/lib/MySQL.lua', 'server/config.lua', 'server/*.lua' }

ui_page 'web/dist/index.html'
files { 'web/dist/**', 'locales/*.json' }

dependencies { 'ox_lib', 'oxmysql' }

escrow_ignore { 'config.lua', 'server/config.lua', 'locales/*.json' }

-- server: allow the event from the network and handle it
RegisterNetEvent('garage:store', function(netId)
    local src = source
    -- validate, then act
end)

-- client -> server
TriggerServerEvent('garage:store', NetworkGetNetworkIdFromEntity(veh))

-- server -> one client, or everyone with -1
TriggerClientEvent('garage:notify', src, 'Stored')
TriggerClientEvent('garage:notify', -1, 'Garage open')

-- server
lib.callback.register('garage:list', function(source)
    return MySQL.query.await('SELECT plate, model FROM vehicles WHERE owner = ?', { GetOwner(source) })
end)

-- client
local cars = lib.callback.await('garage:list', false)

-- in nc_garage
exports('IsVehicleStored', function(plate) return Stored[plate] == true end)

-- in any other resource
local stored = exports.nc_garage:IsVehicleStored('ABC 123')

local shop = vector3(25.7, -1347.3, 29.5)

CreateThread(function()
    while true do
        local sleep = 1000
        local dist = #(GetEntityCoords(PlayerPedId()) - shop)
        if dist < 20.0 then
            sleep = 0
            DrawMarker(1, shop.x, shop.y, shop.z - 1.0, 0, 0, 0, 0, 0, 0, 1.5, 1.5, 0.5, 124, 92, 255, 150, false, false, 2, false, nil, nil, false)
            if dist < 1.5 and IsControlJustPressed(0, 38) then
                TriggerServerEvent('shop:open')
            end
        end
        Wait(sleep)
    end
end)

-- server
Entity(veh).state:set('fuel', 64.0, true)
Player(src).state:set('onDuty', true, true)

-- client
AddStateBagChangeHandler('fuel', nil, function(bagName, key, value)
    local ent = GetEntityFromStateBagName(bagName)
    if ent ~= 0 then SetVehicleFuelLevel(ent, value) end
end)

local function spawnFor(src, model, coords)
    local veh = CreateVehicleServerSetter(model, 'automobile', coords.x, coords.y, coords.z, coords.w)
    while not DoesEntityExist(veh) do Wait(0) end
    SetVehicleNumberPlateText(veh, 'NC' .. math.random(1000, 9999))
    SetPedIntoVehicle(GetPlayerPed(src), veh, -1)
    return NetworkGetNetworkIdFromEntity(veh)
end

local veh = NetworkGetEntityFromNetworkId(netId)
if DoesEntityExist(veh) then
    SetVehicleEngineOn(veh, true, true, false)
end

local row = MySQL.single.await('SELECT money FROM characters WHERE id = ?', { charId })

local changed = MySQL.update.await(
    'UPDATE characters SET money = money - ? WHERE id = ? AND money >= ?',
    { price, charId, price }
)
if changed == 0 then return false end  -- not enough money, nothing changed

Bridge = {}

if GetResourceState('qbx_core') == 'started' then
    function Bridge.addCash(src, n) return exports.qbx_core:AddMoney(src, 'cash', n) end
elseif GetResourceState('qb-core') == 'started' then
    local QBCore = exports['qb-core']:GetCoreObject()
    function Bridge.addCash(src, n) return QBCore.Functions.GetPlayer(src).Functions.AddMoney('cash', n) end
elseif GetResourceState('es_extended') == 'started' then
    local ESX = exports.es_extended:getSharedObject()
    function Bridge.addCash(src, n) ESX.GetPlayerFromId(src).addMoney(n) return true end
end

lib.notify({ title = 'Garage', description = 'Vehicle stored', type = 'success' })

if lib.progressBar({ duration = 3000, label = 'Repairing', canCancel = true }) then
    -- finished
end

local input = lib.inputDialog('Transfer', { { type = 'number', label = 'Amount', min = 1 } })

local zone = lib.zones.box({
    coords = vec3(215.0, -810.0, 30.7), size = vec3(6, 6, 3), rotation = 45,
    onEnter = function() lib.showTextUI('[E] Garage') end,
    onExit = function() lib.hideTextUI() end,
})

local ped = cache.ped  -- cached player ped, updated for you

exports.ox_target:addModel(`prop_atm_01`, {
    {
        name = 'atm:use',
        label = 'Use ATM',
        icon = 'fa-solid fa-credit-card',
        distance = 1.5,
        onSelect = function() TriggerServerEvent('bank:openAtm') end,
    },
})

local open = false

local function setOpen(state)
    open = state
    SetNuiFocus(state, state)
    SendNUIMessage({ action = 'visible', data = state })
end

RegisterCommand('bank', function() setOpen(true) end)

RegisterNUICallback('close', function(_, cb)
    setOpen(false)
    cb('ok')
end)

AddEventHandler('onResourceStop', function(res)
    if res == GetCurrentResourceName() and open then SetNuiFocus(false, false) end
end)

export async function fetchNui<T>(event: string, data?: unknown): Promise<T> {
  const res = await fetch(`https://${GetParentResourceName()}/${event}`, {
    method: 'POST',
    headers: { 'Content-Type': 'application/json; charset=UTF-8' },
    body: JSON.stringify(data ?? {}),
  });
  return res.json();
}

window.addEventListener('message', (e) => {
  const { action, data } = e.data;
  if (action === 'visible') setVisible(data);
});

local SHOPS = { legion = vector3(25.7, -1347.3, 29.5) }
local PRICES = { water = 5, bread = 8 }
local last = {}

RegisterNetEvent('shop:buy', function(shopId, item, amount)
    local src = source
    if type(shopId) ~= 'string' or type(item) ~= 'string' or type(amount) ~= 'number' then return end
    amount = math.floor(amount)
    if amount < 1 or amount > 20 then return end

    local shop, price = SHOPS[shopId], PRICES[item]
    if not shop or not price then return end

    if #(GetEntityCoords(GetPlayerPed(src)) - shop) > 5.0 then return end

    local now = GetGameTimer()
    if last[src] and now - last[src] < 1000 then return end
    last[src] = now

    local total = price * amount
    if not Bridge.removeCash(src, total) then return end
    exports.ox_inventory:AddItem(src, item, amount)
end)

AddEventHandler('playerDropped', function() last[source] = nil end)

CreateThread(function()
    while true do
        print(('[%s] %.1f KB'):format(GetCurrentResourceName(), collectgarbage('count')))
        Wait(60000)
    end
end)

local HOOK = GetConvar('logs_webhook', '')

local function log(title, text, color)
    if HOOK == '' then return end
    PerformHttpRequest(HOOK, function(status)
        if status == 429 then print('[logs] rate limited') end
    end, 'POST', json.encode({
        embeds = { {
            title = title,
            description = text,
            color = color or 8150271,
            timestamp = os.date('!%Y-%m-%dT%H:%M:%SZ'),
        } },
    }), { ['Content-Type'] = 'application/json' })
end

lib.cron.new('0 6 * * *', function()
    MySQL.update.await('UPDATE characters SET daily_claimed = 0')
end)

Config = {}

Config.Locale = 'en'
Config.Framework = 'auto'   -- auto | qbx | qb | esx
Config.Inventory = 'auto'   -- auto | ox | qb | esx

Config.Garages = {
    legion = { label = 'Legion Square', coords = vec4(215.8, -810.1, 30.7, 157.0), jobs = false },
    mrpd   = { label = 'Mission Row PD', coords = vec4(452.3, -996.1, 25.8, 90.0), jobs = { police = 0 } },
}