Compile on Windows: Difference between revisions

From FreeCAD Documentation
(Add Japanese to languages)
(Since CMake 3.15.6 CMake 3.15 now work)
(165 intermediate revisions by 15 users not shown)
Line 1: Line 1:
<languages/>
This article explains step by step '''how to compile FreeCAD on Windows'''.
<translate>
<!--T:109-->
{{docnav
|[[Tracker|Tracker]]
|[[Compile_on_Linux/Unix|Compile on Linux/Unix]]
}}


<!--T:1-->
=== Prerequisites ===
This page explains step by step '''how to compile FreeCAD 0.18 or newer on Windows'''.
What you need is mainly the compiler. On Windows we use the M$
VisualStudio 8 Compiler (or VC++ Express) with the highest service pack. Although it's
probably possible to use Cygwin or MingW gcc it's not tested or ported so
far. We have also ported to use VC8 Express Edition.
You need to download the Windows Platform SDK to get e.g. the Windows.h.
Also you need all the [[Third Party Libraries]] to successfully compile FreeCAD.


== Prerequisites == <!--T:2-->
If you use the M$ compilers you want most likely download the FreeCAD LibPack
which provides you with all needed libs to build FreeCAD on Windows.


<!--T:136-->
Other prerequisites (and helpful programs) are:
At first you must install the following required programs ad libraries:
* cMake
* TortoiseGit
* Python 2.6
* WiX (Windows installer XML v3.0) - if you want to make msi installer


===Required=== <!--T:100-->
It is also necessary to have, in your system path, paths to:
* Libpack
* git (not tortoiseGit, but git.exe)
* python


