Journal du jeu et du système

Le journal du jeu affiche toutes les sorties du moteur, des extensions natives et de la logique de votre jeu. Les commandes print() et pprint() peuvent être utilisées dans vos scripts et modules Lua pour afficher des informations dans le journal du jeu. Vous pouvez utiliser les fonctions de l’espace de noms (namespace) dmLog pour écrire dans le journal du jeu depuis les extensions natives. Le journal du jeu peut être consulté depuis l’éditeur, depuis une fenêtre de terminal, à l’aide d’outils propres à chaque plateforme ou depuis un fichier journal.

Les journaux du système sont générés par le système d’exploitation et peuvent fournir des informations supplémentaires pour vous aider à localiser un problème. Ils peuvent contenir des traces de pile en cas de plantage et des avertissements de mémoire insuffisante.

Lire le journal du jeu depuis l’éditeur

Lorsque vous exécutez votre jeu localement depuis l’éditeur ou en étant connecté à l’application de développement mobile, toutes les sorties s’affichent dans le panneau de console de l’éditeur :

Lire le journal du jeu depuis le terminal

Lorsque vous exécutez un jeu Defold depuis le terminal, le journal s’affiche directement dans la fenêtre du terminal. Sous Windows et Linux, saisissez le nom de l’exécutable dans le terminal pour démarrer le jeu. Sous macOS, vous devez lancer le moteur depuis l’intérieur du fichier .app :

$ > ./mygame.app/Contents/MacOS/mygame

Lire les journaux du jeu et du système à l’aide d’outils propres à chaque plateforme

HTML5

Les journaux peuvent être consultés à l’aide des outils de développement fournis par la plupart des navigateurs.

• Chrome - Menu > More Tools > Developer Tools
• Firefox - Tools > Web Developer > Web Console
• Edge
• Safari - Develop > Show JavaScript Console

Android

Vous pouvez utiliser l’outil Android Debug Bridge (ADB) pour consulter le journal du jeu et du système.

L’outil en ligne de commande adb est un programme polyvalent et facile à utiliser qui permet d’interagir avec les appareils Android. Vous pouvez télécharger et installer adb avec les Android SDK Platform-Tools, pour Mac, Linux ou Windows.

Téléchargez les Android SDK Platform-Tools à l’adresse suivante : https://developer.android.com/studio/releases/platform-tools. Vous trouverez l’outil adb dans /platform-tools/. Vous pouvez également installer des paquets propres à chaque plateforme à l’aide de leurs gestionnaires de paquets respectifs.

Sur Ubuntu Linux :

$ sudo apt-get install android-tools-adb

Sur Fedora 18/19 :

$ sudo yum install android-tools

Sur macOS (Homebrew)

$ brew cask install android-platform-tools

Vous pouvez vérifier que adb fonctionne en connectant votre appareil Android à votre ordinateur par USB et en exécutant la commande suivante :

$ adb devices
List of devices attached
31002535c90ef000    device

Si votre appareil n’apparaît pas, vérifiez que vous avez activé USB debugging sur l’appareil Android. Ouvrez les Settings de l’appareil et recherchez Developer options (ou Development).

Une fois l’outil installé et configuré, connectez votre appareil par USB, ouvrez un terminal et exécutez :

$ cd <path_to_android_sdk>/platform-tools/
$ adb logcat

L’appareil enverra alors toutes les sorties au terminal actuel, y compris les messages affichés par le jeu.

Si vous souhaitez voir uniquement les sorties des applications Defold, utilisez cette commande :

$ cd <path_to_android_sdk>/platform-tools/
$ adb logcat -s defold
--------- beginning of /dev/log/system
--------- beginning of /dev/log/main
I/defold  ( 6210): INFO:ENGINE: Defold Engine 1.2.50 (8d1b912)
I/defold  ( 6210): INFO:ENGINE: Loading data from:
I/defold  ( 6210): INFO:ENGINE: Initialized sound device 'default'
I/defold  ( 6210):
D/defold  ( 6210): DEBUG:SCRIPT: Hello there, log!
...

iOS

Plusieurs options s’offrent à vous pour lire les journaux du jeu et du système sous iOS :

1. Vous pouvez utiliser l’outil Console pour lire le journal du jeu et du système.
2. Vous pouvez utiliser le débogueur LLDB pour vous attacher à un jeu en cours d’exécution sur un appareil. Pour déboguer un jeu, celui-ci doit être signé avec un « Apple Developer Provisioning Profile » qui inclut l’appareil sur lequel vous souhaitez le déboguer. Créez un bundle du jeu depuis l’éditeur et fournissez le profil de provisionnement dans la boîte de dialogue de création du bundle (la création de bundles pour iOS n’est disponible que sous macOS).

Pour lancer le jeu et y attacher le débogueur, vous aurez besoin d’un outil appelé ios-deploy. Installez et déboguez votre jeu en exécutant la commande suivante dans un terminal :

$ ios-deploy --debug --bundle <path_to_game.app> # NOTE: not the .ipa file

Cela installera l’application sur votre appareil, la démarrera et y attachera automatiquement un débogueur LLDB. Si vous découvrez LLDB, lisez le guide Premiers pas avec LLDB.

Lire le journal du jeu depuis le fichier journal

Utilisez le paramètre du projet « Write Log File » dans game.project pour contrôler la journalisation dans un fichier :

• « Never » : ne pas écrire de fichier journal.
• « Debug » : écrire un fichier journal uniquement pour les builds Debug.
• « Always » : écrire un fichier journal pour les builds Debug et Release.

Lorsque cette option est activée, toutes les sorties du jeu sont écrites sur le disque dans un fichier nommé « log.txt ». Voici comment extraire ce fichier si vous exécutez le jeu sur un appareil :

iOS

Connectez votre appareil à un ordinateur sur lequel macOS et Xcode sont installés.

Ouvrez Xcode et accédez à Window ▸ Devices and Simulators.

Sélectionnez votre appareil dans la liste, puis sélectionnez l’application concernée dans la liste Installed Apps.

Cliquez sur l’icône d’engrenage sous la liste et sélectionnez Download Container....

Une fois le conteneur extrait, il apparaît dans le Finder. Faites un clic droit sur le conteneur et sélectionnez Show Package Content. Repérez le fichier « log.txt », qui devrait se trouver dans « AppData/Documents/ ».

Android(

La possibilité d’extraire le fichier « log.txt » dépend de la version du système d’exploitation et du fabricant. Voici un guide pas à pas court et simple.