Compilation pour Windows

Pré-requis

Pour la compilation sous Windows, ce qui suit est nécessaire :

  • Visual Studio Community, version 2017 ou ultérieure. VS 2019 est recommandé. Assurez-vous de lire la section "Mise en garde concernant l'installation de Visual Studio" ci-dessous ou vous devrez exécuter/télécharger l'installateur à nouveau.
  • MinGW-w64 avec GCC peut être utilisé comme une alternative à Visual Studio. Assurez-vous de l'installer/configurer pour utiliser le modèle de thread posix.
  • Python 3.5+.
  • Système de compilation(build) SCons 3.0. Si vous utilisez Visual Studio 2019, vous devez avoir SCons 3.1.1 ou plus récent.
  • Facultatif - yasm (pour les optimisations de WebM SIMD)

Note

Si vous avez installé Scoop, vous pouvez facilement installer MinGW et d'autres dépendances en utilisant la commande suivante :

scoop install gcc python scons yasm make

Note

Si vous avez installé MSYS2, vous pouvez facilement installer MinGW et d'autres dépendances en utilisant la commande suivante :

pacman -S mingw-w64-x86_64-python3-pip \
    mingw-w64-x86_64-gcc mingw-w64-x86_64-yasm \
    mingw-w64-i686-python3-pip mingw-w64-i686-gcc \
    mingw-w64-i686-yasm make

Pour chaque sous-système MinGW de MSYS2, vous devez ensuite exécuter pip install scons dans sa console.

Voir aussi

Pour un aperçu général de l'utilisation de SCons pour Godot, voir Introduction au buildsystem.

Configuration de Python

Premièrement, vous devez d'abord installer Python 3.5 ou plus récent. Assurez-vous d'avoir activé l'option pour ajouter Python au PATH dans l'installateur Python. L'installateur Scons doit alors détecter et utiliser l'installation Python existante.

Configuration de SCons

Pour installer SCons, ouvrez l'invite de commande et exécutez la commande suivante.

python -m pip install scons

Pour vérifier si vous avez correctement installé Python et SCons, il faut taper python --version et scons --version dans l'invite de commande (cmd.exe).

Si les commandes ci-dessus ne fonctionnent pas, assurez-vous d'ajouter Python dans votre variable d'environnement PATH après son installation, puis vérifiez de nouveau. Vous pouvez le faire en exécutant de nouveau l'installateur Python et en activant l'option pour ajouter Python au PATH.

Mise en garde concernant l'installation de Visual Studio

Si vous installez Visual Studio 2017 ou 2019, assurez-vous d'activer C++ dans la liste des flux de travail(workflows) à installer.

Si vous installez Visual Studio 2015, assurez-vous de lancer une installation Custom au lieu d'une installation Typical et sélectionnez C++ comme langage.

Si vous avez déjà fait l'erreur d'installer Visiul Studio sans support C++, exécutez encore l'installateur ; il devrait vous présenter un bouton Modify. L'exécution de l'installateur depuis Add/Remove Programs vous donnera seulement l'option Repair, qui ne vous permettra pas d'installer les outils C ++.

Téléchargement des sources de Godot

Le code source de Godot est hébergé sur GitHub. Il est recommandé de le télécharger (cloner) en utilisant Git.

Le tutoriel suppose que vous avez placé le code source dans le répertoire C:\godot.

Compilation

Sélection d'un compilateur

SCons trouvera et utilisera automatiquement une installation Visual Studio existante. Si vous n'avez pas Visual Studio d'installé, il essaiera d'utiliser MinGW à la place. Si vous avez déjà Visual Studio d'installé et que vous voulez utiliser MinGW, passez use_mingw=yes à la ligne de commande SCons.

Durant le développement, l'utilisation du compilateur de Visual Studio est une meilleure idée, il relie le binaire de Godot beaucoup plus rapidement que MinGW. Pourtant, MinGW peut produire des binaires plus optimisés en utilisant l'optimisation du temps de liaison (voir ci-dessous), ce qui en fait un meilleur choix pour l'utilisation en production.

Exécuter SCons

Après avoir ouvert une invite de commande, allez dans le répertoire racine du code source du moteur (en utilisant cd) et tapez :

C:\godot> scons platform=windows

Vous pouvez spécifier le nombre de threads CPU à utiliser pour accélérer la compilation:

C:\godot> scons -j6 platform=windows

En général, il est correct d'avoir au moins autant de threads compilant Godot que de cœurs dans votre CPU, sinon un ou deux de plus. N'hésitez pas à ajouter l'option -j à n'importe quelle commande SCons que vous voyez ci-dessous.

Note

Lors de la compilation avec plusieurs threads CPU, Scons peut avertir à propos de pywin32. Vous pouvez ignorer cette avertissement en toute sécurité.

Si tout va bien, l'exécutable binaire résultant sera placé dans C:\godot\bin\ avec le nom godot.windows.tools.32.exe ou godot.windows.tools.64.exe. Par défaut, SCons construira un binaire correspondant à l'architecture de votre CPU, mais il est possible de le remplacer par bits=64 ou bits=32.

Ce fichier exécutable contient l'ensemble du moteur et peut s'exécuter sans aucune dépendance. L'exécuter fera apparaître le Gestionnaire de Projet.

Note

Si vous compilez Godot pour une utilisation en production, alors vous pouvez rendre l'exécutable final plus petit et plus rapide en ajoutant l'option SCons target=release_debug.