<!--T:116-->
=== Building with cMake ===
* [http://git-scm.com/ Git] (There are also a GUI frontends available for Git, see the next section.)


<!--T:170-->
First of all, you have to [http://www.cmake.org/cmake/resources/software.html download cMake]
* [http://www.cmake.org/cmake/resources/software.html CMake] version 3.11.x - 3.15.x. '''Note:''' Usually one cannot take the latest CMake version. Therefore only use a CMake version in the range specified on this page!
and install it on your build machine.


<!--T:171-->
==== The switch to cMake ====
It is recommended to use the option ''Add CMake to the system PATH for all users'' when installing CMake. Then you can later easily access CMake also from the command line/powershell.
Since version 0.9 we use the cMake build system to generate the build/make files
for various compilers. We do not longer deliver .vcproj files.
If you want build former versions of FreeCAD (0.8 and older) see "Building older versions"
later in this article.


<!--T:172-->
We switched because it became more and more painful to maintain project files for 30+
* LibPack (also called FreeCADLibs). This is a set of libraries necessary to compile FreeCAD on Windows. Depending on the FreeCAD version you want to compile, you must download the corresponding LibPack. For example to compile FreeCAD 0.18, download either the 32bit or the 64bit version of the [https://github.com/FreeCAD/FreeCAD-ports-cache/releases/tag/v0.18 LibPack for 0.18], to compile the latest development version 0.19, download the [https://github.com/FreeCAD/FreeCAD/releases/tag/0.19_pre LibPack for 0.19] (there is only a 64bit version).
build targets and x compilers. cMake gives us the posibility to support alternative
IDEs, like Code::Blocks, Qt Creator and Eclipse CDT the main compiler
we use is still M$ VC9 Express, though. But we plan for the future a build process on
Windows without proprietary compiler software.
==== Configure the build process ====


<!--T:173-->
The first step to build FreeCAD with cMake is to configure the environment. There
Just download the LibPack, you will unpack and set it up later.
are basically two ways to go:
* Using the LibPack
* Installing all needed libs and let cMake find them


<!--T:174-->
In the first case you only need to give cMake the path to the LibPack
'''Note''': It is recommended to use the same compiler ''MS Visual Studio'' (MSVC) version the LibPack is designed for. This assures that the compilation and the execution of the compiled FreeCAD.exe succeeds. So you should for example be able to compile FreeCAD 0.18 using the LibPack for 0.19 and MSVC 15 but you you might get problems compiling FreeCAD 0.18 using the LibPack for 0.18 and MSVC 15 because the LibPack for 0.18 is designed to be built with MSVC&nbsp;12.
and all the rest should be done automatically and you see such a screen:
[[File:CMake_Screen.png]]


===Optional programs=== <!--T:137-->
You see the LibPack path inserted into the '''FREECAD_LIBPACK_DIR''' variable. Starting
from that all includes and paths are set. You just need to press the '''Generate''' button
and the project files get generated.


<!--T:175-->
If you switch the '''FREECAD_LIBPACK_USE''' options off, the configuration tries to find
* [https://www.python.org/downloads/ Python 3.x]. A separate python installation is not mandatory since the LibPack contains Python. However, to be able to test later your FreeCAD build it is useful to have a standalone Python installation. It is recommended to use not the latest version, but the prior version (e.g. not Python 3.7 but 3.6).
each and every library needed on your system. Depending on the libs that works well more or
less. So you have to do often define some paths by hand. cMake will show you what is
not found and need to be specified.


<!--T:176-->
==== Options for the Build Process ====
* A GUI frontend for Git. There are several frontends available, see [https://en.wikipedia.org/wiki/Comparison_of_Git_GUIs this list]. The main benefit of a frontend is that you don't have to learn the Git commands to get the source code of FreeCAD or to send patches to the GitHub repository of FreeCAD.
The cMake build system gives us a lot more flexibility over the build process. That means
we can switch on and off some features or modules. It's in a way like the Linux kernel build.
You have a lot switches to determine the build process.


<!--T:177-->
Here is the description of these switches. They will most likely change a lot in the future
In the following we describe source code handling using the frontend [https://tortoisegit.org/ TortoiseGit]. This frontend integrates directly to Windows file explorer and has a large user community to get help in case you have problems.
because we want to increase the build flexibility a lot more.


<!--T:178-->
* [http://sourceforge.net/projects/nsis/ NSIS] This is the program to generate the Windows installer of FreeCAD. (Information: For FreeCAD 0.17 and older the program [http://wixtoolset.org/ WiX] was used to create the installer.)

===Source code=== <!--T:98-->

<!--T:143-->
Now you can get the source code of FreeCAD:

====Using a frontend==== <!--T:144-->

<!--T:145-->
When using the [https://en.wikipedia.org/wiki/Comparison_of_Git_GUIs Git frontend] TortoiseGit:
# Create a new folder where the source code should be.
# Right-click on this folder in the Windows file explorer and select in the context menu '''Git Clone'''.
# A dialog will appear. Use there as URL for the FreeCAD repository

</translate>
''https://github.com/FreeCAD/FreeCAD.git''
<translate>

<!--T:179-->
and click '''OK'''.

<!--T:180-->
Now the source code is downloaded and its folder becomes a folder tracked by Git.

====Using the command line==== <!--T:117-->

<!--T:102-->
To create a local tracking branch and download the source code, open a terminal (command prompt) and switch there to the directory you want the source, then type:

</translate>
{{Code|code=
git clone https://github.com/FreeCAD/FreeCAD.git
}}
<translate>

===Compiler=== <!--T:71-->

<!--T:118-->
The default (recommended) compiler is MS Visual Studio (MSVC). Though it may be possible to use other compilers using Cygwin or MinGW gcc it is not tested or ported so far.

<!--T:146-->
You can get a free version of MSVC (for OpenSource usage) by downloading the ''Community'' edition of MS Visual Studio. To do so, use this URL

<!--T:181-->
<nowiki>https://visualstudio.microsoft.com/thank-you-downloading-visual-studio/?sku=Community&rel=xx</nowiki>

<!--T:182-->
where xx is the version number. So to get MSVC 15 (calso called MSVC 2017), use this URL:

<!--T:183-->
https://visualstudio.microsoft.com/thank-you-downloading-visual-studio/?sku=Community&rel=15

<!--T:106-->
For those who want to avoid installing the huge MSVC for the mere purpose of having a compiler, see [[CompileOnWindows - Reducing Disk Footprint]].

<!--T:147-->
'''Note:''' Despite that the ''Community'' edition of MSVC is free, you must create a Microsoft account from within the MSVC IDE that you can use the IDE for more than 30 days. If you will only compile using the command line, you don't need the IDE and thus no Microsoft account.

<!--T:184-->
As free and OpenSource alternative IDE you can use [https://www.kdevelop.org/download KDevelop]. You can use KDevelop to modify and write C++ code but must use the command line to compile.

===Optional system path configuration=== <!--T:5-->

<!--T:121-->
Optionally you can include the paths to some folders to the system PATH variable. This is helpful if you want to access programs in these folders from the command line/powershell or if you want special programs to be found by the compiler or CMake. Besides this, adding folders to the PATH might be necessary if you did not use the corresponding options when installing the program.

<!--T:148-->
* You can include the folder of your LibPack in your system PATH variable. This is useful if you plan to build multiple configurations/versions of FreeCAD.
* If you did not use the option to add CMake to the PATH while installing it, add its installation folder

<!--T:185-->
''C:\Program Files\CMake\bin'' to the PATH.
* If you did not use the option to add TortoiseGit to the PATH while installing it, add its installation folder

<!--T:186-->
''C:\Program Files\TortoiseGit\bin'' to the PATH.

<!--T:104-->
To add folder paths to the PATH variable:
# In the Windows Start menu Right click on ''Computer'' and choose ''Properties''.
# In the appearing dialog click on ''Advanced system settings''.
# Another dialog will open. Click there in the tab ''Advanced'' on '''Environment Variables'''.
# Again another dialog will open. Select then the variable ''Path'' and click on '''Edit'''.
# And again another dialog will open. Click there on '''New''' and add to path to the folder of Git or the LibPack.
# Finally press '''OK''' and close all dialogs by pressing '''OK''' as well.

== Configuration == <!--T:6-->

===LibPack=== <!--T:149-->

<!--T:150-->
At first you need to setup a build folder:
# Create a new folder where the compiled FreeCAD should be. It is highly recommended that this folder is not inside the source code folder of FreeCAD.
# Create there a new subfolder for the LibPack. '''Note:''' The name of this subfolder must be the same as the LibPack file name. If e.g. the LibPack has the filename ''FreeCADLibs_12.1.2_x64_VC15.7z'', you must name the subfolder ''FreeCADLibs_12.1.2_x64_VC15''.
# Extract the LibPack to this subfolder.

===CMake=== <!--T:151-->

<!--T:123-->
Now you need to configure the build environment using CMake:
# Open the CMake GUI
# Specify there the source folder of FreeCAD
# Specify the build folder you just created in the previous step.
# Click '''Configure'''
# In the appearing dialog specify the generator according to the one you want to use. For the standard MS Visual Studio use ''Visual Studio xx 2yyy'' where xx is the compiler version and 2yyy the year of its release. It is recommended to use the default option ''Use default native compilers''.

<!--T:187-->
'''Note:''' It is important to specify the correct bit variant. If you have the 64bit variant of LibPack you must also use the x64 compiler.

<!--T:76-->
This will begin the configuration and will fail because of missing settings.

<!--T:152-->
If it fails with the message that Visual Studio could not be found the CMake support in MSVC is not yet installed. To do this:
# Open the MSVC IDE
# Use the menu Tools → Get Tools and Features
# In the ''Workloads'' tab enable ''Desktop development with C++''
# On the right side you should now see that the component ''Visual C++ tools for CMake'' will be installed.
# Install it.

<!--T:153-->
If there is no error about Visual Studio, everything is fine, but CMake does not yet know all necessary settings. Therefore now:
# Assure that the search option ''Advanced'' is checked.
# Search in CMake for the variable '''FREECAD_LIBPACK_DIR''' and specify there the correct location to the LibPack folder.
# Search for the variable '''BUILD_QT5''' and enable this option.
# Click '''Configure''' again

<!--T:138-->
There should now be no errors. If so, click on '''Generate'''. After this is done you could close CMake and continue to start the compilation of FreeCAD. However, for the first compilation keep it open for the case that you want or need to change some options for the build process:

=== Options for the build process === <!--T:77-->

<!--T:78-->
The CMake build system gives you the flexibility over the build process. That means you can switch on and off some features or modules by CMake variables.

<!--T:79-->
Here is a description for some of these variables:

<!--T:80-->
{| class="wikitable" style="text-align:left"
{| class="wikitable" style="text-align:left"
|+ Link table
|-
|-
! Variable name !! Description !! Default
! Variable name !! Description !! Default
|-
|-
| BUILD_XXX || Build FreeCAD with the component XXX. If you don't want/need to compile e.g. the workbench ''OpenSCAD'', disable the variable ''BUILD_OPENSCAD''. FreeCAD will then not have this workbench.
| FREECAD_LIBPACK_USE || Switch the usage of the FreeCAD LibPack on or off || On Win32 on, otherwishe off

<!--T:188-->
'''Note:''' Some components are required for other components. If you for example uncheck ''BUILD_ROBOT'' CMake will inform you that then the component ''Path'' cannot be compiled correctly. Therefore check the CMake output after you changed a BUILD_XXX option! || depends
|-
|-
| CMAKE_INSTALL_PREFIX || The output folder when building the target ''INSTALL'', see also section [[#Running and installing FreeCAD|Running and installing FreeCAD]] || Windows' default program installation folder
| FREECAD_LIBPACK_DIR || Directory where the LibPack is || FreeCAD SOURCE dir
|-
|-
| FREECAD_COPY_DEPEND_DIRS_TO_BUILD || Copies the LibPack libraries needed to execute the FreeCAD.exe to the build folder. See also section [[#Running and installing FreeCAD|Running and installing FreeCAD]]. || OFF
| FREECAD_BUILD_GUI || Build FreeCAD with all Gui related modules || ON
|-
|-
| FREECAD_COPY_LIBPACK_BIN_TO_BUILD || Copies the LibPack binaries needed to execute the FreeCAD.exe to the build folder. See also section [[#Running and installing FreeCAD|Running and installing FreeCAD]]. || OFF
| FREECAD_BUILD_CAM || Build the CAM module, experimental! || OFF
|-
|-
| FREECAD_BUILD_INSTALLER || Create the project files for the Windows installer. || OFF
| FREECAD_LIBPACK_USE || Switch the usage of the FreeCAD LibPack on or off || ON
|-
|-
| FREECAD_BUILD_DOXYGEN_DOCU || Create the project files for source code documentation. || OFF
| FREECAD_LIBPACK_DIR || Directory where the LibPack is || FreeCAD's source code folder
|-
|-
| FREECAD_RELEASE_PDB || Create debug libraries also for release builds || ON
| FREECAD_MAINTAINERS_BUILD || Switch on stuff needed only when you do a Release build. || OFF
|}
|}


== Building FreeCAD == <!--T:81-->


<!--T:125-->
Depending on your compiler, the process for building FreeCAD will be slightly different. In the following sections you known workflows are described.
If you are building with Qt Creator, jump to [[#Building with Qt Creator|Building with Qt Creator]], otherwise proceed directly:


</translate>
==== Procedure with cMake and Visual Studio 2008 ====
<div class="mw-collapsible mw-collapsed toccolours">
Once you start cMake GUI, select source folder, add destination folder and click on "Configure". cMake will ask you to select generator - recommended for FreeCAD is "Visual Studio 9 2008".
<translate>


=== Building with Visual Studio 15 2017 === <!--T:154-->
After you click "Next", cMake will throw error since it can not find LibPack. You will need to manually select folder where Libpack is in "FREECAD_LIBPACK_DIR" variable. After that you need to click on "Configure" once more.
After configure is done, click on "Generate". Now you are done with cMake, and you can close it.


</translate>
Before using Visual Studio, we need to add libpack to system path (you need to do this only once, when building first time). You need to go to "Control Panel >> System >> Advanced System Settings". In the "System properties" dialog, under "Advanced" tab there is button "Environment Variables". Click on it.
<div class="mw-collapsible-content">
After you click on it, add libpack to the Path. Separate it from other path variables with ";".
<translate>


<!--T:155-->
Now you need to start Visual Studio 2008. Visual C++ Express 2008 will also work. Before building, it is good procedure to copy bin folder from libpack\bin folder to bin folder of the build files (generated with cMake).
# Start the Visual Studio IDE. This can either be done by pressing the button ''Open Project'' in the CMake GUI or by double-clicking on the file ''FreeCAD.sln'' that you find in your build folder.
# In the toolbar of the MSVC IDE assure that you use for the first compilation ''Release''.
# There is a window called ''Solution'' explorer. it lists all possible compilation targets.


<!--T:189-->
After this go to "File >> Open >> Project/Solution". You need to open FreeCAD_Trunk.sln, from the build files generated with cMake.
To start a full compilation, right-click on the target ''ALL_BUILD'' and then choose '''Build'''.
Once it is opened, there will be three popup menus in the toolbar. One of them says "Debug" - Switch it to "Release".
This will now take quite a long time.
Then execute "Build >> Build Solution" (or just press F7) - this process will last long time.


<!--T:156-->
Once it is done, choose "Debug >> Start without Debugging". Popup window will ask you to select exe file. Click on a popup menu under "Executable File Name" and choose "Browse". You need to go to \bin folder where source files are, and select "FreeCAD.exe"
To compile a ready-to use FreeCAD, compile the target ''INSTALL'', see section [[#Running and installing FreeCAD|Running and installing FreeCAD]].


<!--T:157-->
and you are done!
If you don't get any errors you are done. '''Congratulations!''' You can exit MSVC or keep it open.
</translate>
</div>
</div>
<div class="mw-collapsible mw-collapsed toccolours">
<translate>


=== Building with Visual Studio 12 2013 === <!--T:83-->
==== command line build ====
Here an example how to build FreeCAD from the Command line:


</translate>
rem @echo off
<div class="mw-collapsible-content">
rem Build script, uses vcbuild to completetly build FreeCAD
<translate>
rem update trunc
d:
cd "D:\_Projekte\FreeCAD\FreeCAD_0.9"
"C:\Program Files (x86)\Subversion\bin\svn.exe" update
rem set the aprobiated Variables here or outside in the system
set PATH=C:\WINDOWS\system32;C:\WINDOWS;C:\WINDOWS\System32\Wbem
set INCLUDE=
set LIB=
rem Register VS Build programms
call "C:\Program Files (x86)\Microsoft Visual Studio 9.0\VC\vcvarsall.bat"
rem Set Standard include paths
set INCLUDE=%INCLUDE%;%FrameworkSDKDir%\include
set INCLUDE=%INCLUDE%;C:\Program Files\Microsoft SDKs\Windows\v6.0A\Include
rem Set lib Pathes
set LIB=%LIB%;C:\Program Files\Microsoft SDKs\Windows\v6.0A\Lib
set LIB=%LIB%;%PROGRAMFILES%\Microsoft Visual Studio\VC98\Lib
rem Start the Visuall Studio build process
"C:\Program Files (x86)\Microsoft Visual Studio 9.0\VC\vcpackages\vcbuild.exe" "D:\_Projekte\FreeCAD FreeCAD_0.9_build\FreeCAD_trunk.sln" /useenv


<!--T:112-->
=== Building older versions ===
Make sure to specify '''Visual Studio 12 x64'''(or the alternate C-Compiler you are using) as the generator in CMake before you continue.


<!--T:90-->
==== Using LibPack ====
*Start Visual Studio 12 2013 by clicking on the desktop icon created at installation.
To make it easier to get [[FreeCAD]] compiled, we provide a collection of all
needed libraries. It's called the [[LibPack]]. You can find it on the [http://sourceforge.net/project/showfiles.php?group_id=49159 download page] on
sourceforge.


<!--T:91-->
You need to set the following environment variables:
*Open the project by:
File → Open → Project/Solution


<!--T:92-->
:'''FREECADLIB''' = "D:\Wherever\LIBPACK"
*Open FreeCAD_Trunk.sln from the build folder CMake created


<!--T:93-->
:'''QTDIR''' = "%FREECADLIB%"
*Switch the Solutions Configuration drop down at the top to '''Release''' '''X64'''
This may take a while depending on your sytem


<!--T:94-->
Add "%FREECADLIB%\bin" and "%FREECADLIB%\dll" to the system ''PATH'' variable. Keep in mind that you have to replace "%FREECADLIB%" with the path name, since Windows does not recursively replace environment variables.
*Build → Build Solution


<!--T:95-->
===== Directory setup in Visual Studio =====
*This will take a long time...
Some search path of Visual Studio need to be set.
To change them, use the menu ''Tools→Options→Directory


<!--T:96-->
====== Includes ======
If you don't get any errors you are done. Exit Visual Studio and start FreeCAD by double clicking the FreeCAD icon in the bin folder of the build directory.
Add the following search path to the include path search list:
</translate>
* %FREECADLIB%\include
</div>
* %FREECADLIB%\include\Python
</div>
* %FREECADLIB%\include\boost
<div class="mw-collapsible mw-collapsed toccolours">
* %FREECADLIB%\include\xercesc
<translate>
* %FREECADLIB%\include\OpenCascade
* %FREECADLIB%\include\OpenCV
* %FREECADLIB%\include\Coin
* %FREECADLIB%\include\SoQt
* %FREECADLIB%\include\QT
* %FREECADLIB%\include\QT\Qt3Support
* %FREECADLIB%\include\QT\QtCore
* %FREECADLIB%\include\QT\QtGui
* %FREECADLIB%\include\QT\QtNetwork
* %FREECADLIB%\include\QT\QtOpenGL
* %FREECADLIB%\include\QT\QtSvg
* %FREECADLIB%\include\QT\QtUiTools
* %FREECADLIB%\include\QT\QtXml
* %FREECADLIB%\include\Gts
* %FREECADLIB%\include\zlib


=== Building with Qt Creator === <!--T:88-->
====== Libs ======
Add the following search path to the lib path search list:
* %FREECADLIB%\lib


</translate>
====== Executables ======
<div class="mw-collapsible-content">
Add the following search path to the executable path search list:
<translate>
* %FREECADLIB%\bin
* TortoiseSVN binary installation directory, usually "C:\Programm Files\TortoiseSVN\bin", this is needed for a distribution build when ''SubWVRev.exe'' is used to extract the version number from Subversion.


==== Installation and configuration of Qt Creator ==== <!--T:61-->
===== Python needed =====
During the compilation some Python scripts get executed. So the Python
interpreter has to function on the OS. Use a command box to check it. If
the Python library is not properly installed you will get an error message
like ''Cannot find python.exe''. If you use the LibPack you can also use the
python.exe in the bin directory.


<!--T:126-->
===== Special for VC8 =====
* Download and install [https://www.qt.io/offline-installers Qt Creator]
When building the project with VC8, you have to change the link information for the WildMagic library, since you need a different version for VC6 and VC8. Both versions are supplied in ''LIBPACK/dll''. In the project properties for ''AppMesh'' change the library name for the ''wm.dll'' to the VC8 version. Take care to change it in Debug ''and'' Release configuration.
* Tools → Options → Text Editor → Behavior tab:
** File Encodings → Default Encodings:
** Set to: '''ISO-8859-1 /...csISOLatin1''' (Certain characters create errors/warnings with Qt Creator if left set to UTF-8. This seems to fix it.)
* Tools → Options → Build & Run:
** CMake tab
*** Fill Executable box with path to cmake.exe
** Kits tab
*** Name: MSVC 2008
*** Compiler: Microsoft Visual C++ Compiler 9.0 (x86)
*** Debugger: Auto detected...
*** Qt version: None
** General tab
*** Uncheck: Always build project before deploying it
*** Uncheck: Always deploy project before running it


==== Compile ====
====Import project and building==== <!--T:62-->


<!--T:127-->
After you conform to all prerequisites the compilation is - hopefully - only a mouse click in VC ;-)
* File → Open File or Project
* Open '''CMakeLists.txt''' which is in the top level of the source
* This will start CMake
* Choose build directory and click next
* Set generator to '''NMake Generator (MSVC 2008)'''
* Click Run CMake. Follow the instructions depicted above to configure CMake to your liking.


<!--T:64-->
==== After Compiling ====
Now FreeCAD can be built
To get FreeCAD up and running from the compiler environment you need to copy a few files from the [[LibPack]] to the ''bin'' folder where FreeCAD.exe is installed after a successful build:
* Build → Build All
* This will take a long time...


<!--T:65-->
* ''python.exe'' and ''python_d.exe'' from ''LIBPACK/bin''
Once complete, it can be run:
* ''python25.dll'' and ''python25_d.dll'' from ''LIBPACK/bin''
There are 2 green triangles at the bottom left. One is debug.
* ''python25.zip'' from ''LIBPACK/bin''
The other is run. Pick whichever you want.
* make a copy of ''Python25.zip'' and rename it to ''Python25_d.zip''
</translate>
* ''QtCore4.dll'' from ''LIBPACK/bin''
</div>
* ''QtGui4.dll'' from ''LIBPACK/bin''
</div>
* ''boost_signals-vc80-mt-1_34_1.dll'' from ''LIBPACK/bin''
<div class="mw-collapsible mw-collapsed toccolours">
* ''boost_program_options-vc80-mt-1_34_1.dll'' from ''LIBPACK/bin''
<translate>
* ''xerces-c_2_8.dll'' from ''LIBPACK/bin''
* ''zlib1.dll'' from ''LIBPACK/bin''
* ''coin2.dll'' from ''LIBPACK/bin''
* ''soqt1.dll'' from ''LIBPACK/bin''
* ''QtOpenGL4.dll'' from ''LIBPACK/bin''
* ''QtNetwork4.dll'' from ''LIBPACK/bin''
* ''QtSvg4.dll'' from ''LIBPACK/bin''
* ''QtXml4.dll'' from ''LIBPACK/bin''


===Command line build=== <!--T:66-->
When using a [[LibPack]] with a Python version older than 2.5 you have to copy two further files:
* ''zlib.pyd'' and ''zlib_d.pyd'' from ''LIBPACK/bin/lib''. This is needed by python to open the zipped python library.
* ''_sre.pyd'' and ''_sre_d.pyd'' from ''LIBPACK/bin/lib''. This is needed by python for the built in help system.


</translate>
If you don't get it running due to a Python error it is very likely that one of the ''zlib*.pyd'' files is missing.
<div class="mw-collapsible-content">
<translate>


<!--T:158-->
==== Additional stuff ====
The steps how to compile from the command line depends on the compiler. For MSVC 2017 the steps are:
# In Windows' start menu go to {{MenuCommand|Visual Studio 2017 → Visual Studio Tools}} and choose '''Developer Command Prompt for VS 2017'''
# Change to your build folder.
# Execute the command


</translate>
If you whant to build the source code documentation you need [http://www.stack.nl/~dimitri/doxygen/ DoxyGen].
{{Code|code=msbuild ALL_BUILD.vcxproj /p:Configuration=Release}}
<translate>


<!--T:190-->
To create an intstaller package you need [http://wix.sourceforge.net/ WIX].
or


</translate>
{{Code|code=msbuild INSTALL.vcxproj /p:Configuration=Release}}
<translate>


<!--T:114-->
During the compilation some Python scripts get executed. So the Python interpreter has to work properly.
These steps can also be automaized. Here is for example a solution for MSVC 2017:
# Download the script [https://forum.freecadweb.org/download/file.php?id=92135 compile-FC.txt].
# Rename it to ''compile-FC.bat''
# In Winddows' file explorer Shift+Right-click on your build folder and use from the context menu ''Command prompt here''.
# Execute the command


</translate>
For more details have also a look to ''README.Linux'' in your sources.
{{Code|code=compile-FC install}}
<translate>


<!--T:191-->
First of all you should build the Qt plugin that provides all custom widgets of FreeCAD we need for the Qt Designer. The sources are located under
Instead of calling '''compile-FC''' with the option ''install'' you can also use ''debug'' or ''release'':
//src/Tools/plugins/widget//.
So far we don't provide a makefile -- but calling
qmake plugin.pro
creates it. Once that's done, calling ''make'' will create the library
//libFreeCAD_widgets.so//.
To make this library known to your ''Qt Designer'' you have to copy the file to
//$QTDIR/plugin/designer//.


<!--T:192-->
{{docnav|Tracker|CompileOnUnix}}
''debug'' &nbsp; - compile FreeCAD in debug configuration


<!--T:193-->
{{languages | {{es|CompileOnWindows/es}} {{fr|CompileOnWindows/fr}} {{jp|CompileOnWindows/jp}} {{se|CompileOnWindows/se}} }}
''release'' - compile FreeCAD in release configuration


<!--T:194-->
''install'' &nbsp;&nbsp; - compile FreeCAD in release configuration and create an install setup

</translate>
</div>
</div>
<translate>

==Running and installing FreeCAD== <!--T:139-->

<!--T:140-->
There are 2 methods to run the compiled FreeCAD:

<!--T:195-->
''Method 1'': You execute the FreeCAD.exe that you find in your build folder in the subfolder ''bin''

<!--T:196-->
''Method 2'': You build the target ''INSTALL''

<!--T:141-->
Method 2 is the simpler one because it automatically assures that all libraries needed to run the FreeCAD.exe are in the correct folder. The FreeCAD.exe and the libraries will be output in the folder you specified in the CMake variable ''CMAKE_INSTALL_PREFIX''.

<!--T:142-->
For Method 1 you need to put the libraries into the ''bin'' folder of your build folder (where the FreeCAD.exe is). This can easily be done:
# Open the CMake GUI.
# Search there for the variable option ''FREECAD_COPY_DEPEND_DIRS_TO_BUILD'' and check it.
# Search there for the variable option ''FREECAD_COPY_LIBPACK_BIN_TO_BUILD'' and check it.
# Click on '''Configure'''. At the end of the configuration CMake will automatically copy the necessary libraries from the LibPack folder.

<!--T:159-->
For FreeCAD 0.19 there is currently only one issue that requires manual action:
# Download the file [https://forum.freecadweb.org/download/file.php?id=90273 qwindowsvistastyle.zip] from the FreeCAD forum.
# Create a new subfolder named ''styles'' in the ''bin'' folder (where the FreeCAD.exe is).
# Extract the ZIP-file to this folder.

<!--T:197-->
This adds the necessary style to make FreeCAD look like a normal Win 10 program. Otherwise it looks like in Windows 98.

==Updating the build== <!--T:160-->

<!--T:161-->
FreeCAD is very actively developed. Therefore its source code changes almost daily. New features are added and bugs are fixed. To benefit from these source code changes, you must rebuild your FreeCAD. This is done in two steps:
# Updating the source code
# Recompilation

===Updating the source code=== <!--T:162-->

====Using a frontend==== <!--T:163-->

<!--T:164-->
When using the [https://en.wikipedia.org/wiki/Comparison_of_Git_GUIs Git frontend] TortoiseGit:
# Right-click on your FreeCAD source code folder in the Windows file explorer and select in the context menu '''Pull'''.
# A dialog will appear. Select there what development branch you want to get. '''master''' is the main branch. Therefore use this unless you want to compile a special new feature from a branch that has not yet been merged to ''master''. (For more about Git branches, see [[Source_code_management#Git_development_process|Git development process]].)

<!--T:198-->
Finally click '''OK'''.

====Using the command line==== <!--T:165-->

<!--T:166-->
Open a terminal (command prompt) and switch there to your source directory. Then type:

</translate>
{{Code|code=
git pull https://github.com/FreeCAD/FreeCAD.git master
}}
<translate>

<!--T:167-->
where ''master'' the the name of the main development branch. If you want to get code from another branch, use its name instead of ''master''.

===Recompilation=== <!--T:168-->

<!--T:169-->
# Open the MSVC IDE by double-clicking either on the file ''FreeCAD.sln'' or on the file ''ALL_BUILD.vcxproj'' in your build folder.
# Continue with step 2 from section [[#Building_with_Visual_Studio_15_2017|Building with Visual Studio 15 2017]].

== References == <!--T:115-->

<!--T:74-->
See also
* [[Compile_on_Windows_with_VS2013|Compile on Windows with Visual Studio 2013]]
* [[Compiling_(Speeding_up)|Compiling - Speeding up]]

<!--T:69-->
{{docnav
|[[Tracker|Tracker]]
|[[Compile_on_Linux/Unix|Compile on Linux/Unix]]
}}

<!--T:110-->
{{Userdocnavi}}

<!--T:111-->
[[Category:Developer Documentation]]
[[Category:Developer Documentation]]

</translate>
{{clear}}

Revision as of 03:34, 26 January 2020

This page explains step by step how to compile FreeCAD 0.18 or newer on Windows.

Prerequisites

At first you must install the following required programs ad libraries:

Required

  • Git (There are also a GUI frontends available for Git, see the next section.)
  • CMake version 3.11.x - 3.15.x. Note: Usually one cannot take the latest CMake version. Therefore only use a CMake version in the range specified on this page!

It is recommended to use the option Add CMake to the system PATH for all users when installing CMake. Then you can later easily access CMake also from the command line/powershell.

  • LibPack (also called FreeCADLibs). This is a set of libraries necessary to compile FreeCAD on Windows. Depending on the FreeCAD version you want to compile, you must download the corresponding LibPack. For example to compile FreeCAD 0.18, download either the 32bit or the 64bit version of the LibPack for 0.18, to compile the latest development version 0.19, download the LibPack for 0.19 (there is only a 64bit version).

Just download the LibPack, you will unpack and set it up later.

Note: It is recommended to use the same compiler MS Visual Studio (MSVC) version the LibPack is designed for. This assures that the compilation and the execution of the compiled FreeCAD.exe succeeds. So you should for example be able to compile FreeCAD 0.18 using the LibPack for 0.19 and MSVC 15 but you you might get problems compiling FreeCAD 0.18 using the LibPack for 0.18 and MSVC 15 because the LibPack for 0.18 is designed to be built with MSVC 12.

Optional programs

  • Python 3.x. A separate python installation is not mandatory since the LibPack contains Python. However, to be able to test later your FreeCAD build it is useful to have a standalone Python installation. It is recommended to use not the latest version, but the prior version (e.g. not Python 3.7 but 3.6).
  • A GUI frontend for Git. There are several frontends available, see this list. The main benefit of a frontend is that you don't have to learn the Git commands to get the source code of FreeCAD or to send patches to the GitHub repository of FreeCAD.

In the following we describe source code handling using the frontend TortoiseGit. This frontend integrates directly to Windows file explorer and has a large user community to get help in case you have problems.

  • NSIS This is the program to generate the Windows installer of FreeCAD. (Information: For FreeCAD 0.17 and older the program WiX was used to create the installer.)

Source code

Now you can get the source code of FreeCAD:

Using a frontend

When using the Git frontend TortoiseGit:

  1. Create a new folder where the source code should be.
  2. Right-click on this folder in the Windows file explorer and select in the context menu Git Clone.
  3. A dialog will appear. Use there as URL for the FreeCAD repository

https://github.com/FreeCAD/FreeCAD.git

and click OK.

Now the source code is downloaded and its folder becomes a folder tracked by Git.

Using the command line

To create a local tracking branch and download the source code, open a terminal (command prompt) and switch there to the directory you want the source, then type:

git clone https://github.com/FreeCAD/FreeCAD.git

Compiler

The default (recommended) compiler is MS Visual Studio (MSVC). Though it may be possible to use other compilers using Cygwin or MinGW gcc it is not tested or ported so far.

You can get a free version of MSVC (for OpenSource usage) by downloading the Community edition of MS Visual Studio. To do so, use this URL

https://visualstudio.microsoft.com/thank-you-downloading-visual-studio/?sku=Community&rel=xx

where xx is the version number. So to get MSVC 15 (calso called MSVC 2017), use this URL:

https://visualstudio.microsoft.com/thank-you-downloading-visual-studio/?sku=Community&rel=15

For those who want to avoid installing the huge MSVC for the mere purpose of having a compiler, see CompileOnWindows - Reducing Disk Footprint.

Note: Despite that the Community edition of MSVC is free, you must create a Microsoft account from within the MSVC IDE that you can use the IDE for more than 30 days. If you will only compile using the command line, you don't need the IDE and thus no Microsoft account.

As free and OpenSource alternative IDE you can use KDevelop. You can use KDevelop to modify and write C++ code but must use the command line to compile.

Optional system path configuration

Optionally you can include the paths to some folders to the system PATH variable. This is helpful if you want to access programs in these folders from the command line/powershell or if you want special programs to be found by the compiler or CMake. Besides this, adding folders to the PATH might be necessary if you did not use the corresponding options when installing the program.

  • You can include the folder of your LibPack in your system PATH variable. This is useful if you plan to build multiple configurations/versions of FreeCAD.
  • If you did not use the option to add CMake to the PATH while installing it, add its installation folder

C:\Program Files\CMake\bin to the PATH.

  • If you did not use the option to add TortoiseGit to the PATH while installing it, add its installation folder

C:\Program Files\TortoiseGit\bin to the PATH.

To add folder paths to the PATH variable:

  1. In the Windows Start menu Right click on Computer and choose Properties.
  2. In the appearing dialog click on Advanced system settings.
  3. Another dialog will open. Click there in the tab Advanced on Environment Variables.
  4. Again another dialog will open. Select then the variable Path and click on Edit.
  5. And again another dialog will open. Click there on New and add to path to the folder of Git or the LibPack.
  6. Finally press OK and close all dialogs by pressing OK as well.

Configuration

LibPack

At first you need to setup a build folder:

  1. Create a new folder where the compiled FreeCAD should be. It is highly recommended that this folder is not inside the source code folder of FreeCAD.
  2. Create there a new subfolder for the LibPack. Note: The name of this subfolder must be the same as the LibPack file name. If e.g. the LibPack has the filename FreeCADLibs_12.1.2_x64_VC15.7z, you must name the subfolder FreeCADLibs_12.1.2_x64_VC15.
  3. Extract the LibPack to this subfolder.

CMake

Now you need to configure the build environment using CMake:

  1. Open the CMake GUI
  2. Specify there the source folder of FreeCAD
  3. Specify the build folder you just created in the previous step.
  4. Click Configure
  5. In the appearing dialog specify the generator according to the one you want to use. For the standard MS Visual Studio use Visual Studio xx 2yyy where xx is the compiler version and 2yyy the year of its release. It is recommended to use the default option Use default native compilers.

Note: It is important to specify the correct bit variant. If you have the 64bit variant of LibPack you must also use the x64 compiler.

This will begin the configuration and will fail because of missing settings.

If it fails with the message that Visual Studio could not be found the CMake support in MSVC is not yet installed. To do this:

  1. Open the MSVC IDE
  2. Use the menu Tools → Get Tools and Features
  3. In the Workloads tab enable Desktop development with C++
  4. On the right side you should now see that the component Visual C++ tools for CMake will be installed.
  5. Install it.

If there is no error about Visual Studio, everything is fine, but CMake does not yet know all necessary settings. Therefore now:

  1. Assure that the search option Advanced is checked.
  2. Search in CMake for the variable FREECAD_LIBPACK_DIR and specify there the correct location to the LibPack folder.
  3. Search for the variable BUILD_QT5 and enable this option.
  4. Click Configure again

There should now be no errors. If so, click on Generate. After this is done you could close CMake and continue to start the compilation of FreeCAD. However, for the first compilation keep it open for the case that you want or need to change some options for the build process:

Options for the build process

The CMake build system gives you the flexibility over the build process. That means you can switch on and off some features or modules by CMake variables.

Here is a description for some of these variables:

Variable name Description Default
BUILD_XXX Build FreeCAD with the component XXX. If you don't want/need to compile e.g. the workbench OpenSCAD, disable the variable BUILD_OPENSCAD. FreeCAD will then not have this workbench.

Note: Some components are required for other components. If you for example uncheck BUILD_ROBOT CMake will inform you that then the component Path cannot be compiled correctly. Therefore check the CMake output after you changed a BUILD_XXX option! || depends

CMAKE_INSTALL_PREFIX The output folder when building the target INSTALL, see also section Running and installing FreeCAD Windows' default program installation folder
FREECAD_COPY_DEPEND_DIRS_TO_BUILD Copies the LibPack libraries needed to execute the FreeCAD.exe to the build folder. See also section Running and installing FreeCAD. OFF
FREECAD_COPY_LIBPACK_BIN_TO_BUILD Copies the LibPack binaries needed to execute the FreeCAD.exe to the build folder. See also section Running and installing FreeCAD. OFF
FREECAD_LIBPACK_USE Switch the usage of the FreeCAD LibPack on or off ON
FREECAD_LIBPACK_DIR Directory where the LibPack is FreeCAD's source code folder
FREECAD_RELEASE_PDB Create debug libraries also for release builds ON

Building FreeCAD

Depending on your compiler, the process for building FreeCAD will be slightly different. In the following sections you known workflows are described. If you are building with Qt Creator, jump to Building with Qt Creator, otherwise proceed directly:

Building with Visual Studio 15 2017

  1. Start the Visual Studio IDE. This can either be done by pressing the button Open Project in the CMake GUI or by double-clicking on the file FreeCAD.sln that you find in your build folder.
  2. In the toolbar of the MSVC IDE assure that you use for the first compilation Release.
  3. There is a window called Solution explorer. it lists all possible compilation targets.

To start a full compilation, right-click on the target ALL_BUILD and then choose Build. This will now take quite a long time.

To compile a ready-to use FreeCAD, compile the target INSTALL, see section Running and installing FreeCAD.

If you don't get any errors you are done. Congratulations! You can exit MSVC or keep it open.

Building with Visual Studio 12 2013

Make sure to specify Visual Studio 12 x64(or the alternate C-Compiler you are using) as the generator in CMake before you continue.

  • Start Visual Studio 12 2013 by clicking on the desktop icon created at installation.
  • Open the project by:

File → Open → Project/Solution

  • Open FreeCAD_Trunk.sln from the build folder CMake created
  • Switch the Solutions Configuration drop down at the top to Release X64

This may take a while depending on your sytem

  • Build → Build Solution
  • This will take a long time...

If you don't get any errors you are done. Exit Visual Studio and start FreeCAD by double clicking the FreeCAD icon in the bin folder of the build directory.

Building with Qt Creator

Installation and configuration of Qt Creator

  • Download and install Qt Creator
  • Tools → Options → Text Editor → Behavior tab:
    • File Encodings → Default Encodings:
    • Set to: ISO-8859-1 /...csISOLatin1 (Certain characters create errors/warnings with Qt Creator if left set to UTF-8. This seems to fix it.)
  • Tools → Options → Build & Run:
    • CMake tab
      • Fill Executable box with path to cmake.exe
    • Kits tab
      • Name: MSVC 2008
      • Compiler: Microsoft Visual C++ Compiler 9.0 (x86)
      • Debugger: Auto detected...
      • Qt version: None
    • General tab
      • Uncheck: Always build project before deploying it
      • Uncheck: Always deploy project before running it

Import project and building

  • File → Open File or Project
  • Open CMakeLists.txt which is in the top level of the source
  • This will start CMake
  • Choose build directory and click next
  • Set generator to NMake Generator (MSVC 2008)
  • Click Run CMake. Follow the instructions depicted above to configure CMake to your liking.

Now FreeCAD can be built

  • Build → Build All
  • This will take a long time...

Once complete, it can be run: There are 2 green triangles at the bottom left. One is debug. The other is run. Pick whichever you want.

Command line build

The steps how to compile from the command line depends on the compiler. For MSVC 2017 the steps are:

  1. In Windows' start menu go to Visual Studio 2017 → Visual Studio Tools and choose Developer Command Prompt for VS 2017
  2. Change to your build folder.
  3. Execute the command
msbuild ALL_BUILD.vcxproj /p:Configuration=Release

or

msbuild INSTALL.vcxproj /p:Configuration=Release

These steps can also be automaized. Here is for example a solution for MSVC 2017:

  1. Download the script compile-FC.txt.
  2. Rename it to compile-FC.bat
  3. In Winddows' file explorer Shift+Right-click on your build folder and use from the context menu Command prompt here.
  4. Execute the command
compile-FC install

Instead of calling compile-FC with the option install you can also use debug or release:

debug   - compile FreeCAD in debug configuration

release - compile FreeCAD in release configuration

install    - compile FreeCAD in release configuration and create an install setup

Running and installing FreeCAD

There are 2 methods to run the compiled FreeCAD:

Method 1: You execute the FreeCAD.exe that you find in your build folder in the subfolder bin

Method 2: You build the target INSTALL

Method 2 is the simpler one because it automatically assures that all libraries needed to run the FreeCAD.exe are in the correct folder. The FreeCAD.exe and the libraries will be output in the folder you specified in the CMake variable CMAKE_INSTALL_PREFIX.

For Method 1 you need to put the libraries into the bin folder of your build folder (where the FreeCAD.exe is). This can easily be done:

  1. Open the CMake GUI.
  2. Search there for the variable option FREECAD_COPY_DEPEND_DIRS_TO_BUILD and check it.
  3. Search there for the variable option FREECAD_COPY_LIBPACK_BIN_TO_BUILD and check it.
  4. Click on Configure. At the end of the configuration CMake will automatically copy the necessary libraries from the LibPack folder.

For FreeCAD 0.19 there is currently only one issue that requires manual action:

  1. Download the file qwindowsvistastyle.zip from the FreeCAD forum.
  2. Create a new subfolder named styles in the bin folder (where the FreeCAD.exe is).
  3. Extract the ZIP-file to this folder.

This adds the necessary style to make FreeCAD look like a normal Win 10 program. Otherwise it looks like in Windows 98.

Updating the build

FreeCAD is very actively developed. Therefore its source code changes almost daily. New features are added and bugs are fixed. To benefit from these source code changes, you must rebuild your FreeCAD. This is done in two steps:

  1. Updating the source code
  2. Recompilation

Updating the source code

Using a frontend

When using the Git frontend TortoiseGit:

  1. Right-click on your FreeCAD source code folder in the Windows file explorer and select in the context menu Pull.
  2. A dialog will appear. Select there what development branch you want to get. master is the main branch. Therefore use this unless you want to compile a special new feature from a branch that has not yet been merged to master. (For more about Git branches, see Git development process.)

Finally click OK.

Using the command line

Open a terminal (command prompt) and switch there to your source directory. Then type:

git pull https://github.com/FreeCAD/FreeCAD.git master

where master the the name of the main development branch. If you want to get code from another branch, use its name instead of master.

Recompilation

  1. Open the MSVC IDE by double-clicking either on the file FreeCAD.sln or on the file ALL_BUILD.vcxproj in your build folder.
  2. Continue with step 2 from section Building with Visual Studio 15 2017.

References

See also