Building using CMake - Windows: Difference between revisions
(→OSG-stable-Win: Updated to the current Jenkins config, switching to {{collapsible script}}.) |
m (→SimGear) |
||
Line 107: | Line 107: | ||
REM Compile. | REM Compile. | ||
cmake --build . --target install | cmake --build . --target install | ||
| show = 1 | |||
}} | }} | ||
Revision as of 19:47, 19 October 2016
See Building Flightgear for the main article about this subject. |
Required software
- CMake GUI
- Microsoft Visual Studio 2015 Express (MSVC)
- Microsoft Windows SDK (only required for 64-bit builds)
- 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.
- Qt5 for the Integrated Qt5 Launcher (optional as of 03/2015)
Obtaining source
See FlightGear and Git for the main article about this subject. |
Throughout this article it is assumed that you've already set up git clones of the various source repositories (FlightGear, SimGear, data...).
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.
32-bits
- ${MSVC_3RDPARTY_ROOT} /
- 3rdParty / ( includes plib, fltk, zlib, libpng, libjpeg, libtiff, freetype, libsvn, gdal, ... )
- bin /
- include /
- lib /
- Boost / (latest version can be downloaded from http://www.boost.org/)
- boost /
- lib /
- install /
- msvc140 / ( for VS2015 32 bits, or msvc100 for VS2010 32 bits, or msvc90 for VS2008 32-bits or newer versions of Visual Studio)
- OpenSceneGraph / ( OSG CMake install )
- bin /
- include /
- lib /
- SimGear / (create this empty for now, subfolders will be created by build process)
- include /
- lib /
- FlightGear / (create this empty for now)
- include /
- lib /
- OpenSceneGraph / ( OSG CMake install )
- msvc140 / ( for VS2015 32 bits, or msvc100 for VS2010 32 bits, or msvc90 for VS2008 32-bits or newer versions of Visual Studio)
- 3rdParty / ( includes plib, fltk, zlib, libpng, libjpeg, libtiff, freetype, libsvn, gdal, ... )
64-bits
- ${MSVC_3RDPARTY_ROOT} /
- 3rdParty.x64 /
- bin /
- include /
- lib /
- Boost /
- boost /
- lib64 /
- install /
- msvc140-64 / ( for VS2015 64-bits, or msvc100-64 for VS2010 64-bits, or msvc90-64 for VS2008 64-bits )
- OpenSceneGraph / ( OSG CMake install )
- bin /
- include /
- lib /
- SimGear / (create this empty for now, subfolders will be created by build process)
- include /
- lib /
- FlightGear / (create this empty for now)
- include /
- lib /
- OpenSceneGraph / ( OSG CMake install )
- msvc140-64 / ( for VS2015 64-bits, or msvc100-64 for VS2010 64-bits, or msvc90-64 for VS2008 64-bits )
- 3rdParty.x64 /
NdT: glut is missing for the 64bits build, you can use freeglut.
Building
GUI compilation
- Set up a work directory as described above.
- Building SimGear
- Open the CMake gui.
- Set "Where is the source code" to wherever you put the SimGear sources (from the released tarball or the git repository).
- Set "Where to build the binaries" 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).
- Press . 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 -NOTFOUND. 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 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 directory structure that is presented above. Then press again.
- Set the CMAKE_INSTALL_PREFIX variable to ${MSVC_3RDPARTY_ROOT}/install/msvc140/SimGear.
- 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 is enabled.
- Press .
- Start Visual Studio 2015 and open the SimGear solution (SimGear.sln) located in "Where to build the binaries".
- Choose the "Release" build in the toolbar. The right menu should read Win32 for 32-bits or x64 for 64-bits.
- 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, and .
- 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}
- Building FlightGear
- Repeat the steps under Building Simgear, but change the SimGear paths to FlightGear.
- Enjoy!
Script compilation
Firstly set up the directory structure as above. For the following scripts, the Windows environmental variable MSVC_3RDPARTY_ROOT
must be set to the full path where this is located.
SimGear
For building SimGear with MSVC 2015 as 64-bit:
.cmake.bat
script for configuring and compiling SimGearREM Configure.
cmake .. ^
-DMSVC_3RDPARTY_ROOT=%MSVC_3RDPARTY_ROOT% ^
-DCMAKE_INSTALL_PREFIX=%MSVC_3RDPARTY_ROOT%\install\msvc140-64\SimGear ^
-G"Visual Studio 14 Win64"
REM Compile.
cmake --build . --target install
.cmake.bat
script for configuring and compiling SimGear (with debugging symbols)Place the script in a new directory within the SimGear sources such as build
. To clean up the build files, another batch file can be used:
.clean.bat
script for cleaning up the buildFlightGear
For building FlightGear with MSVC 2015 as 64-bit:
.cmake.bat
script for configuring and compiling FlightGear.cmake.bat
script for configuring and compiling FlightGear (with debugging symbols)Place the script in a new directory within the FlightGear sources such as build
. To clean up the build files, another batch file can be used:
.clean.bat
script for cleaning up the buildUpdating
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.
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
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
|