Difference between revisions of "User:Legoboyvdlp/Building using CMake - Windows"

From FlightGear wiki
Jump to: navigation, search
(Required software: More details on getting QT.)
(Scripted Compilation)
 
(41 intermediate revisions by the same user not shown)
Line 17: Line 17:
 
The commands to run are:
 
The commands to run are:
  
{{code|git clone https://git.code.sf.net/p/flightgear/simgear simgear-git}}
+
{{code|git clone https://git.code.sf.net/p/flightgear/simgear simgear}}
  
{{code|git clone https://git.code.sf.net/p/flightgear/flightgear flightgear-git}}
+
{{code|git clone https://git.code.sf.net/p/flightgear/flightgear flightgear}}
  
{{code|git clone https://git.code.sf.net/p/flightgear/fgdata data}}
+
{{code|git clone https://git.code.sf.net/p/flightgear/fgdata fgdata}}
  
I would encourage people to access third party dependencies and OSG from Jenkins: you can build them if you wish, but it really is not needed. There is no advantage to doing that -- it only takes longer.
+
{{code|git clone https://git.code.sf.net/p/flightgear/windows-3rd-party windows-3rd-party}}
  
[http://build.flightgear.org:8080/job/3rdParty-Win/lastSuccessfulBuild/artifact/3rdParty.x64/*zip*/3rdParty.x64.zip prebuilt dependencies for 64 bit Windows (.zip)]
+
{{code|git clone -b fgfs-342-1 https://github.com/zakalawe/osg.git osg}}
  
[http://build.flightgear.org:8080/job/3rdParty-Win/lastSuccessfulBuild/artifact/boost/*zip*/boost.zip prebuilt Boost library (.zip)]
 
 
OSG is so unreliable at building and linking properly that I would very strongly recommend you to use the pre-built version: download this folder, and copy the <tt>archive/install/msvc140-64/OpenSceneGraph</tt> folder into the directory structure shown below.
 
 
[http://build.flightgear.org:8080/job/OSG-Win/lastSuccessfulBuild/artifact/*zip*/archive.zip prebuilt OSG for Windows x64]
 
  
 
After downloading these, I would suggest assembling a folder structure as below:
 
After downloading these, I would suggest assembling a folder structure as below:
  
== Directory tree ==
+
== Directory Tree ==
On Windows, assumptions on the directory structure are made to automate the discovery of dependencies. This recommended directory structure is described below. Clicking the links allows you to download pre-built parts. If you do not use the recommended structure you will need to enter paths by hand. Source and build directories can be located anywhere, but this structure will work well.
+
On Windows, assumptions on the directory structure are made to automate the discovery of dependencies. This recommended directory structure is described below. Clicking the links allows you to download pre-built parts. If you do not use the recommended structure you will need to enter paths by hand and some parts may not input correctly.
  
 
<tt>
 
<tt>
: Dependencies / </tt> (Set <tt>${MSVC_3RDPARTY_ROOT}</tt> to this directory) <tt>
+
: FlightGearBuild / </tt> (Main root directory) <tt>
:: 3rdParty.x64 / </tt> (link above) <tt>
+
:: fgdata / </tt> (FlightGear data files) <tt>
::: bin /
+
:: flightgear / </tt> (FlightGear sources) <tt>
::: include /
+
:: install / </tt> (Directory where you will install the built binaries to)
::: lib /
+
::: launch.bat / </tt> (launch script if desired, see below)
:: Boost / </tt> (link above) <tt>
+
:: osg / </tt> (OSG sources) <tt>
::: {boost libs} /
+
:: simgear / </tt> (SimGear sources) <tt>
:: install /
+
:: windows-3rd-party-deps /
::: msvc140-64 / </tt> (i.e. MSVC version 14.0 or later for 64 bit) <tt>
+
:: build.bat / </tt> (build script, see below)
:::: OpenSceneGraph / </tt> (link above) <tt>
+
:: update.bat / </tt> (update script, see below)
::::: bin /
+
::::: include /
+
::::: lib /
+
: Source /
+
:: flightgear-git / </tt> (FlightGear sources, link above) <tt>
+
:: simgear-git / </tt> (Simgear sources, link above) <tt>
+
: BuildDirs /
+
:: flightgear-build / </tt> (Create empty) <tt>
+
:: simgear-build /</tt> (Create empty) <tt>
+
: install /
+
:: SimGear / </tt> (create this empty for now, subfolders will be created by build process) <tt>
+
:: FlightGear /
+
::: data / (FGDATA, link above. Bin / lib folder will be created by the build process) </tt>
+
  
 
== Building ==
 
== Building ==
 +
=== Scripted Compilation ===
 +
This script will allow you to build OpenSceneGraph, SimGear and FlightGear automatically.
 +
 +
{{collapsible script
 +
| type  = Windows batch file
 +
| title  = The <code>build.bat</code> script for configuring and compiling OSG, SG, and FG
 +
| lang  = batch
 +
| script =
 +
SET PATH=%PATH%;%ProgramFiles%\CMake\bin
 +
SET QT5SDK64=C:\Qt\5.15.0\msvc2019_64
 +
SET CMAKE_TOOLCHAIN="Visual Studio 16 2019"
 +
SET ROOT_DIR=C:\path\to\FlightGearBuild
  
=== GUI compilation ===
+
md osg-build
# Set up a work directory as described above or to your own personal preference.
+
md simgear-build
# Having downloaded the sources into the Source directory, and all the prebuilt dependencies, continue below:
+
md flightgear-build
# '''Building SimGear'''
+
## Open the CMake gui.
+
## Set <tt>"Where is the source code"</tt> to the Source/simgear-git directory.
+
## Set <tt>"Where to build the binaries"</tt> to the empty directory <tt>simgear-build</tt> in the BuildDirs directory.
+
## Press [[File:CMake GUI Configure.png]]. The first time that the project is configured, CMake will bring up a window asking you to "Specify the generator for this project" i.e. which compiler you wish to use. Select Visual Studio 16 2019 (or the respective version for your own copy of Visual Studio), and press Finish. CMake will now do a check on your system and will produce a preliminary build configuration. [[File:BuildCompilerSelection.png|thumb|Shows how to select compiler]]
+
## CMake adds new configuration variables in red. Some have a value ending with <tt>-NOTFOUND</tt>. These variables do not necessarily need a value. Some errors will prevent SimGear from building and others will simply invalidate some options without causing build errors and thus can be ignored.
+
### First check the <tt>MSVC_3RDPARTY_ROOT</tt> variable. If it is not set, chances are that there will be a lot of <tt>-NOTFOUND</tt> errors. Instead of trying to fix every error individually, set that variable to the location of the <tt>\Dependencies</tt> folder in the directory structure that is presented above. Then press [[File:CMake GUI Configure.png]] again. [[File:BuildMSVC 3DPartyRoot.png|thumb|Demonstrates how to set 3d party root in CMAKE gui]]
+
### Set the  <tt>CMAKE_INSTALL_PREFIX</tt> variable to <tt>\install\Simgear</tt>
+
### Set the <tt>Boost_INCLUDE_DIR</tt> variable to <tt>\Dependencies</tt>
+
### To pick up Boost correctly, you must add a new Cache entry, using [[File:CMake GUI AddButton.png]] with name <tt>BOOST_ROOT</tt>, type <tt>PATH</tt>, and value <tt>\Dependencies</tt>. It is '''not''' required to set Boost_DIR to any value.[[File:BuildSettingBoost.png|thumb|Demonstrates how to add Boost in CMAKE GUI]]
+
### Create a second cache entry, called <tt>CMAKE_PREFIX_PATH</tt>, type <tt>PATH</tt> and value <tt>\Dependencies\install\msvc140-64\OpenSceneGraph</tt>. This will allow OSG to be picked up automatically.
+
### Also verify the lines with a checkbox. These are build options and may impact the feature set of the built program.
+
### Default options, for anything else, should more or less be suitable. One exception is to ensure OSG_FSTREAM_EXPORT_FIXED is set to true for faster linking.
+
## Repeat the process from step 5, until [[File:CMake GUI Generate.png]] is enabled.
+
## Press [[File:CMake GUI Generate.png]].
+
## Press [[File:CMake GUI OpenProject.png]].
+
## Choose the <tt>"RelWithDebInfo"</tt> build in the toolbar. The right menu should read x64 for 64-bits. [[File:MVSC 2019 solution.PNG|right]]
+
## Generate the solution with F7 key or right-click the top level "Solution SimGear" in the Solution Explorer and choose Build. It should take ~20 minutes on average hardware.
+
## If there are build errors, return to CMake, clear remaining errors, [[File:CMake GUI Configure.png]] and [[File:CMake GUI Generate.png]].
+
## When Visual Studio is able to build everything without errors, right-click on the <tt>INSTALL</tt> project (further down within the "Solution Simgear" solution) and choose Build, which will put the include and lib files in <tt>${CMAKE_INSTALL_PREFIX}</tt>. This should only take a few seconds as you have already compiled everything. [[File:BuildInstallProjectMSVC.png|thumb|Demonstrates building INSTALL project in MSVC]]
+
# '''Building FlightGear'''
+
#: Repeat the steps under Building Simgear, but change the <tt>SimGear</tt> paths to <tt>FlightGear</tt>.
+
## Set CMAKE_INSTALL_PREFIX to <tt>\install\FlightGear</tt>
+
## Link Simgear to FlightGear using <tt>Simgear_DIR</tt>, pointing to <tt>\install\Simgear\lib\cmake\SimGear</tt> [[File:BuildSimgear DIR.png|thumb|Demonstrates how to link Simgear to FlightGear]]
+
## Notably, you will have to link QT5 to CMAKE_PREFIX_PATH ''in addition to'' OSG (as with Simgear). To do this, insert the directory values with a semi-colon to separate them. for instance <tt>QT5PATH;OSGPATH</tt>.
+
### QT5: <tt>C:/Qt/5.15.0/msvc2019_64</tt> (adjust to match your QT installation).
+
### My personal final path was: <tt>C:/Users/redpa/Documents/FlightGear/fg-from-scratch/fresh-build/Dependencies/install/msvc140 64/OpenSceneGraph;C:/Qt/5.15.0/msvc2019_64</tt>
+
# '''Post-compilation steps:'''
+
## Install QT5 using WinDeployQT: this program is contained within the QT installation. For me, I found it inside <tt>C:\Qt\5.15.0\msvc2019_64\bin</tt>. Run it in a cmd window, with the console options as required. This pulls in all the necessary QT files.
+
## Install .dlls:
+
### either manually copy in to the <tt>install/FlightGear/bin/</tt> folder
+
### or, preferrably, add the directories containing them to %PATH% environment variable.
+
#### Dependencies\3rdParty.x64\bin
+
#### Dependencies\install\msvc140-64\OpenSceneGraph\bin
+
## Enjoy!
+
  
=== Updating ===
+
cd %ROOT_DIR%\osg-build
When updating the source from [[git]], it is usually unnecessary to restart CMake as the solution is able to reconfigure itself when CMake files are changed. Simply rebuild the solution from Visual Studio and accept the reload of updated projects. When the Simgear/FlightGear version numbers change, you do have to re-configure in CMake.
+
  
To change build options or directory path, it is mandatory to use the CMake Gui. In case of problems, locate the <tt>CMakeCache.txt</tt> file in <tt>"Where to build the binaries”</tt> directory and delete it to reconfigure from scratch or use the menu item <tt>File > Delete Cache</tt>.
+
cmake  %ROOT_DIR%\osg -G  %CMAKE_TOOLCHAIN% -A x64 ^
 +
                -DACTUAL_3RDPARTY_DIR=%ROOT_DIR%\windows-3rd-party/msvc140/3rdParty.x64 ^
 +
                -DCMAKE_RELWITHDEBINFO_POSTFIX:STRING= ^
 +
                -DOSG_USE_UTF8_FILENAME:BOOL=ON ^
 +
                -DWIN32_USE_MP:BOOL=ON ^
 +
                -DCMAKE_INSTALL_PREFIX:PATH=%ROOT_DIR%\install
 +
cmake --build . --config RelWithDebInfo --target INSTALL
 +
 
 +
cd %ROOT_DIR%\simgear-build
 +
cmake  %ROOT_DIR%\simgear -G  %CMAKE_TOOLCHAIN% -A x64 ^
 +
                -DOSG_FSTREAM_EXPORT_FIXED:BOOL=ON ^
 +
                -DCMAKE_INSTALL_PREFIX:PATH=%ROOT_DIR%\install
 +
cmake --build . --config RelWithDebInfo --target INSTALL
 +
 
 +
cd %ROOT_DIR%\flightgear-build
 +
cmake  %ROOT_DIR%\flightgear -G  %CMAKE_TOOLCHAIN% -A x64 ^
 +
                  -DCMAKE_INSTALL_PREFIX:PATH=%ROOT_DIR%\install ^
 +
                  -DCMAKE_PREFIX_PATH=%QT5SDK64% ^
 +
                  -DOSG_FSTREAM_EXPORT_FIXED:BOOL=ON ^
 +
                  -DENABLE_COMPOSITOR:BOOL=OFF
 +
                   
 +
cmake --build . --config RelWithDebInfo --target INSTALL
 +
 
 +
pause
 +
| show  = 1
 +
}}
 +
 
 +
Before starting to use the script, you need to edit the top few lines of the script. You will have to:
 +
 
 +
1. Set the path to your CMake installation.
 +
 
 +
2. Ensure that the path to your QT SDK is correct for your version of MSVC.
 +
 
 +
3. Ensure your toolchain version matches, e.g. "Visual Studio 16 2019" for MSVC 2019 or "Visual Studio 15 2017" for MSVC 2017.
 +
 
 +
4. Set ROOT_DIR to the FlightgearBuild folder you created (the above directory structure)
 +
 
 +
==== Post-compilation: Launching FlightGear ====
 +
'''In the debugger:'''
 +
Open flightgear-build/FlightGear.sln. You can then perform all your development / debugging directly in VS. You normally only need to run build.bat again, if you update SimGear or OSG.
 +
 
 +
To launch FlightGear from Visual Studio, you can follow the following steps:
 +
The first time only:
 +
# Make sure you set your build type to RelWithDebInfo in the top bar.
 +
# To start with the launcher, click on the small black arrow beside Local Windows Debugger to open 'fgfs debug properties'. Switch to debugging; add {{code|--launcher}} to the 'Command Arguments'. Click Apply and then OK.
 +
# Press the green arrow (Local Windows Debugger) to start up FlightGear.
 +
# The first time you'll have to choose where FGDATA is -- to do this, select the 'fgdata' directory you cloned at the start.
 +
 
 +
Therafter, simply press the green arrow directly each time you want to start. If there are any local changes, it will recompile; alternatively it will start up directly. It will take a little longer to start as it loads symbols; however you also have the benefit that any segfaults will be caught allowing you to report them!
 +
 
 +
'''As a standard .exe:'''
 +
NB these instructions overall are intended for setting up for development; there's a slightly more convoluted process for setting up for just plain flying (e.g. taking advantage of new features for aircraft development).
 +
 
 +
Essentially, Visual Studio doesn't copy in the DLLs into the /bin/ folder. It's also not ideal to manually copy in the DLLS as it can cause all sorts of issues. However, without the DLLs FlightGear won't work; therefore, you need to set the PATH so it knows where to look for them.
 +
This launch script should work, put into your /install/bin/ folder:
 +
{{collapsible script
 +
| type  = Windows batch file
 +
| title  = The <code>launch.bat</code> script for launching flightgear
 +
| lang  = batch
 +
| script =
 +
SET PATH=C:\path\to\FlightGearBuild\install\bin;C:\path\to\FlightGearBuild\windows-3rd-party\msvc140\3rdParty.x64\bin;C:\Qt\5.15.0\msvc2019_64\bin;%PATH%
 +
fgfs.exe --launcher
 +
| show  = 1
 +
}}
 +
 
 +
Adjust the "path\to" references to suit your own personal installation, as well as the QT5 path.
 +
 
 +
=== Updating ===
 +
To update FlightGear, in general, just run ''git pull'' on the source directories and then re-run the build.bat script -- it will update what it needs to, relatively quickly.
  
=== TerraGear ===
+
=== Changing the Configuration ===
TerraGear can be built the same way as FlightGear, just change the paths to your TerraGear source and directories.
+
When the Simgear/FlightGear version numbers change, or you change configuration options (e.g. toggling Compositor, changing OSG versions, changing QT versions) you do have to re-configure in CMake. To do this, it's usually safest to delete the  simgear-build and flightgear-build folders and re-run the build.bat script, to ensure the build is clean. There is no need to delete osg-build unless changing OSG version.
  
== External link ==
+
In case of problems, most of the time deleting the simgear-build and flightgear-build folders and re-running the build.bat script will be sufficient.
* {{flightgear file|docs-mini/README.MSVC}}
+
  
 
{{building}}
 
{{building}}
 
[[fr:compiler flightear avec CMake - Windows]]
 
[[fr:compiler flightear avec CMake - Windows]]
 
[[Category:Windows specific]]
 
[[Category:Windows specific]]

Latest revision as of 08:42, 22 October 2020

1rightarrow.png See Building Flightgear for the main article about this subject.

This article is intended to give an overview of building FlightGear on modern Windows systems. It was created using Windows 10 and VS 2019. It ought to be transferrable to earlier versions of the Windows OS and software.

As FlightGear is now 64-bit only, the guide only describes building on a 64-bit system.

Required software

  • CMake for Windows. Download and install the Windows Win64-x64 Installer.
  • Microsoft Visual Studio 2019 (MSVC). The Community version is free. There is no need for the premium versions; none of their features are required to build FlightGear. The C++ compiler will not be installed by default. You either choose this component during installation or after installation by starting MSVC and trying to create a new C++ project. The one to download is "Desktop Development with C++". Make sure to have the last version of the Windows SDK and C++ Compiler checked. As of 08/10/2020, the latest version of the compiler is "MSVC 142 - VS 2019 C++ x64/86 build tools (v14.27)".
  • Qt5 for the Integrated Qt5 Launcher. Download the online installer, and choose the version matching your toolchain of Visual Studio e.g. "Qt 5.15.1 --> MSVC 2019 64 bit". Any version past 5.9 will be fine; 5.15 recommended. Leave the default Developer and Designer Tools selection - these are needed for coding and compiling.
  • Git to keep your build up to date. It also simplifies downloads of components. Optional, but can't recommend it enough!

Obtaining source

1rightarrow.png See FlightGear and Git for the main article about this subject.

Throughout this article it is assumed that you have set up git clones of the various source repositories (FlightGear, SimGear, data...). Using an organized directory (see below) will help significantly.

The commands to run are:

git clone https://git.code.sf.net/p/flightgear/simgear simgear

git clone https://git.code.sf.net/p/flightgear/flightgear flightgear

git clone https://git.code.sf.net/p/flightgear/fgdata fgdata

git clone https://git.code.sf.net/p/flightgear/windows-3rd-party windows-3rd-party

git clone -b fgfs-342-1 https://github.com/zakalawe/osg.git osg


After downloading these, I would suggest assembling a folder structure as below:

Directory Tree

On Windows, assumptions on the directory structure are made to automate the discovery of dependencies. This recommended directory structure is described below. Clicking the links allows you to download pre-built parts. If you do not use the recommended structure you will need to enter paths by hand and some parts may not input correctly.

FlightGearBuild / (Main root directory)
fgdata / (FlightGear data files)
flightgear / (FlightGear sources)
install / (Directory where you will install the built binaries to)
launch.bat / (launch script if desired, see below)
osg / (OSG sources)
simgear / (SimGear sources)
windows-3rd-party-deps /
build.bat / (build script, see below)
update.bat / (update script, see below)

Building

Scripted Compilation

This script will allow you to build OpenSceneGraph, SimGear and FlightGear automatically.

Before starting to use the script, you need to edit the top few lines of the script. You will have to:

1. Set the path to your CMake installation.

2. Ensure that the path to your QT SDK is correct for your version of MSVC.

3. Ensure your toolchain version matches, e.g. "Visual Studio 16 2019" for MSVC 2019 or "Visual Studio 15 2017" for MSVC 2017.

4. Set ROOT_DIR to the FlightgearBuild folder you created (the above directory structure)

Post-compilation: Launching FlightGear

In the debugger: Open flightgear-build/FlightGear.sln. You can then perform all your development / debugging directly in VS. You normally only need to run build.bat again, if you update SimGear or OSG.

To launch FlightGear from Visual Studio, you can follow the following steps: The first time only:

  1. Make sure you set your build type to RelWithDebInfo in the top bar.
  2. To start with the launcher, click on the small black arrow beside Local Windows Debugger to open 'fgfs debug properties'. Switch to debugging; add --launcher to the 'Command Arguments'. Click Apply and then OK.
  3. Press the green arrow (Local Windows Debugger) to start up FlightGear.
  4. The first time you'll have to choose where FGDATA is -- to do this, select the 'fgdata' directory you cloned at the start.

Therafter, simply press the green arrow directly each time you want to start. If there are any local changes, it will recompile; alternatively it will start up directly. It will take a little longer to start as it loads symbols; however you also have the benefit that any segfaults will be caught allowing you to report them!

As a standard .exe: NB these instructions overall are intended for setting up for development; there's a slightly more convoluted process for setting up for just plain flying (e.g. taking advantage of new features for aircraft development).

Essentially, Visual Studio doesn't copy in the DLLs into the /bin/ folder. It's also not ideal to manually copy in the DLLS as it can cause all sorts of issues. However, without the DLLs FlightGear won't work; therefore, you need to set the PATH so it knows where to look for them. This launch script should work, put into your /install/bin/ folder:

Adjust the "path\to" references to suit your own personal installation, as well as the QT5 path.

Updating

To update FlightGear, in general, just run git pull on the source directories and then re-run the build.bat script -- it will update what it needs to, relatively quickly.

Changing the Configuration

When the Simgear/FlightGear version numbers change, or you change configuration options (e.g. toggling Compositor, changing OSG versions, changing QT versions) you do have to re-configure in CMake. To do this, it's usually safest to delete the simgear-build and flightgear-build folders and re-run the build.bat script, to ensure the build is clean. There is no need to delete osg-build unless changing OSG version.

In case of problems, most of the time deleting the simgear-build and flightgear-build folders and re-running the build.bat script will be sufficient.