ZPROJECT

Installation

Par
Sören
v1.0.6

Principe d’installation

zUI v1 doit être installé dans la même ressource que le script qui utilise les menus.

Il ne faut pas placer zUI dans une ressource séparée ni ajouter ensure zUI dans le server.cfg.

⚠️ Cette méthode d’intégration concerne zUI v1. zUI v2 fonctionne différemment et peut être utilisée comme une ressource indépendante.

Installation depuis les sources

Récupérez les fichiers de zUI :

bash
git clone https://github.com/ZProject-Official/zUI.git

Copiez ensuite les fichiers nécessaires de la bibliothèque dans la ressource où vous souhaitez créer votre menu.

Exemple de structure générale :

text
resources/
 mon_script/
     fxmanifest.lua
     client/
     server/
     zUI/
     user-interface/

La structure exacte peut varier selon la version téléchargée. Conservez les chemins attendus par les fichiers Lua et par le manifeste.

Compiler l’interface

Lorsque vous installez zUI depuis les sources, accédez au dossier de l’interface puis installez les dépendances :

bash
cd user-interface
npm install
npm run build

Note : Node.js est nécessaire uniquement pour compiler l’interface. Une version Release peut déjà contenir les fichiers compilés.

Configurer le manifeste

Le fxmanifest.lua de votre ressource doit charger les fichiers Lua de zUI ainsi que les fichiers NUI nécessaires.

Ne créez pas un second manifeste uniquement pour zUI v1. L’ensemble doit être déclaré dans le manifeste de la ressource qui utilise les menus.

Vérifiez notamment que votre manifeste contient correctement :

  • les scripts client de zUI ;
  • la page NUI ;
  • les fichiers compilés de l’interface ;
  • les fichiers supplémentaires requis par la bibliothèque.

Les chemins exacts doivent correspondre à l’emplacement où vous avez copié zUI dans votre ressource.

Démarrage

Seule votre ressource doit être démarrée dans le server.cfg :

cfg
ensure mon_script

Il ne faut pas ajouter :

cfg
ensure zUI

Vérification

Après le démarrage du serveur :

  1. 1Vérifiez que la ressource contenant zUI démarre sans erreur.
  2. 2Contrôlez que les chemins déclarés dans fxmanifest.lua correspondent aux fichiers présents.
  3. 3Vérifiez que l’interface compilée est bien incluse.
  4. 4Testez l’ouverture d’un menu simple.
  5. 5Consultez la console client si l’interface ne s’affiche pas.