Difference between revisions of "Compile In Windows"

From FreeOrionWiki
Jump to: navigation, search
m (Compilation Instructions)
(We use msvc2015, not msvc2013)
 
(15 intermediate revisions by 5 users not shown)
Line 1: Line 1:
==Compilation Instructions==
+
==Prerequisites==
# First, get the [http://sourceforge.net/projects/freeorion/files/FreeOrion%20SDK FreeOrion SDK] from SourceForge. (~30MB)
+
# Check out the source code from [[Compile#Subversion|SVN]](~240MB) - (easiest route is to install Tortoise SVN, unzip the SDK downloaded in step 1 above, right click on the /FreeOrion folder, and chose SVN Update)
+
# Open FreeOrion\msvc2010\FreeOrion.sln
+
# Use Build->Build Solution to build all projects' release targets
+
 
+
Compilation may take some time: ~1 hour on Core i3 370M with 6GB RAM, ~20 min on Core i7 4710HQ with 8 GB RAM.
+
  
 
===Compiler===
 
===Compiler===
FreeOrion can be compiled on Windows with the Visual Studio 2010.  Premade Visual Studio 2010 project files are available in SVN, and the SDK provides precompiled dependencies for this compiler.  Project files may also be generated using CMake.
 
  
Visual Studio 2010 Express Edition may be [http://www.microsoft.com/express/Downloads/#2010-Visual-CPP downloaded for trial] from Microsoft. If that link doesn't work even in IE, than use [http://go.microsoft.com/?linkid=9709949 this English link]. But after 30 days you have to register for free.
+
FreeOrion can be compiled on Windows with Visual Studio 2015 Update 3. Premade Visual Studio project files are available in the source code repository, and the SDK provides precompiled dependencies for the compiler. Project files may also be generated using CMake.
  
If you are a student, you may also be eligible for [http://www.dreamspark.com Microsoft Dreamspark], which will give you the Professional version of MSVC 2010 or several other Microsoft programs.
+
====Getting Visual Studio====
  
Also, if you are a student you should check out if your university takes part in the MSDNAA (Microsoft Developers Network Academic Alliance). You might be able to get Visual Studio 2010 Ultimate and other very pricy software for free or at some places a small administrative fee (like 5€ to get access for a semester)
+
Visual Studio Community and Express can be [https://www.visualstudio.com/downloads/download-visual-studio-vs#DownloadFamilies_2 downloaded from Microsoft here].  If you're not sure which edition to pick, take the latest one for Windows Desktop.  You will need a Microsoft account to proceed, if you don't have one, you will have to register one.
  
===Software Dependencies===
+
===Version Control System===
The majority of FreeOrion dependencies can be found precompiled and packaged in the FreeOrion Windows SDK, from the [http://sourceforge.net/projects/freeorion/files/FreeOrion%20SDK/ SourceForge FreeOrion SDK page].
+
  
The SDK includes compiled libraries, headers and DLLs for: zlib, OGRE, Python, bullet, Boost, FreeType, GLEW, libpng, libjpeg, OpenAL, ALUT, libvorbis, and libogg.
+
The FreeOrion project uses [[wikipedia:Git_(software)|Git]] for version control. To be able to use the SDK, you need to install the git command line client (the most recent release for Windows can be downloaded [http://git-scm.com/download/win here]). '''Important:''' When installing the git command line client, be sure to select the option that will include the git executable in your command path, otherwise the batch script which sets up the SDK will fail.
  
Other dependencies include:
+
==Compilation Instructions==
  
* '''GiGi''' - Including '''GiGiOgre''' and '''GiGiOgrePlugin_OIS'''. The code for these is included in the FreeOrion SVN repository. The MSVC project files contain projects for the GiGi libraries that are needed by FreeOrion, and the DLLs .lib files will be placed in the FreeOrion folder when built. All GiGi dependencies are in the FreeOrion SDK and should be automatically found and used when GiGi is built. If building FreeOrion using cmake, GiGi but must be built from source and installed.
+
===Step by Step===
 +
 
 +
# First, get the FreeOrion SDK for Windows from [https://github.com/freeorion/freeorion-sdk/releases GitHub] (for FreeOrion later than v0.4.6) or [http://sourceforge.net/projects/freeorion/files/FreeOrion%20SDK SourceForge] (for FreeOrion v0.4.6 and earlier). (~50 or 35 MB)
 +
# Unpack the SDK to a directory of your choice.
 +
# Run the ''bootstrap.bat'' file located in the root folder of the unpacked SDK. This will (among other things) download and check out the source code from GitHub ([https://github.com/freeorion/freeorion freeorion/freeorion] repository, checked out branch will be "master").
 +
# Depending on which version of Visual Studio you're using, open FreeOrion\msvc2015\FreeOrion.sln
 +
# Use Build->Build Solution to build all projects' release targets.
 +
 
 +
Compilation may take some time: ~1 hour on Core i3 370M with 6GB RAM, ~20 min on Core i7 4710HQ with 8 GB RAM.
 +
 
 +
===Software Dependencies===
 +
 
 +
The SDK includes compiled libraries, headers and DLLs for: zlib, Python 2, Boost, FreeType, GLEW, libpng, OpenAL, libvorbis, and libogg, SDL2.
  
 
==Runtime Errors==
 
==Runtime Errors==
 +
 
Please report runtime errors in the [http://www.freeorion.org/forum/viewtopic.php?f=9&t=1787 forums].
 
Please report runtime errors in the [http://www.freeorion.org/forum/viewtopic.php?f=9&t=1787 forums].

Latest revision as of 13:06, 25 March 2018

Prerequisites

Compiler

FreeOrion can be compiled on Windows with Visual Studio 2015 Update 3. Premade Visual Studio project files are available in the source code repository, and the SDK provides precompiled dependencies for the compiler. Project files may also be generated using CMake.

Getting Visual Studio

Visual Studio Community and Express can be downloaded from Microsoft here. If you're not sure which edition to pick, take the latest one for Windows Desktop. You will need a Microsoft account to proceed, if you don't have one, you will have to register one.

Version Control System

The FreeOrion project uses Git for version control. To be able to use the SDK, you need to install the git command line client (the most recent release for Windows can be downloaded here). Important: When installing the git command line client, be sure to select the option that will include the git executable in your command path, otherwise the batch script which sets up the SDK will fail.

Compilation Instructions

Step by Step

  1. First, get the FreeOrion SDK for Windows from GitHub (for FreeOrion later than v0.4.6) or SourceForge (for FreeOrion v0.4.6 and earlier). (~50 or 35 MB)
  2. Unpack the SDK to a directory of your choice.
  3. Run the bootstrap.bat file located in the root folder of the unpacked SDK. This will (among other things) download and check out the source code from GitHub (freeorion/freeorion repository, checked out branch will be "master").
  4. Depending on which version of Visual Studio you're using, open FreeOrion\msvc2015\FreeOrion.sln
  5. Use Build->Build Solution to build all projects' release targets.

Compilation may take some time: ~1 hour on Core i3 370M with 6GB RAM, ~20 min on Core i7 4710HQ with 8 GB RAM.

Software Dependencies

The SDK includes compiled libraries, headers and DLLs for: zlib, Python 2, Boost, FreeType, GLEW, libpng, OpenAL, libvorbis, and libogg, SDL2.

Runtime Errors

Please report runtime errors in the forums.