Compiling for Windows¶
This page describes how to compile Windows editor and export template binaries from source. If you're looking to export your project to Windows instead, read Exporting for Windows.
For compiling under Windows, the following is required:
Visual Studio Community, version 2017 or later. VS 2019 is recommended. Make sure to read "Installing Visual Studio caveats" below or you will have to run/download the installer again.
MinGW-w64 with GCC can be used as an alternative to Visual Studio. Be sure to install/configure it to use the
posixthread model. Important: When using MinGW to compile the
masterbranch, you need GCC 9 or later.
Python 3.6+. Make sure to enable the option to add Python to the ``PATH`` in the installer.
SCons 3.0+ build system. Using the latest release is recommended, especially for proper support of recent Visual Studio releases.
If you have Scoop installed, you can easily install MinGW and other dependencies using the following command:
scoop install gcc python scons make
If you have MSYS2 installed, you can easily install MinGW and other dependencies using the following command:
pacman -S mingw-w64-x86_64-python3-pip mingw-w64-x86_64-gcc \ mingw-w64-i686-python3-pip mingw-w64-i686-gcc make
For each MSYS2 MinGW subsystem, you should then run pip3 install scons in its shell.
Setting up SCons¶
To install SCons, open the command prompt and run the following command:
python -m pip install scons
If you are prompted with the message
Defaulting to user installation because normal site-packages is not
writeable, you may have to run that command again using elevated
permissions. Open a new command prompt as an Administrator then run the command
again to ensure that SCons is available from the
To check whether you have installed Python and SCons correctly, you can
python --version and
scons --version into a command prompt
If the commands above don't work, make sure to add Python to your
environment variable after installing it, then check again.
You can do so by running the Python installer again and enabling the option
to add Python to the
If SCons cannot detect your Visual Studio installation, it might be that your
SCons version is too old. Update it to the latest version with
python -m pip install --upgrade scons.
Installing Visual Studio caveats¶
If installing Visual Studio 2017 or 2019, make sure to enable C++ in the list of workflows to install.
If installing Visual Studio 2015, make sure to run a Custom installation instead of Typical and select C++ as a language there.
If you've already made the mistake of installing Visual Studio without C++ support, run the installer again; it should present you a Modify button. Running the installer from Add/Remove Programs will only give you a Repair option, which won't let you install C++ tools.
Downloading Godot's source¶
Refer to Getting the source for detailed instructions.
The tutorial will assume from now on that you placed the source code in
To prevent slowdowns caused by continuous virus scanning during compilation, add the Godot source folder to the list of exceptions in your antivirus softwar