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

From FlightGear wiki
Jump to: navigation, search
(Building)
(GUI compilation)
Line 77: Line 77:
 
## Set <tt>"Where to build the binaries"</tt> to the empty directory <tt>simgear-build</tt> in the BuildDirs 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.
 
## 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.
## CMake adds new configuration variables in red. Some have a value ending with <tt>-NOTFOUND</tt>. These variables do not necessarily need a value.  
+
## 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.
Some errors will prevent SimGear from building and others will simply invalidate some options (e.g. Swift VATSIM support) without causing build errors and thus can be ignored more or less unless you need that option.  
+
 
### 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.
 
### 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.
 
### Set the  <tt>CMAKE_INSTALL_PREFIX</tt> variable to <tt>\Dependencies\install\msvc140-64\Simgear</tt>
 
### Set the  <tt>CMAKE_INSTALL_PREFIX</tt> variable to <tt>\Dependencies\install\msvc140-64\Simgear</tt>

Revision as of 15:13, 17 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
  • 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

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

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

The FGMETA scripts are optional but will help.

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


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.

prebuilt dependencies for 64 bit Windows (.zip)

prebuilt Boost library (.zip)

Building 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 archive/install/msvc140-64/OpenSceneGraph folder into the directory structure shown below.

prebuilt OSG for Windows x64

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. Source and build directories can be located anywhere, but this structure will work well.

Dependencies / (Set ${MSVC_3RDPARTY_ROOT} to this directory)
3rdParty.x64 / (link above)
bin /
include /
lib /
Boost / (link above)
{boost libs} /
install /
msvc140-64 / (i.e. MSVC version 14.0 or later for 64 bit)
OpenSceneGraph / (link above)
bin /
include /
lib /
SimGear / (create this empty for now, subfolders will be created by build process)
FlightGear /
data / (FGDATA, link above)
Source /
flightgear-git / (FlightGear sources, link above)
simgear-git / (Simgear sources, link above)
BuildDirs /
flightgear-build / (Create empty)
simgear-build / (Create empty)

Building

GUI compilation

  1. Set up a work directory as described above or to your own personal preference.
  2. Having downloaded the sources into the Source directory, and all the prebuilt dependencies, continue below:
  3. Building SimGear
    1. Open the CMake gui.
    2. Set "Where is the source code" to the Source/simgear-git directory.
    3. Set "Where to build the binaries" to the empty directory simgear-build in the BuildDirs directory.
    4. Press 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.
    5. CMake adds new configuration variables in red. Some have a value ending with -NOTFOUND. 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.
      1. First check the MSVC_3RDPARTY_ROOT variable. If it is not set, chances are that there will be a lot of -NOTFOUND errors. Instead of trying to fix every error individually, set that variable to the location of the \Dependencies folder in the directory structure that is presented above. Then press CMake GUI Configure.png again.
      2. Set the CMAKE_INSTALL_PREFIX variable to \Dependencies\install\msvc140-64\Simgear
      3. Set the Boost_INCLUDE_DIR variable to \Dependencies
      4. To pick up Boost correctly, you must add a new Cache entry with name BOOST_ROOT, type PATH, and value \Dependencies. It is not required to set Boost_DIR to any value.
      5. Create a second cache entry, called CMAKE_PREFIX_PATH, type PATH and value \Dependencies\install\msvc140-64\OpenSceneGraph. This will allow OSG to be picked up automatically.
      6. Also verify the lines with a checkbox. These are build options and may impact the feature set of the built program.
      7. 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.
    6. Repeat the process from step 5, until CMake GUI Generate.png is enabled.
    7. Press CMake GUI Generate.png.
    8. Press File:CMake GUI Open Project.png.
    9. Choose the "RelWithDebInfo" build in the toolbar. The right menu should read x64 for 64-bits.
      MVSC 2010 solution.png
    10. 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.
    11. If there are build errors, return to CMake, clear remaining errors, CMake GUI Configure.png and CMake GUI Generate.png.
    12. When Visual Studio is able to build everything without errors, right-click on the INSTALL project (further down within the "Solution Simgear" solution) and choose Build, which will put the include and lib files in ${CMAKE_INSTALL_PREFIX}. This should only take a few seconds as you have already compiled everything.
  4. Building FlightGear
    Repeat the steps under Building Simgear, but change the SimGear paths to FlightGear.
    1. Notably, you will have to link Simgear and 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 SGPATH;QT5PATH;OSGPATH.
      1. Simgear: \Dependencies\install\msvc140-64\Simgear
      2. QT5: C:/Qt/5.15.0/msvc2019_64 (adjust to match your QT installation).
      3. My personal final path was: C:\Users\redpa\Documents\FlightGear\fg-from-scratch\fresh-build\Dependencies\install\msvc140-64\Simgear;C:/Users/redpa/Documents/FlightGear/fg-from-scratch/fresh-build/Dependencies/install/msvc140-64/OpenSceneGraph;C:/Qt/5.15.0/msvc2019_64
  5. Enjoy!

Updating

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.

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 CMakeCache.txt file in "Where to build the binaries” directory and delete it to reconfigure from scratch or use the menu item File > Delete Cache.

TerraGear

TerraGear can be built the same way as FlightGear, just change the paths to your TerraGear source and directories.

Jenkins Windows configurations

When using CMake GUI, you can add those entries by clicking the Add entry button. Note that you should omit the -D prefix.

OSG-Win

SimGear-Win

FlightGear-Win

External link