DarkRadiant - Compilation Guide: Difference between revisions

From The DarkMod Wiki
Jump to navigationJump to search
No edit summary
 
(61 intermediate revisions by 2 users not shown)
Line 1: Line 1:
= Obtain the Sources =
DarkRadiant's codebase is open source, the main part of the source code is hosted on github. To compile the sources you can either use
The complete codebase plus all win32 dependencies are available at SourceForge. To check out the sources, open up Explorer and create the folder you want to store them.


First, download and install [http://tortoisesvn.tigris.org/ '''TortoiseSVN''']. Nothing special here, just install it into any folder of your preference. After installation it probably will ask to reboot your machine, as Tortoise integrates into the Explorer shell. (You can do that later, when all the other components have been installed).
* Windows: ''Visual Studio 2022 Community Edition'' (higher editions also possible: Professional, Ultimate, ...)
* Linux: gcc/g++ (Automake)
* Mac OS X: Automake (after installing XCode and using MacPorts)


Right-click somewhere in the white space and choose '''SVN Checkout'''. A new dialog appears asing you for the repository URL and the checkout folder. You can copy and paste the URL from here into the dialog window and click ok:
All compilers can be acquired for free. In any case, since DarkRadiant is using part of the C++17 feature set, a compiler supporting the C++17 standard is required.
https://darkradiant.svn.sourceforge.net/svnroot/darkradiant/trunk/darkradiant/


[[Image:Dr_checkout.jpg|200px]]
= Compilation Guides =
There are separate articles for Windows and Linux, select one to learn more:


== Check out the Dependencies (Win32) ==
* [[DarkRadiant - Compiling in Windows|Compiling in Windows / Visual Studio]]
For Windows builds, the dependencies must be checked out along with the sources. To keep the main source repository small, the dependencies are stored in a different folder next to the trunk:
https://darkradiant.svn.sourceforge.net/svnroot/darkradiant/trunk/w32deps/
To check them out in the correct folder, proceed like this: Go to the parent folder of the one you checked out the sources to. Given you checked them out in C:\DarkRadiant, go to the C:\ folder. Right-click somewhere in the white area of the explorer window and choose SVN > Checkout. (Note: it is necessary to right-click a folder which is not under version control, otherwise Tortoise won't provide the "Checkout" option). Make sure that the w32deps/ folder is created under the C:\DarkRadiant folder, like this:
 
[[Image:Dr checkout dependencies.jpg|200px]]
 
The resulting folder structure should look like this. '''The w32deps/ folder must be in the same folder as the radiant/ or include/ folder.'''
 
C:\
C:\DarkRadiant
C:\DarkRadiant\include\
C:\DarkRadiant\libs\
C:\DarkRadiant\plugins\
C:\DarkRadiant\radiant\
C:\DarkRadiant\w32deps\    <<----- w32deps/ is next to the radiant/ folder
 
== [optional] Check out the Dependencies (Win64) ==
Users aiming to build for the Windows x64 target need to check out one '''additional''' folder to retrieve the binaries needed during the compilation process. Important: you need to check out '''both''' the w32deps as well as the w64deps folder.
https://darkradiant.svn.sourceforge.net/svnroot/darkradiant/trunk/w64deps/
Go to the parent directory of the one you checked out the sources to, like described in the guide for checking out the w32deps. Given you checked them out in <tt>C:\DarkRadiant</tt>, go to the C:\ folder. Right-click somewhere in the white area of the explorer window and choose SVN > Checkout. (Note: it is necessary to right-click a folder which is not under version control, otherwise Tortoise won't provide the "Checkout" option). Make sure that the w64deps/ folder is created under the <tt>C:\DarkRadiant</tt> folder, like this:
 
[[Image:Dr checkout x64 dependencies.png|200px]]
 
The resulting folder structure should look like this. '''The w64deps/ folder must be in the same folder as the radiant/ or include/ folder, next to the w32deps/ one.'''
 
C:\DarkRadiant
C:\DarkRadiant\include\
C:\DarkRadiant\libs\
C:\DarkRadiant\..\
C:\DarkRadiant\radiant\
C:\DarkRadiant\w32deps\    <<----- w32deps/ is needed as well
C:\DarkRadiant\w64deps\    <<----- w64deps/ checked out at the same level as w32deps!
 
= Compiling =
Once you've downloaded the sources, the steps for compiling DarkRadiant depend on your toolset/compiler. Choose one of the links below:
* [[DarkRadiant - Compiling in Visual C++ 2008|Compiling in Visual C++ 2008]]
* [[DarkRadiant - Compiling in Visual C++ 2005|<del>Compiling in Visual C++ 2005</del>]] (Note: the VC++ 2005 project files have been removed in favour of the VS 2008 ones)
* [[DarkRadiant - Compiling in MinGW|<del>Compiling in MinGW</del>]] (Note: MinGW is not supported anymore, this page is outdated)
* [[DarkRadiant - Compiling in Linux|Compiling in Linux]]
* [[DarkRadiant - Compiling in Linux|Compiling in Linux]]
* [[DarkRadiant - Compiling in macOS|Compiling in macOS]] (experimental)


== How to compile the boost static libraries in Windows ==
Note: The articles are always referring to the latest revision of the source code, not to a specific release.
Any VC++ compiler version '''other than the ones mentioned above''' will require a recompile of the boost static libraries which DarkRadiant links against. At the time of writing, DarkRadiant is using the following boost libraries:
* boost.regex
* boost.filesystem
* boost.system
* boost.python
To build these static libraries, boost provides the jam tool (bjam.exe), which can be used to build the statics for you. Go get the boost sources from their website (http://www.boost.org) and extract them into a new folder. Then get bjam (can also be downloaded from their website, but you can also build it from scratch), open a console (Win-R ==> "cmd" => Enter) and head to:
cd <YOUR BOOST FOLDER HERE>
cd libs
cd filesystem
cd build
bjam --toolset=msvc link=static release stage
bjam --toolset=msvc link=static debug stage
After these commands, the '''libboost_filesystem_vc*.lib''' files (both debug and release variants) are in the '''stage/''' directory below your boost folder. You'll need to repeat the above steps and replace '''filesystem''' with the names of the other libraries '''regex''' and '''system'''.
 
Note for x64 users: Add the <tt>address-model=64</tt> option to bjam in order to build static libs with the 64-bit compiler.
 
Now take the *.lib files and copy them into your '''w32deps/boost/lib''' folder (or the '''w64deps/boost/lib''' for Win64 targets) in your darkradiant directory and the linking should succeed.
 
= See also =
* [[DarkRadiant - Compilation Problems]]
* [[DarkRadiant - Compiling in Linux]]


{{coding}}
{{coding}}
{{darkradiant|sort=Compilation}}
{{darkradiant|sort=Compilation}}

Latest revision as of 19:34, 1 April 2022

DarkRadiant's codebase is open source, the main part of the source code is hosted on github. To compile the sources you can either use

  • Windows: Visual Studio 2022 Community Edition (higher editions also possible: Professional, Ultimate, ...)
  • Linux: gcc/g++ (Automake)
  • Mac OS X: Automake (after installing XCode and using MacPorts)

All compilers can be acquired for free. In any case, since DarkRadiant is using part of the C++17 feature set, a compiler supporting the C++17 standard is required.

Compilation Guides

There are separate articles for Windows and Linux, select one to learn more:

Note: The articles are always referring to the latest revision of the source code, not to a specific release.