Éditeur de layouts
L'Éditeur de layouts construit les écrans d'un mod : menus, éléments de HUD, boîtes de dialogue. Un écran de DayZ est un fichier .layout, un arbre de widgets (frames, panneaux, textes, boutons, images) qu'un script crée et remplit. Ici, vous modifiez cet arbre sur un canevas dessiné avec les polices, images et styles du jeu, ou vous écrivez l'écran en DZML, une forme HTML qui se compile en .layout. Il ne faut rien pour commencer : la page s'ouvre sur un layout vide. Avec le dossier DayZ défini dans les Paramètres, les layouts du jeu s'ouvrent en lecture seule comme exemples, et leurs images et styles sont affichés.
L'écran
- Panneau de gauche, onglet Fichiers : les fichiers
.layoutet DZML des dossiers que vous avez ouverts et de vos workspaces. Un filtre, un bouton pour ajouter un dossier, une réanalyse. Cliquez sur un fichier pour l'ouvrir dans un onglet ; l'icône en grille d'un dossier affiche les miniatures de chaque layout qu'il contient. - Panneau de gauche, onglet Widgets (affiché en premier), de haut en bas :
- Palette : les classes de widgets du jeu. Cliquez sur l'une pour l'ajouter dans le widget sélectionné, ou glissez-la sur le canevas ou dans la hiérarchie.
- Prefabs : des groupes de widgets que vous avez enregistrés pour les réutiliser. Sélectionnez des widgets et cliquez sur l'icône d'enregistrement pour en créer un ; cliquez sur un prefab ou glissez-le pour l'insérer.
- Hiérarchie : l'arbre des widgets du document. Un clic sélectionne (Ctrl ou Maj ajoute à la sélection), un double-clic centre le canevas sur le widget, glisser déplace un widget dans un autre parent. Les flèches de son en-tête déplacent la sélection vers le haut, vers le bas, hors de ou dans un voisin. L'œil masque un widget et la clé le verrouille, dans l'éditeur seulement.
- Onglets de documents : un par document ouvert ; un point signale des modifications non enregistrées. Le + ouvre la liste des nouveaux documents : document DZML, layout vierge, modèle de menu, modèle de HUD.
- Barre d'outils : Ouvrir un fichier, Parcourir les layouts du jeu, Enregistrer, Recharger depuis le disque, Enregistrer sous, puis Vers DZML (pour un
.layout) ou Compiler et Regrouper (pour un document DZML), Annuler, Rétablir, Jouer et Aperçu. Un badge « Fichier du jeu » marque un layout ouvert depuis le jeu. - Onglets de vue (à droite de la barre d'outils) : Design (le canevas), Source (le texte
.layout; nommé HTML pour un document DZML) et Navigateur (DZML uniquement : la page enregistrée dans la vue web). - Barre d'outils du canevas (vue Design) : résolution d'écran, zoom, Ajuster, 1:1, ce qui est dessiné derrière l'UI, Guides (aimantation), Contours, Masqués (affiche aussi les widgets dont
visibleest désactivé), Textes (traduit les#clésdepuis stringtable.csv), le pas d'aimantation, la zone de sécurité des consoles, et ? pour les raccourcis clavier. Avec plusieurs widgets sélectionnés, des boutons d'alignement et de répartition apparaissent. - Canevas : l'écran tel que le jeu le dessine à la résolution choisie, avec des règles. Un clic sélectionne le widget du dessus (Alt+clic parcourt ceux qui sont sous le curseur), glisser déplace, les bords redimensionnent, glisser sur une zone vide en sélectionne plusieurs. Cliquez sur une règle pour ajouter un guide, clic droit pour le retirer.
- Panneau de droite, Propriétés : les propriétés du widget sélectionné, groupées (Widget, Layout, Apparence, Texte, Image, Navigation, Spacer, Contrôle, Autre). La position et la taille ont un commutateur px / % par axe ; le petit x réinitialise une propriété à sa valeur par défaut.
- Panneau de droite, Script : la classe Enforce Script générée pour ce layout, sous forme de menu (
UIScriptedMenu) ou de handler de widget (ScriptedWidgetEventHandler). Copiez-la, ou écrivez-la dans le mod du layout. En dessous : les liaisons du sous-arbre sélectionné, et une recherche des endroits où les noms de widgets sont utilisés dans vos scripts. - Panneau de droite, Problèmes : ce qui poserait problème dans le jeu, avec un compteur sur l'onglet. Cliquez sur un problème pour sélectionner son widget.
- Jouer (F5) : l'écran seul, avec boutons, cases à cocher, champs de saisie et défilement actifs, un sélecteur de résolution et un journal des événements qu'un script recevrait. Échap le quitte.
Premiers pas
- Ouvrez l'Éditeur de layouts. Un layout vide nommé
untitled.layoutest prêt, avec un frame racine. - Dans la palette, cliquez sur Panel : un panneau est ajouté dans la racine. Glissez-le sur le canevas et redimensionnez-le par ses bords.
- Le panneau étant sélectionné, cliquez sur Text dans la palette : le texte est ajouté dans le panneau. Dans Propriétés, définissez son
text. - Donnez un nom aux deux widgets dans Propriétés (F2) : les scripts trouvent les widgets par leur nom.
- Regardez l'onglet Problèmes et corrigez ce qu'il liste.
- Appuyez sur F5 pour voir l'écran sans les repères de l'éditeur, Échap pour revenir.
- Cliquez sur Enregistrer (Ctrl+S) et écrivez le fichier dans votre mod, par exemple
MyMod/gui/layouts/my_panel.layout.
Faire la visite (dans l'app)
Tâches courantes
Démarrer un menu en DZML
- Cliquez sur + dans la barre d'onglets et choisissez Document DZML (HTML). Un panneau avec un titre et un bouton Fermer s'ouvre sur son HTML.
- Modifiez le HTML ; passez à Design pour voir et ajuster le résultat.
- Enregistrez : la première fois, vous choisissez le nom du
.html, dans votre mod. - Cliquez sur Compiler et acceptez le
.layoutproposé à côté du.html. Une page avec des modèles de lignes obtient aussi un<page>_<row>.layoutpar modèle. - Dans l'onglet Script, gardez le type « Menu » et cliquez sur Écrire dans le mod : la classe est écrite sous
scripts/5_Mission/<Mod>/GUI/(le chemin est modifiable ; un fichier existant n'est remplacé qu'après votre confirmation).
Étudier un layout du jeu
- Cliquez sur Parcourir les layouts du jeu (la loupe) et saisissez une partie du nom, par exemple
inventory. - Cliquez sur un résultat : il s'ouvre en lecture seule dans un onglet, avec le badge « Fichier du jeu ».
- Cochez Masqués pour voir les widgets que les scripts affichent à l'exécution ; utilisez Source pour lire le texte.
- Pour garder une copie modifiée, cliquez sur Enregistrer : il demande où l'écrire. Le fichier du jeu n'est jamais modifié.
Vérifier un écran à plusieurs résolutions
- Dans la barre d'outils du canevas, choisissez une autre résolution (1280 × 720, 2560 × 1440, 3840 × 2160, un format ultra-large et un format portrait sont listés).
- Observez ce qui bouge : les tailles en % suivent l'écran, les tailles en pixels non.
- Choisissez une zone de sécurité (95, 90 ou 85 %) pour voir où les écrans de console peuvent couper l'image.
- Jouer a le même sélecteur de résolution.
Convertir un layout existant en DZML
- Ouvrez le
.layout. - Cliquez sur Vers DZML et choisissez où écrire le
.html(à côté du layout par défaut). - Le nouveau document s'ouvre. Ne touchez plus au
.layoutà partir de maintenant : il est produit par Compiler.
Réutiliser un groupe de widgets
- Sélectionnez les widgets (Ctrl+clic, ou tracez un rectangle sur une zone vide).
- Dans l'onglet Widgets, cliquez sur l'icône d'enregistrement de Prefabs et nommez-le.
- Dans n'importe quel document, cliquez sur le prefab pour l'insérer dans la sélection, ou glissez-le sur le canevas ou la hiérarchie.
Générer le script d'un layout
- Enregistrez le layout dans un mod (un dossier avec un
$PBOPREFIX$ou unconfig.cpp) : l'éditeur connaît alors le chemin que le jeu utilisera. - Ouvrez l'onglet Script et choisissez le type : un menu ouvert avec
ShowScriptedMenu, ou un handler pour un sous-panneau. - Copiez la classe, ou cliquez sur Écrire dans le mod, puis Ouvrir dans Scripts.
Exemples
- Le menu principal du jeu (dans l'app) : un écran complet. Regardez la hiérarchie et les styles de ses boutons et panneaux.
- Le HUD en jeu (dans l'app) : le plus grand layout vanilla. Cochez Masqués : de nombreux widgets n'apparaissent que quand un script les affiche.
- L'écran d'inventaire (dans l'app) : un frame avec quelques zones que les scripts remplissent avec d'autres layouts.
- Une boîte de dialogue simple : se déconnecter (dans l'app) : une fenêtre, des textes et des boutons empilés par un grid spacer.
- Un nouveau menu en DZML (dans l'app) : la page de départ DZML, enregistrée nulle part.
Concepts
Deux manières de travailler : le .layout ou DZML
- Le .layout directement. Vous modifiez le fichier que le jeu charge. Design et Source montrent le même document : une modification dans l'un se retrouve dans l'autre. Choisissez-le pour ajuster un layout existant ou pour rester proche de ce que produisent les outils de Bohemia.
- DZML. Vous modifiez un fichier
.htmldans lequel chaque élément marquédata-dzest un widget et les classesdz-*sont ses propriétés. Le HTML est la source : le canevas montre ce qu'il compile, et une modification visuelle est réécrite sous la forme du plus petit changement du HTML. Avant de livrer, Compiler écrit le.layout. Choisissez-le pour une nouvelle UI : le texte est plus facile à lire, à relire et à faire écrire par l'assistant. Voir Comment fonctionne DZML.
Un .layout devient du DZML avec Vers DZML ; une page DZML devient un .layout avec Compiler. Faire la visite de DZML (dans l'app)
Notions du jeu
- .layout : un fichier texte décrivant un arbre de widgets : chacun a une classe (
TextWidgetClass), un nom et des propriétés (position,size,color,text...). Un script le charge avecCreateWidgets("MyMod/gui/layouts/x.layout"). - Position et taille : par axe, une valeur est en pixels (
hexactpos,vexactpos,hexactsize,vexactsizeà 1) ou une fraction du parent (0).halignetvalignchoisissent le bord ou le centre à partir duquel la position est mesurée. - Spacers :
GridSpacerWidgetetWrapSpacerWidgetplacent eux-mêmes leurs enfants ; la position propre d'un enfant est ignorée. Réordonnez plutôt les enfants dans la hiérarchie au lieu de les glisser. - Noms : les scripts obtiennent un widget avec
FindAnyWidget("Name"). Deux widgets avec le même nom : le premier est renvoyé. L'onglet Problèmes signale les doublons. - Styles et imagesets : un
styleest un aspect nommé défini dans un fichier.styles; une image s'écritset:NAME image:IMG, un morceau d'un atlas.imageset. Les deux doivent être chargés par le jeu : ceux du vanilla le sont, ceux d'un mod doivent être listés dans sonconfig.cpp. Voir Studio de styles. - Textes : un texte commençant par
#est une clé destringtable.csv, traduite par le jeu. La case Textes montre la traduction. - Menu ou handler : un
UIScriptedMenuest un écran entier qui prend les entrées et affiche le curseur ; unScriptedWidgetEventHandlerreçoit les événements d'un panneau à l'intérieur d'un autre écran. Les menus vont dans5_Mission. - Zone de sécurité : la partie de l'écran que les consoles garantissent d'afficher. Les widgets avec
keepsafezonesont déplacés à l'intérieur.
Référence : le wiki communautaire de Bohemia Interactive (DayZ Workbench, GUI editor) et docs/FORMATS.md de ce projet.
Pièges
- Un style ou une image s'affiche ici mais pas dans le jeu : son
.stylesou.imagesetn'est pas listé dans leconfig.cppdu mod. L'onglet Problèmes indique quel fichier. - Une texture manquante : l'onglet Problèmes liste les images et textures introuvables à la fois dans le jeu et dans vos workspaces. Les textures sont référencées par leur chemin en jeu (préfixe de l'addon + chemin relatif).
- Glisser ne fait rien dans un spacer : la barre d'état dit que le parent contrôle la position. Réordonnez dans la hiérarchie.
- Un widget de taille 0, ou entièrement rogné par son parent est invisible : les deux sont signalés comme des problèmes.
- Modifier les enfants générés d'une liste déroulante DZML : ils viennent d'une macro ; l'inspecteur le dit et la modification doit être faite dans le HTML.
- Modifier le .layout compilé d'une page DZML : le prochain Compiler le remplace. Modifiez le
.html. - Le fichier a changé sur le disque (l'assistant, un autre éditeur, git) : un onglet sans modifications prend la nouvelle version, l'ancienne reste à un Annuler de distance ; un onglet avec des modifications affiche un bandeau pour choisir.
- Masquer et verrouiller dans la hiérarchie sont des états de l'éditeur : ils ne sont pas enregistrés et ne changent rien dans le jeu.
- L'onglet Navigateur exécute la page isolée : ses scripts tournent, mais ne peuvent lire ni les fichiers du Workbench ou de votre disque, ni ses réglages. Les fichiers hors du dossier de la page, des espaces de travail et du jeu ne lui sont pas servis.
Pour les agents
Outils de dzt qui font le même travail sans la fenêtre :
layout_inspect: analyse un.layout(chemin disque ou chemin virtuel du jeu) : diagnostics et arbre des widgets avec rectangles calculés en 1920x1080.layout_widget_classes: les classes de widgets et chaque propriété avec type, valeur par défaut et options. Lisez-le avant d'écrire un layout à la main.layout_validate: vérification de syntaxe d'un texte.layout, avec la mise en forme canonique.layout_render: rend un.layoutou un.htmlDZML en PNG comme le jeu l'afficherait, avec les constats.dzml_check: valide un document DZML (noms, widgets et classes inconnus, liaisons, références de styles) avec ligne et colonne.dzml_compile: DZML vers.layout.dzml_decompile:.layoutvers DZML.dzml_bundle: une page et ses sous-pages dans un seul.bundle.html.dzml_scaffold: pour une page DZML dans un mod, écrit le.layout, les layouts de lignes et le script du menu.ui_style_check: vérifie que chaque style utilisé par les layouts d'un mod est chargé par le jeu.vfs_searchetvfs_read: trouver et lire les layouts du jeu (gui/layouts/...).
Fichiers :
- Lus :
.layout,.html/.dzml(un.htmlcompte comme du DZML quand il contientdata-dzml), les layouts du jeu depuis ses PBO, et les.imageset,.styles, polices etstringtable.csvdu jeu et des workspaces.dzml.config.yaml, cherché en remontant depuis un fichier DZML, donne les alias de polices. - Écrits : le document à Enregistrer / Enregistrer sous (texte
.layout, ou le.htmld'une page DZML) ; le.layoutet les layouts de lignes à Compiler ; un.bundle.htmlà Regrouper ; un.htmlà Vers DZML ; les prefabs sous forme de fichiers.layoutdans le dossierprefabsdu dossier de paramètres du Workbench ; le.cgénéré à Écrire dans le mod. Les fichiers du jeu ne sont jamais écrits.
Ce que la page dit à l'assistant : le fichier ouvert (ou untitled.layout), le widget sélectionné sous la forme name (class), la vue (design, source ou browser preview), la résolution du canevas, s'il y a des modifications non enregistrées, et les messages de l'onglet Problèmes. Elle propose une action à l'assistant, « Vérifier ce layout ».
Les ancres des visites et du pointage sont listées dans le fichier de guide de la page (layout-palette, layout-hierarchy, layout-canvas, layout-inspector, layout-save, layout-play...).
Voir aussi
- Comment fonctionne DZML
- Studio de styles : styles, imagesets et icônes pour vos widgets.
- Éditeur de scripts : la classe qui ouvre le layout.
- Textures (PAA) : les images qu'un layout référence.
- Packer PBO : empaqueter le mod avec ses layouts.