MediaWiki has been updated to version 1.35.1. Please report any problems here.

Difference between revisions of "Building using CMake - Windows"

From FlightGear wiki
Jump to navigation Jump to search
(Note about steps, fix link, add building template.)
(Change to windows-3rd-party otherwise it won`t compilate)
 
(74 intermediate revisions by 14 users not shown)
Line 1: Line 1:
 
{{Main article|Building Flightgear}}
 
{{Main article|Building Flightgear}}
 +
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 ==
 
== Required software ==
* [http://www.cmake.org CMake GUI]
+
* [https://cmake.org/download/ CMake for Windows]. Download and install the Windows Win64-x64 Installer.
* [http://www.microsoft.com/visualstudio/en-us/products/2010-editions/visual-cpp-express Microsoft Visual Studio 2010 Express]
+
* [https://visualstudio.microsoft.com/downloads/ 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)".
* [http://code.google.com/p/msysgit/ msysGit]
+
* [https://www.qt.io/download-open-source/ 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.
 +
* [https://git-scm.com/download/win Git] to keep your build up to date. It also simplifies downloads of components. Optional, but can't recommend it enough!
 +
 
 +
== Obtaining source ==
 +
{{Main article|FlightGear and Git}}
 +
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:
 +
 
 +
{{code|git clone https://git.code.sf.net/p/flightgear/simgear simgear}}
 +
 
 +
{{code|git clone https://git.code.sf.net/p/flightgear/flightgear flightgear}}
 +
 
 +
{{code|git clone https://git.code.sf.net/p/flightgear/fgdata fgdata}}
 +
 
 +
{{code|git clone https://git.code.sf.net/p/flightgear/windows-3rd-party windows-3rd-party}}
 +
 
 +
{{code|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 ==
+
== Directory Tree ==
On Windows, assumptions on the directory structure are made to automate the discovery of dependencies.
+
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.
  
This recommended directory structure is described below. Clicking the links allows you to download pre-built parts.
 
 
<tt>
 
<tt>
: ${MSVC_3RDPARTY_ROOT} /
+
: FlightGearBuild / </tt> (Main root directory) <tt>
:: [ftp://ftp.ihg.uni-duisburg.de/FlightGear/Win32/MSVC/ 3rdParty] / </tt> ( includes plib, fltk, zlib, libpng, libjpeg, libtiff, freetype, libsvn, gdal, ... ) <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)
:: 3rdParty.x64 / </tt> ( 64 bit version ) <tt>
+
:: osg / </tt> (OSG sources) <tt>
::: bin /
+
:: simgear / </tt> (SimGear sources) <tt>
::: include /
+
:: windows-3rd-party /
::: lib /
+
:: build.bat / </tt> (build script, see below)
:: boost_1_44_0 /
+
:: update.bat / </tt> (update script, see below)
::: boost /
 
:: install /
 
::: msvc100 / </tt> ( for VS2010 32 bits, or msvc90, msvc90-64 or msvc100-64 for VS2008 32, VS2008 64 and VS2010 64 ) <tt>
 
:::: [http://flightgear.simpits.org:8080/job/OSG-stable-Win/lastSuccessfulBuild/artifact/*zip*/archive.zip OpenSceneGraph] / </tt> ( OSG CMake install ) <tt>
 
::::: bin /
 
::::: include /
 
::::: lib /
 
:::: SimGear /
 
::::: include /
 
::::: lib /</tt>
 
  
If you do not use the recommended structure you will need to enter paths by hand. Source and build directories can be located anywhere.
+
== 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
  
The suggested inputs to cmake are :
+
md osg-build
      MSVC_3RDPARTY_ROOT : location of the above directory structure
+
md simgear-build
      CMAKE_INSTALL_PREFIX : ${MSVC_3RDPARTY_ROOT}/install/msvc100/FlightGear (or any variation for the compiler version described above )
+
md flightgear-build
  
== Building ==
+
cd %ROOT_DIR%\osg-build
# Set up a work directory as described above.
+
 
# Open the CMake gui.
+
cmake  %ROOT_DIR%\osg -G  %CMAKE_TOOLCHAIN% -A x64 ^
# '''The following steps depend on the part you would like to build.''' The here mentioned steps are for FlightGear, but SimGear and TerraGear can be built via the same method (just remember to change the paths).
+
                -DACTUAL_3RDPARTY_DIR=%ROOT_DIR%\windows-3rd-party/msvc140/3rdParty.x64 ^
# Set <tt>"Where is the source code"</tt> to wherever you put the FlightGear sources (from the released tarball or the git repository).
+
                -DCMAKE_RELWITHDEBINFO_POSTFIX:STRING= ^
# Set <tt>"Where to build the binaries"</tt> to an empty directory.
+
                -DOSG_USE_UTF8_FILENAME:BOOL=ON ^
# Press the <tt>"Configure"</tt> button. The first time that the project is configured, CMake will bring up a window asking which compiler you wish to use. Normally just accept CMakes suggestion, and press Finish. CMake will now do a check on your system and will produce a preliminary build configuration.
+
                -DWIN32_USE_MP:BOOL=ON ^
# CMake adds new configuration variables in red. Some have a value ending with <tt>-NOTFOUND</tt>. These variables should receive your attention. Some errors will prevent FlightGear to build and others will simply invalidate some options without provoking build errors. 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 and press the <tt>"Configure"</tt> button again.
+
                -DCMAKE_INSTALL_PREFIX:PATH=%ROOT_DIR%\install
# Also check the lines with a checkbox. These are build options and may impact the feature set of the built program.
+
cmake --build . --config RelWithDebInfo --target INSTALL
# Change the <tt>CMAKE_INSTALL_PREFIX</tt> to <tt>${MSVC_3RDPARTY_ROOT}/install/msvc100/FlightGear</tt> because <tt>C:\Program Files</tt> is likely unwritable to ordinary Windows users and will integrate better with the above directory structure (this is mandatory for SimGear if you don't want to solve errors by hand).
+
 
# Repeat the process until the <tt>"Generate"</tt> button is enabled.
+
cd %ROOT_DIR%\simgear-build
# Press the <tt>"Generate"</tt> button.
+
cmake  %ROOT_DIR%\simgear -G  %CMAKE_TOOLCHAIN% -A x64 ^
# Start Visual Studio 2010 and load the FlightGear solution (FlightGear.sln) located in <tt>"Where to build the binaries"</tt> (point 4.)
+
                -DOSG_FSTREAM_EXPORT_FIXED:BOOL=ON ^
# Choose the <tt>"Release"</tt> build in the VS2010 "Generation" toolbar[[File:MVSC 2010 solution.png|right]]
+
                -DCMAKE_INSTALL_PREFIX:PATH=%ROOT_DIR%\install
# Generate the solution.
+
cmake --build . --config RelWithDebInfo --target INSTALL
# If there are build errors, return to CMake, clear remaining errors, <tt>"Configure"</tt> and <tt>"Generate"</tt>
+
 
# When Visual Studio is able to build everything without errors, build the <tt>INSTALL</tt> project to put the product files in <tt>${CMAKE_INSTALL_PREFIX}</tt>
+
cd %ROOT_DIR%\flightgear-build
# Enjoy!
+
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.
  
PS: 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. It is also possible to edit CMakeList.txt files directly in Visual Studio as they also appear in the solution, and projects will be reconfigured on the next generation. 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 File->Delete Cache.
+
=== 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.
  
== Jenkins Windows configurations ==
+
=== Changing the Configuration ===
=== OSG-stable-Win ===
+
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.
cmake ..\svn -G "Visual Studio 10"
 
      -DACTUAL_3RDPARTY_DIR:PATH=%WORKSPACE%/3rdParty
 
      -DBUILD_OSG_APPLICATIONS:BOOL=ON
 
      -DCMAKE_INSTALL_PREFIX:PATH=%WORKSPACE%/install/msvc100/OpenSceneGraph
 
      -DOSG_PLUGIN_SEARCH_INSTALL_DIR_FOR_PLUGINS:BOOL=OFF
 
      -DFREETYPE_LIBRARY:FILEPATH=%WORKSPACE%/3rdParty/lib/freetype243.lib
 
      -DGDAL_INCLUDE_DIR:PATH=
 
      -DGDAL_LIBRARY:FILEPATH=
 
=== SimGear-Win-CMake ===
 
cmake ..\SimGear -G "Visual Studio 10"
 
      -DMSVC_3RDPARTY_ROOT=%WORKSPACE%
 
      -DCMAKE_INSTALL_PREFIX:PATH=%WORKSPACE%/install/msvc100/SimGear
 
=== FlightGear-Win-CMake ===
 
cmake ..\FlightGear -G "Visual Studio 10"
 
      -DMSVC_3RDPARTY_ROOT=%WORKSPACE%
 
      -DCMAKE_INSTALL_PREFIX:PATH=%WORKSPACE%/install/msvc100/FlightGear
 
      -DFLTK_FLUID_EXECUTABLE=%WORKSPACE%/3rdParty/bin/fluid.exe
 
=== FGRun-Win-CMake ===
 
  cmake ..\svn -G "Visual Studio 10"
 
      -DMSVC_3RDPARTY_ROOT:PATH=%WORKSPACE%
 
      -DCMAKE_INSTALL_PREFIX:PATH=%WORKSPACE%/install/msvc100/FGRun
 
      -DFLTK_FLUID_EXECUTABLE:FILEPATH=%WORKSPACE%/3rdParty/bin/fluid.exe
 
      -DGETTEXT_MSGFMT_EXECUTABLE:FILEPATH=%WORKSPACE%/3rdParty/bin/msgfmt.exe
 
      -DGETTEXT_MSGMERGE_EXECUTABLE:FILEPATH=%WORKSPACE%/3rdParty/bin/msgmerge.exe
 
=== TerraGear-Win-CMake ===
 
cmake ..\TerraGear -G "Visual Studio 10"
 
      -DMSVC_3RDPARTY_ROOT=%WORKSPACE%
 
      -DCMAKE_INSTALL_PREFIX:PATH=%WORKSPACE%/install/msvc100/TerraGear
 
      -DGPC_LIBRARY=%WORKSPACE%/3rdParty/lib/gpc232.lib
 
      -DNEWMAT_LIBRARY=%WORKSPACE%/3rdParty/lib/newmat11.lib
 
  
== 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.
* [https://gitorious.org/fg/flightgear/blobs/next/docs-mini/README.MSVC README.MSVC] (at Gitorious)
 
  
 
{{building}}
 
{{building}}
 +
[[fr:compiler flightear avec CMake - Windows]]
 +
[[Category:Windows specific]]
 +
[[Category:Hackathon Materials]]

Latest revision as of 11:48, 13 December 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 /
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.