FiveM Docs - Documentation

Demarrer

Creer un resource propre

Checklist rapide + exemple de structure de fichiers.

Pour ajouter un feature a ton serveur FiveM, tu crees un dossier "resource" dans ton repertoire `resources/`. Ensuite tu decris l'entrypoint et les fichiers a charger via `fxmanifest.lua`.

Exemple de structure :

resources/
  my_resource/
    fxmanifest.lua
    client/
      main.lua
    server/
      main.lua

1

cree le dossier

2

ecris `fxmanifest.lua`

3

mets tes scripts

4

demarre et teste

fxmanifest

Declarer un resource

Le coeur de la configuration pour charger client/serveur.

`fx_version` indique la version FX framework. `game` definit les jeux compatibles. Les directives `client_scripts` et `server_scripts` listent les fichiers Lua cote client/serveur.

fx_version 'cerulean'
game 'gta5'

name 'my_resource'
description 'Mon resource - exemple'

version '1.0.0'

author 'ton pseudo'

client_scripts {
  'client/main.lua'
}

server_scripts {
  'server/main.lua'
}

client_scripts

cote joueurs (Lua)

server_scripts

cote serveur (Lua)

files

assets (si besoin)

ui_page

NUI (voir section)

Resources

Choisir la bonne separation

Client pour l'affichage, serveur pour la logique.

Themes courants

Client / Serveur

Ou mettre le code et comment communiquer proprement.

eventscallbackssync

NUI

Brancher une UI web (HTML/CSS/JS) avec `ui_page`.

ui_pagepostMessagefocus

FAQ

Les erreurs les plus frequentes et comment les eviter.

permissionslogorder

Menus

Comment utiliser les menus

Tu selectionnes -> ca envoie -> le serveur valide.

Avec ox_lib, tu utilises un context menu et tu appelles ton serveur dans onSelect.

-- client/main.lua (exemple simplifie)
local function openShopMenu()
  lib.registerContext({
    id = 'shop_menu',
    title = 'Shop',
    options = {
      {
        title = 'Medic kit',
        description = 'Soins rapides',
        onSelect = function()
          TriggerServerEvent('my_resource:buy', 'medkit')
        end
      },
      {
        title = 'Armor',
        description = 'Armure',
        onSelect = function()
          TriggerServerEvent('my_resource:buy', 'armor')
        end
      }
    }
  })

  lib.showContext('shop_menu')
end

-- ex: Bind sur un event
-- RegisterCommand('shop', function() openShopMenu() end)

Client

ouvre le menu

onSelect

envoie une action

Serveur

valide et applique

Client

recoit le resultat

Avec qb-menu, tu fournis une table de boutons. Chaque bouton declenche un event (client), puis tu fais un TriggerServerEvent pour la logique.

-- client/main.lua (exemple simplifie)
local function openQbMenu()
  local menu = {
    { header = 'Medic kit', txt = 'Soins rapides', params = { event = 'my_resource:client:buy', args = 'medkit' } },
    { header = 'Armor', txt = 'Armure', params = { event = 'my_resource:client:buy', args = 'armor' } },
  }

  exports['qb-menu']:openMenu(menu)
end

RegisterNetEvent('my_resource:client:buy', function(item)
  TriggerServerEvent('my_resource:buy', item)
end)

-- ex: openQbMenu() quand tu veux

header

titre bouton

txt

description

params

event + args

TriggerServerEvent

logic serveur

Si tu fais un menu en NUI, ton client ouvre/ferme l'UI (SetNuiFocus + SendNUIMessage), puis le JS notifie Lua avec un callback (fetch vers `https://resource/...`).

-- client/main.lua (exemple simplifie)
local function openNuiMenu()
  SetNuiFocus(true, true)
  SendNUIMessage({ action = 'open_menu', items = { 'Medic kit', 'Armor' } })
end

RegisterNUICallback('menuSelect', function(data, cb)
  -- data.item = ...
  TriggerServerEvent('my_resource:buy', data.item)
  if cb then cb(true) end
end)

// web/js/ui.js (exemple simplifie)
function selectItem(item) {
  fetch('https://my_resource/menuSelect', {
    method: 'POST',
    headers: { 'Content-Type': 'application/json; charset=UTF-8' },
    body: JSON.stringify({ item })
  })
}

SetNuiFocus

controle clavier/souris

SendNUIMessage

ouvrir + donner des donnees

fetch -> callback

action utilisateur

Serveur

valide et applique

Client/Serveur

Communiquer sans se tirer une balle

Regle simple: logique serveur, rendu cote client.

Le client gere l'affichage (HUD, menus, effets). Le serveur gere la logique (controles, permissions, persistance, bases de donnees).

Exemple d'idee avec evenements (simplifie) :

-- server/main.lua
RegisterNetEvent('my_resource:doSomething', function(data)
  -- valider data cote serveur
  TriggerClientEvent('my_resource:cl:result', source, data)
end)

-- client/main.lua
TriggerServerEvent('my_resource:doSomething', { value = 123 })

Valider

toujours cote serveur

Minimiser

les donnees inutiles

Log

et surveiller `server console`

Decomposer

scripts par dossier

NUI

Brancher une interface web

Le duo `ui_page` + envoi/reception de messages.

Une NUI, c'est juste une page web (HTML/CSS/JS) que FiveM affiche. Dans `fxmanifest.lua`, tu declares l'entree avec `ui_page`.

ui_page 'web/index.html'

files {
  'web/index.html',
  'web/**/*'
}

client_scripts {
  'client/main.lua'
}

web/

ton dossier UI

Focus

quand l'UI est active

Messages

postMessage (cote navigateur)

Events

entre Lua et NUI

FAQ

Questions frequentes

Quelques reponses typiques pour gagner du temps.

Pourquoi mon resource ne charge pas ?

Verifie `fxmanifest.lua` (fautes de chemin), puis regarde les logs de demarrage. Assure-toi que le dossier est dans `resources/` et que le resource est demarre.

logschemins