# Changes

,  13:44, 22 October 2020
no edit summary
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]
+
* [http://www.microsoft.com/visualstudio/en-us/products/2010-editions/visual-cpp-express Microsoft Visual Studio 2010 Express] (MSVC)
+
* [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)".
+
* [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.
: If you get an error during the installation of the SDK, try uninstalling MSVC redist packages first, then installing the SDK without compilers and then finally re-installing MSVC.
+

== Obtaining source ==

== Obtaining source ==

{{Main article|FlightGear and Git}}

{{Main article|FlightGear and Git}}
Throughout this article it is assumed that you've already set up git clones of the various source repositories (FlightGear, SimGear, data...).
+
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}}
−
== 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 (for 3rdParty, make sure to download the right bits version. You need only one of the zips.). If you do not use the recommended structure you will need to enter paths by hand. Source and build directories can be located anywhere.
+
−
'''If you get a login dialog on the ftp server listed above, this means that the max allowed users are reach. Please try a few minutes later.'''
+
== 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.
−
=== 32-bits ===

<tt>

<tt>
: ${MSVC_3RDPARTY_ROOT} / + : FlightGearBuild / </tt> (Main root directory) <tt> :: [ftp://ftp.ihg.uni-duisburg.de/FlightGear/Win32/MSVC/ 3rdParty] / </tt> ( includes boost, 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) :: [http://www.boost.org/ boost_1_53_0] / </tt> (an old version is included in the 3rdParty package, latest version can be downloaded from http://www.boost.org/) <tt> + :: osg / </tt> (OSG sources) <tt> ::: boost / + :: simgear / </tt> (SimGear sources) <tt> :: install / + :: windows-3rd-party-deps / ::: msvc100 / </tt> ( for VS2010 32 bits, or msvc90 for VS2008 32-bits ) <tt> + :: build.bat / </tt> (build script, see below) :::: [http://flightgear.simpits.org:8080/job/OSG-stable-Win/lastSuccessfulBuild/artifact/*zip*/archive.zip OpenSceneGraph] / </tt> ( OSG CMake install ) <tt> + :: update.bat / </tt> (update script, see below) ::::: bin / + ::::: include / + == Building == ::::: lib / + === Scripted Compilation === :::: SimGear / </tt> (create this empty for now, subfolders will be created by build process) <tt> + This script will allow you to build OpenSceneGraph, SimGear and FlightGear automatically. ::::: include / + ::::: lib / + {{collapsible script :::: FlightGear / </tt> (create this empty for now) <tt> + | type = Windows batch file ::::: include / + | title = The <code>build.bat</code> script for configuring and compiling OSG, SG, and FG ::::: lib /</tt> + | 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 + + md osg-build + md simgear-build + md flightgear-build − === 64-bits === + cd %ROOT_DIR%\osg-build <tt> + :${MSVC_3RDPARTY_ROOT} /
+
cmake  %ROOT_DIR%\osg -G  %CMAKE_TOOLCHAIN% -A x64 ^
:: [ftp://ftp.ihg.uni-duisburg.de/FlightGear/Win32/MSVC/ 3rdParty.x64] /
+
-DACTUAL_3RDPARTY_DIR=%ROOT_DIR%\windows-3rd-party/msvc140/3rdParty.x64 ^
::: bin /
+
-DCMAKE_RELWITHDEBINFO_POSTFIX:STRING= ^
::: include /
+
-DOSG_USE_UTF8_FILENAME:BOOL=ON ^
::: lib /
+
-DWIN32_USE_MP:BOOL=ON ^
+
-DCMAKE_INSTALL_PREFIX:PATH=%ROOT_DIR%\install
::: boost /
+
cmake --build . --config RelWithDebInfo --target INSTALL
:: install /
+

::: msvc100-64 / </tt> ( for VS2010 64-bits, or msvc90-64 for VS2008 64-bits ) <tt>
+
cd %ROOT_DIR%\simgear-build
:::: [http://flightgear.simpits.org:8080/job/OSG-stable-Win64/lastSuccessfulBuild/artifact/*zip*/archive.zip OpenSceneGraph] / </tt> ( OSG CMake install ) <tt>
+
cmake  %ROOT_DIR%\simgear -G  %CMAKE_TOOLCHAIN% -A x64 ^
::::: bin /
+
-DOSG_FSTREAM_EXPORT_FIXED:BOOL=ON ^
::::: include /
+
-DCMAKE_INSTALL_PREFIX:PATH=%ROOT_DIR%\install
::::: lib /
+
cmake --build . --config RelWithDebInfo --target INSTALL
:::: SimGear / </tt> (create this empty for now, subfolders will be created by build process) <tt>
+

::::: include /
+
cd %ROOT_DIR%\flightgear-build
::::: lib /
+
cmake  %ROOT_DIR%\flightgear -G  %CMAKE_TOOLCHAIN% -A x64 ^
:::: FlightGear / </tt> (create this empty for now) <tt>
+
-DCMAKE_INSTALL_PREFIX:PATH=%ROOT_DIR%\install ^
::::: include /
+
-DCMAKE_PREFIX_PATH=%QT5SDK64% ^
::::: lib /</tt>
+
-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)
−
NdT: glut is missing for the 64bits build, you can use [http://www.transmissionzero.co.uk/software/freeglut-devel/ freeglut].
+
==== 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.
−
== Building ==
+
To launch FlightGear from Visual Studio, you can follow the following steps:
# Set up a work directory as described above.
+
The first time only:
# '''Building SimGear'''
+
# Make sure you set your build type to RelWithDebInfo in the top bar.
## Open the CMake gui.
+
# 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.
## Set <tt>"Where is the source code"</tt> to wherever you put the SimGear sources (from the released tarball or the git repository).
+
# Press the green arrow (Local Windows Debugger) to start up FlightGear.
## Set <tt>"Where to build the binaries"</tt> to a new empty directory (could be anywhere and any name, for example naming it simgear-build, at the same folder location as your unzipped SimGear source folder was put).
+
# The first time you'll have to choose where FGDATA is -- to do this, select the 'fgdata' directory you cloned at the start.
## 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 10 (or Visual Studio 10 Win64 for 64-bit), and press Finish. CMake will now do a check on your system and will produce a preliminary build configuration.
−
## 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 SimGear from building and others will simply invalidate some options without causing 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 to the location of the directory structure that is presented above. Then press [[File:CMake GUI Configure.png]] again.
−
### Set the  <tt>CMAKE_INSTALL_PREFIX</tt> variable to <tt>${MSVC_3RDPARTY_ROOT}/install/msvc100/SimGear</tt>. − ### Also check the lines with a checkbox. These are build options and may impact the feature set of the built program. − ## Repeat the process from step 5, until [[File:CMake GUI Generate.png]] is enabled. − ## Press [[File:CMake GUI Generate.png]]. − ## Start Visual Studio 2010 and load the SimGear solution (SimGear.sln) located in <tt>"Where to build the binaries"</tt>. − ## Choose the <tt>"Release"</tt> build in the VS2010 "Generation" toolbar. The right menu should read Win32 for 32-bits or x64 for 64-bits. [[File:MVSC 2010 solution.png|right]] − ## Generate the solution with F7 key or right-click the top level "Solution SimGear" in the Solution Explorer and choose Build. − ## 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>
−
# '''Building FlightGear'''
−
#: Repeat the steps under Building Simgear, but change the <tt>SimGear</tt> paths to <tt>FlightGear</tt>.
−
# Enjoy!
−
==== Build options ====
+
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!
To include [[LaRCsim]]/[[UIUC]] in your build, set:
−
ENABLE_LARCSIM:BOOL=ON
−
ENABLE_UIUC_MODEL:BOOL=ON
−
=== Updating ===
+
'''As a standard .exe:'''
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-run CMake.
+
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).
−
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 <tt>File > Delete Cache</tt>.
+
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
+
}}
−
=== TerraGear ===
+
Adjust the "path\to" references to suit your own personal installation, as well as the QT5 path.
TerraGear can be built the same way as FlightGear, just change the paths to your TerraGear source and directories.
−
== Jenkins Windows configurations ==
+
=== Updating ===
When using CMake GUI, you can add those entries by clicking the Add entry button. Note that you should omit the -D prefix.
+
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.
−
=== OSG-stable-Win ===
+
=== Changing the Configuration ===
cmake ..\svn -G "Visual Studio 10"
+
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.
-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
−
+
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.

{{building}}

{{building}}

[[fr:compiler flightear avec CMake - Windows]]

[[fr:compiler flightear avec CMake - Windows]]
+
[[Category:Windows specific]]
+
[[Category:Hackathon Materials]]
810

edits