Si vous compilez Godot avec MinGW, vous pouvez rendre le binaire encore plus petit et plus rapide en ajoutant l'option SCons use_lto=yes. L'optimisation du temps de connexion étant un processus gourmand en mémoire, cela nécessitera environ 3 Go de RAM disponible lors de la compilation.

Note

Si vous souhaitez utiliser des paramètres d'édition séparés pour vos propres constructions Godot et vos versions officielles, vous pouvez activer Mode autonome en créant un fichier appelé ._sc_ ou _sc_ dans le dossier bin/.

Développement dans Visual Studio ou d'autres EDI

Pour la plupart des projets, l'utilisation de script seule suffit mais lorsque le développement en C++ est nécessaire, pour la création de modules ou étendre le moteur, travailler avec un IDE est généralement préférable.

Vous pouvez créer une solution Visual Studio avec SCons en lançant SCons avec le paramètre vsproj=yes, comme ceci:

scons p=windows vsproj=yes

Vous serez maintenant capable d'ouvrir les sources de Godot dans une solution Visual Studio, et à même de construire Godot en utilisant le bouton Build de Visual Studio.

Si vous devez modifier les commandes de construction(build), elles se trouvent dans les paramètres du projet "Godot", feuille NMAKE. SCons est appelé à la fin des commandes. Si vous faites une erreur, copiez la commande depuis l'une des autres configurations de build (debug, release_debug, release) ou architectures (Win32/x64) ; elles sont équivalentes.

Compilation croisée pour Windows à partir d'autres systèmes d'exploitation

Si vous êtes un utilisateur de Linux ou de macOS, vous devez installer MinGW-w64, qui se présente généralement sous forme de variantes 32 bits et 64 bits. Les noms de paquets peuvent différer en fonction de votre distribution, en voici quelques uns connus :

Arch Linux Installez mingw-w64-gcc à partir de l'AUR.
Debian / Ubuntu 
apt install mingw-w64
Fedora 
dnf install mingw64-gcc-c++ mingw64-winpthreads-static \
            mingw32-gcc-c++ mingw32-winpthreads-static
macOS 
brew install mingw-w64
Mageia 
urpmi mingw64-gcc-c++ mingw64-winpthreads-static \
      mingw32-gcc-c++ mingw32-winpthreads-static

Avant de tenter la compilation, SCons vérifiera les binaires suivants dans votre variable d'environnement PATH :

i686-w64-mingw32-gcc
x86_64-w64-mingw32-gcc

Si les binaires ne sont pas situés dans le PATH (par exemple /usr/bin), vous pouvez définir les variables d'environnement suivantes pour donner un indice au système de compilation :

export MINGW32_PREFIX="/path/to/i686-w64-mingw32-"
export MINGW64_PREFIX="/path/to/x86_64-w64-mingw32-"

Pour vous assurer que vous faites les choses correctement, l'exécution de ce qui suit dans le shell devrait aboutir à un compilateur qui fonctionne (la version de la sortie peut différer en fonction de votre système) :

${MINGW32_PREFIX}gcc --version
# i686-w64-mingw32-gcc (GCC) 6.1.0 20160427 (Mageia MinGW 6.1.0-1.mga6)

Dépannage

La compilation croisée à partir de certaines versions d'Ubuntu peut conduire à ce bogue, en raison d'une configuration par défaut ne supportant pas le threading POSIX.

Vous pouvez modifier cette configuration en suivant ces instructions, pour 64 bits :

sudo update-alternatives --config x86_64-w64-mingw32-gcc
<choose x86_64-w64-mingw32-gcc-posix from the list>
sudo update-alternatives --config x86_64-w64-mingw32-g++
<choose x86_64-w64-mingw32-g++-posix from the list>

Et pour 32-bit :

sudo update-alternatives --config i686-w64-mingw32-gcc
<choose i686-w64-mingw32-gcc-posix from the list>
sudo update-alternatives --config i686-w64-mingw32-g++
<choose i686-w64-mingw32-g++-posix from the list>

Création de modèles d'exportation Windows

Les modèles d'exportation Windows sont créés en compilant Godot sans l'éditeur, avec les drapeaux suivants :

C:\godot> scons platform=windows tools=no target=release_debug bits=32
C:\godot> scons platform=windows tools=no target=release bits=32
C:\godot> scons platform=windows tools=no target=release_debug bits=64
C:\godot> scons platform=windows tools=no target=release bits=64

Si vous envisagez de remplacer les modèles d'exportation standard, copiez-les à l'emplacement suivant, en remplaçant <version> par l'identificateur de version (tel que 3.1.1.stable ou 3.2.dev) :

%USERPROFILE%\AppData\Roaming\Godot\templates\<version>\

Avec les noms suivants :

windows_32_debug.exe
windows_32_release.exe
windows_64_debug.exe
windows_64_release.exe

Cependant, si vous utilisez des modules personnalisés ou du code personnalisé dans moteur, vous pouvez plutôt vouloir configurer vos binaires comme modèles d'exportation personnalisés ici :

../../_images/wintemplates.png

Vous n'avez pas besoin de les copier dans ce cas, il suffit de référencer les fichiers résultants dans le répertoire bin\ de votre dossier source Godot, de sorte que la prochaine fois que vous construirez, vous aurez automatiquement les modèles personnalisés référencés.