Tutoriel de ligne de commande

Certains développeurs aiment beaucoup utiliser la ligne de commande. Godot est conçu pour leur être agréable, alors voici les étapes pour travailler entièrement à partir de la ligne de commande. Étant donné que le moteur ne nécessite que peu ou pas de bibliothèques externes, les temps d’initialisation sont assez rapides, ce qui le rend adapté à cette méthode de travail.

Chemin

Il est recommandé que votre binaire Godot soit dans votre variable d’environnement PATH, de sorte qu’il puisse être exécuté facilement à partir de n’importe quel endroit en tapant godot. Vous pouvez le faire sous Linux en plaçant le binaire Godot dans /usr/local/bin et en vous assurant qu’il s’appelle godot.

Définir le chemin du projet

Selon l’endroit où se trouve votre binaire Godot et votre répertoire de travail actuel, vous devrez peut-être définir le chemin d’accès à votre projet pour que les commandes suivantes fonctionnent correctement.

Cela peut être fait en donnant le chemin du fichier project.godot de votre projet en tant que premier argument, comme ceci :

[email protected]:~$ godot path_to_your_project/project.godot [other] [commands] [and] [args]

ou en utilisant l’argument --path :

[email protected]:~$ godot --path path_to_your_project [other] [commands] [and] [args]

Par exemple, la commande complète pour exporter votre jeu (comme expliqué ci-dessous) pourrait ressembler à ceci :

[email protected]:~$ godot --path path_to_your_project --export my_export_preset_name game.exe

Créer un projet

La création d’un projet à partir de la ligne de commande peut se faire en naviguant dans le shell jusqu’à l’endroit désiré et en créant un fichier project.godot.

[email protected]:~$ mkdir newgame
[email protected]:~$ cd newgame
[email protected]:~/newgame$ touch project.godot

Le projet peut maintenant être ouvert avec Godot.

Exécution de l’éditeur

L’exécution de l’éditeur se fait en exécutant Godot avec le paramètre -e. Cela doit être fait depuis le répertoire du projet ou un sous-répertoire, sinon la commande est ignorée et le gestionnaire de projet apparaît.

[email protected]:~/newgame$ godot -e

Si une scène a été créée et enregistrée, elle peut être modifiée ultérieurement en exécutant le même code avec la dite scène en argument.

[email protected]:~/newgame$ godot -e scene.tscn

Effacer une scène

Godot respecte votre système de fichiers et ne créera pas de fichiers de métadonnées supplémentaires. Utilisez rm pour effacer un fichier de scène. Assurez-vous que rien ne fait référence à cette scène, sinon cela provoquera une erreur à l’ouverture.

[email protected]:~/newgame$ rm scene.tscn

Éxécuter le jeu

Pour lancer le jeu, il suffit d’exécuter Godot dans le répertoire ou sous-répertoire du projet.

[email protected]:~/newgame$ godot

Lorsqu’une scène spécifique doit être testée, passez cette scène à la ligne de commande.

[email protected]:~/newgame$ godot scene.tscn

Débogage

Intercepter les erreurs dans la ligne de commande peut être une tâche difficile car elles ne font que défiler. Pour cela, un débogueur de ligne de commande est fourni en ajoutant -d. Cela fonctionne à la fois pour exécuter le jeu ou une simple scène.

[email protected]:~/newgame$ godot -d
[email protected]:~/newgame$ godot -d scene.tscn

Exportation

L’exportation du projet à partir de la ligne de commande est également prise en charge. Ceci est particulièrement utile pour les configurations d’intégrations continues. La version simplifiée de Godot (construction de serveurs, pas de vidéo ni interface graphique…) est idéale pour cela.

[email protected]:~/newgame$ godot --export "Linux X11" /var/builds/project
[email protected]:~/newgame$ godot --export Android /var/builds/project.apk

Les noms de plates-formes reconnus par le commutateur --export sont les mêmes que ceux affichés dans l’assistant d’exportation de l’éditeur. Pour obtenir une liste des plates-formes prises en charge à partir de la ligne de commande, essayez d’exporter vers une plate-forme non reconnue et la liste complète des plates-formes prises en charge par votre configuration sera affichée.

Pour exporter une version de débogage du jeu, utilisez le commutateur --export-debug au lieu de --export. Leurs paramètres et leur utilisation sont les mêmes.

Exécuter un script

Il est possible d’exécuter un simple script .gd à partir de la ligne de commande. Cette fonctionnalité est particulièrement utile dans les grands projets, pour la conversion par lots de ressources, ou l’import/export personnalisé.

Le script doit hériter de SceneTree ou MainLoop.

Voici un simple exemple de son fonctionnement :

#sayhello.gd
extends SceneTree

func _init():
    print("Hello!")
    quit()

Et comment l’exécuter :

[email protected]:~/newgame$ godot -s sayhello.gd
Hello!

Si aucun fichier project.godot n’existe dans le chemin, le chemin courant est supposé être le répertoire de travail courant (sauf si -path est spécifié).