Up to date
This page is up to date for Godot 4.3.
If you still find outdated information, please open an issue.
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.
Note
Sur Windows et Linux, vous pouvez executer un binaire Godot dans un terminal en spécifiant son chemin relatif ou absolu.
Sur macOS, le processus est différent parce que Godot est intégré dans un packet .app (qui est un répertoire et pas un fichier). Pour exécuter un binaire Godot depuis un terminal macOS, vous devez cd dans le répertoire du packet et puis faire Godot.app/Contents/MacOS/Godot suivi par les arguments de commande. Si vous avez renommé le packet Godot vers un autre nom, assurez-vous de remplacer Godot dans la commande par votre nom.
Référence de ligne de commande
Légende
Disponible dans les compilations de l'éditeur, des modèles d'export de débogage et des modèles d'export de publication.
Disponible uniquement dans les modèles d'export de l'éditeur et de debug.
Seulement disponible dans les compilations de l'éditeur.
Notez que les arguments de ligne de commande inconnus n'ont aucun effet. Le moteur ne vous avertira pas si vous utilisez un argument de ligne de commande qui n'existe pas avec un type de compilation donné.
Options générales
Commande |
Description |
|
|
|
|
|
|
|
|
Options d'exécution
Commande |
Description |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
4.3 Mot de passe pour le système de fichiers distant. |
|
|
|
|
|
|
|
|
|
|
|
|
|
4.3 Pilote pour les entrées de tablette graphique. |
|
|
|
|
Options d'affichage
Commande |
Description |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Options de débogage
Commande |
Description |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|releaseI Activer ou désactiver le lissage de l'image (frame delta smoothing) ('enable', 'disable'). |
|
|
Outils autonomes
Commande |
Description |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Chemin
Il est recommandé que votre binaire d'éditeur 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 (sensible à la casse).
Pour effectuer cela sur Windows ou macOS facilement, vous pouvez installer Godot en utilisant Scoop (sur Windows) ou Homebrew <https://brew.sh>`__ (sur macOS). Ceci rendra automatiquement la copie de Godot installée disponible dans le ``PATH :
# Add "Extras" bucket
scoop bucket add extras
# Standard editor:
scoop install godot
# Editor with C# support (will be available as `godot-mono` in `PATH`):
scoop install godot-mono
# Standard editor:
brew install godot
# Editor with C# support (will be available as `godot-mono` in `PATH`):
brew install godot-mono
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.
Lors de l'exécution de l'éditeur, cela peut être fait en donnant le chemin du fichier project.godot de votre projet soit en tant que premier argument, comme ceci :
godot path_to_your_project/project.godot [other] [commands] [and] [args]
Pour toutes les commandes, cela peut être fait en utilisant l'argument --path :
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 :
godot --headless --path path_to_your_project --export-release my_export_preset_name game.exe
En commençant dans un sous-répertoire de votre projet, utilisez l'argument --upwards pour que Godot trouve automatiquement le fichier``project.godot`` en recherchant de manière récursive les répertoires parents.
Par exemple, exécuter une scène (comme expliqué ci-dessous) nichée dans un sous-répertoire pourrait ressembler à ceci lorsque votre répertoire de travail est dans le même chemin :
godot --upwards nested_scene.tscn
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.
mkdir newgame
cd 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 comme expliqué au dessus, sinon la commande est ignorée et le gestionnaire de projet apparaît.
godot -e
En passant le chemin complet vers le fichier project.godot, le drapeau -e peut être omis.
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.
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.
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 comme expliqué au dessus.
godot
Notez que passer le fichier project.godot va toujours exécuter l'éditeur au lieu d’exécuter le jeu.
Lorsqu'une scène spécifique doit être testée, passez cette scène à la ligne de commande.
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.
godot -d
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égration continue.
Note
Utiliser l'argument de ligne de commande --headless est requis sur les plates-formes qui n'ont pas d'accès au GPU (comme en intégration continue). Sur les plates-formes avec accès au GPU, --headless empêche une fenêtre d'apparaître pendant que le projet est exporté.
# `godot` must be a Godot editor binary, not an export template.
# Also, export templates must be installed for the editor
# (or a valid custom export template must be defined in the export preset).
godot --headless --export-release "Linux/X11" /var/builds/project
godot --headless --export-release Android /var/builds/project.apk
Le nom du préréglage doit correspondre au nom d'un préréglage d'exportation défini dans le fichier export_presets.cfg du projet. Si le nom du préréglage contient des espaces ou des caractères spéciaux (tels que "Windows Desktop"), il doit être entouré de guillemets.
Pour exporter une version de débogage du jeu, utilisez le commutateur --export-debug au lieu de --export-release. Leurs paramètres et leur utilisation sont les mêmes.
Pour exporter uniquement un fichier PCK, utilisez l'option --export-pack suivie du nom du préréglage et du chemin de sortie, avec l'extension du fichier, au lieu de --export-release ou export-debug. L'extension du chemin de sortie détermine le format du paquet, soit PCK soit ZIP.
Avertissement
Lorsque vous spécifiez un chemin relatif comme chemin pour --export-release, --export-debug ou --export-pack, le chemin sera relatif au répertoire contenant le fichier project.godot, non relatif au répertoire de travail actuel.
Exécuter un script
Il est possible d'exécuter un simple script .gd en ligne de commande. Cette fonctionnalité est particulièrement utile dans les grands projets, par ex. pour la conversion groupée de ressources, ou l’import/export personnalisé.
Le script doit hériter de SceneTree ou MainLoop.
Voici un exemple sayhello.gd, montrant son fonctionnement :
#!/usr/bin/env -S godot -s
extends SceneTree
func _init():
print("Hello!")
quit()
Et comment l'exécuter :
# Prints "Hello!" to standard output.
godot -s sayhello.gd
Si aucun fichier project.godot n'existe au chemin, le chemin courant est supposé être le répertoire de travail courant (sauf si --path est spécifié).
La première ligne de sayhello.gd ci-dessus est communément appelée shebang. Si le binaire Godot se trouve dans votre PATH en tant que godot, il vous permet d'exécuter le script comme suit dans les distributions Linux modernes, ainsi que dans macOS :
# Mark script as executable.
chmod +x sayhello.gd
# Prints "Hello!" to standard output.
./sayhello.gd
Si ce qui précède ne fonctionne pas dans votre version actuelle de Linux ou de macOS, vous pouvez toujours faire en sorte que le shebang exécute Godot directement à partir de l'endroit où il se trouve comme suit :
#!/usr/bin/godot -s