Comment écrire et vérifier un fxmanifest.lua FiveM

[fivemx_fxmanifest_tool]

Un fxmanifest.lua doit se trouver à la racine d'une ressource FiveM. Il déclare le jeu pris en charge, les scripts, les dépendances et les fichiers livrés au client. Choisissez l'exemple qui correspond à votre ressource et remplacez chaque nom de fichier d'exemple par un fichier qui existe réellement.

Les exemples de configuration et de code ici ciblent FiveM pour GTA V Legacy. Enhanced a des règles d'exécution et de compatibilité différentes ; vérifiez les changements Legacy-to-Enhanced de Cfx.re avant de les appliquer à un serveur Enhanced.

Une ressource de script minimale

fx_version 'cerulean'
game 'gta5'

client_script 'client.lua'
server_script 'server.lua'

Utilisez client_script pour le code s'exécutant sur le client de chaque joueur et server_script pour le code FXServer. Ajoutez les métadonnées d'auteur, de description et de version si nécessaire. Une dépendance peut inspecter votre version, mais les métadonnées de version ne modifient pas l'exécution. Le CfxLua actuel utilise Lua 5.4 ; le commutateur lua54 est obsolète.

Fichiers partagés et dépendances

fx_version 'cerulean'
game 'gta5'

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

Cet exemple nécessite les bibliothèques nommées ; omettez-les si votre ressource ne les utilise pas. Les scripts partagés sont livrés aux clients, alors ne mettez pas les identifiants, les webhooks et les vérifications d'autorité réservées au serveur dans les fichiers partagés. Déclarez les dépendances dont votre code a réellement besoin et suivez leur ordre de démarrage documenté.

Une interface de navigateur avec NUI

fx_version 'cerulean'
game 'gta5'

ui_page 'web/index.html'
files { 'web/index.html', 'web/style.css', 'web/app.js' }
client_script 'client.lua'

Listez toutes les ressources d'interface utilisateur locales requises, y compris les polices et les images. Une interface vide nécessite de vérifier à la fois son chemin de page et les ressources manquantes. Un écran de chargement utilise loadscreen et son propre cycle de vie au lieu de cet exemple de ui_page.

Cartes et archétypes supplémentaires

fx_version 'cerulean'
game 'gta5'

this_is_a_map 'yes'
files { 'stream/example.ytyp' }
data_file 'DLC_ITYP_REQUEST' 'stream/example.ytyp'

Placez les ressources streamables dans stream. L'enregistrement YTYP montré ici est pour une ressource contenant ce fichier ; une simple ressource YMAP-only n'a pas besoin d'un YTYP fictif. Utilisez la déclaration de fichier de données requise par le type d'actif réel.

Démarrer et vérifier

1. Vérifiez que le dossier contient directement fxmanifest.lua et que tous les chemins correspondent aux noms de fichiers réels, y compris la casse.
2. Installez les dépendances déclarées. Ajoutez ensure suivi du nom du dossier de ressources à server.cfg après les dépendances documentées.
3. Exécutez refresh et ensure resource-name dans la console du serveur de développement, en substituant le nom de votre dossier. Lisez la première erreur de démarrage.
4. Rejoignez, utilisez la ressource et inspectez F8 ainsi que la console du serveur. Testez un redémarrage complet du serveur pour détecter les erreurs de dépendance et de packaging masquées par les rechargements à chaud.

Erreurs courantes

Fichier manquant : comparez le chemin exact indiqué dans le manifeste avec le nom du fichier. Export manquant : vérifiez la version de la dépendance et l’ordre d’initialisation. Secrets visibles par les clients : retirez-les des fichiers partagés ou client et renouvelez les valeurs exposées.

Ne raccourcissez pas un manifeste de fournisseur en copiant ce tutoriel par-dessus. Utilisez la référence officielle du manifeste et référence du fichier de données pour comprendre chaque déclaration avant de la modifier.

Que vérifier dans le manifeste d’une ressource achetée ?

Comparez les dépendances et builds déclarés à votre serveur avant de démarrer la ressource. Vérifiez la présence des scripts et fichiers d’interface référencés. Un manifeste valide décrit les éléments à charger ; il ne certifie ni le gameplay, ni les performances, ni l’intégration du framework.

Référence des manifestes Cfx.re

Voir les exigences du pack ESX Server Base (by RibSosay)