Difference between revisions of "Compile"

From FreeOrionWiki
Jump to: navigation, search
(Remove most content; just link to github build instructions)
 
(10 intermediate revisions by 5 users not shown)
Line 1: Line 1:
 
Currently, [[FreeOrion]] will compile in most recent Windows, Linux, and MacOSX.  The *BSD genus of operating systems might also work; follow the Linux instructions in this case.
 
Currently, [[FreeOrion]] will compile in most recent Windows, Linux, and MacOSX.  The *BSD genus of operating systems might also work; follow the Linux instructions in this case.
  
==Overview==
+
Consult the [https://github.com/freeorion/freeorion/blob/master/BUILD.md build instructions] in the project git repository.
 
+
First of all, you will need to obtain the [[wikipedia:Source_code|source code]] from [https://github.com/freeorion/freeorion GitHub]. The versions available on the [[project page]] are official releases or point releases, and may be somewhat or very out of date. To help with [[programming]] [[FreeOrion]], you will need to grab the Git master repository latest version. Then you need to set up the required software, compile the game, and run it.
+
 
+
==Hardware requirements==
+
The FreeOrion code makes heavy use of templates, and requires much memory to compile; 4 GB or more RAM is recommended.
+
 
+
On Linux, shutting down your X server and compiling from console may help on systems with little RAM.  (If this doesn't mean anything to you, simply ignore this advice.)
+
 
+
You will also need a fast processor.  To build GG and FreeOrion, expect up to 45 minutes of a Core i5 system, or over an hour on a Core2 Duo system; on a Core i7 system it can be under 10 minutes.
+
 
+
Note that, while not required to compile FreeOrion, running the FreeOrion client requires a graphics card and drivers that support OpenGL 2.0.
+
 
+
==Software requirements==
+
'''Note: On Windows and OSX, most dependencies are available pre-compiled in the [[Compile#FreeOrion SDK|FreeOrion SDK]].'''
+
 
+
* [http://www.boost.org/ Boost] - '''version 1.54''' or later.
+
* [http://www.freetype.org FreeType2] -'''version 2.5.3 is known to work'''.
+
* [http://www.python.org/download/ Python] - '''version 2.7 or later''' ('''version 2.x only; 3.x will not work''')
+
* [http://www.openal.org/downloads.html OpenAL]
+
* [http://xiph.org/downloads/ libogg] - '''version 1.1.3 or later''' 1.2.1 is known to work.
+
* [http://xiph.org/downloads/ libvorbis] - '''version 1.1.2 or later''' 1.3.2 is known to work.
+
* [http://www.zlib.net/ zlib] - version 1.2.5 is known to work with libpng 1.4.4
+
* [http://www.libpng.org/pub/png/libpng.html libpng] - '''version 1.6''' works.
+
* [http://www.libsdl.org/download-2.0.php SDL2] - '''version 2.0.3''' works.
+
* [http://glew.sourceforge.net/ GLEW] - (Windows only) '''version 1.5.7''' is known to work.
+
 
+
 
+
==Getting the source==
+
 
+
The source code can be obtained from the [https://github.com/freeorion/freeorion freeorion/freeorion] repository hosted on GitHub via any Git client.  Release versions are tagged in that repository.  To download a release source tarball without cloning the complete freeorion/freeorion repository the GitHub [https://github.com/freeorion/freeorion/releases Release] page can be used.
+
 
+
 
+
===FreeOrion SDK===
+
 
+
There are Software Development Kits (SDKs) available for Windows and MacOSX which contain precompiled dependencies needed for building FreeOrion from source. You may download and build all of these open-source dependencies yourself if you prefer. Using the SDK is likely faster and easier, however.
+
 
+
The SDKs do not contain the FreeOrion source code, which must be retrieved from GitHub.
+
 
+
 
+
==Compilation==
+
Compilation instructions and troubleshooting tips are available for the following operating systems:
+
* [[Compile_In_Linux|Linux]]
+
* [[Compile_In_Windows|Windows]]
+
* [[Compile_In_Mac_OS_X|Mac OS X]]
+
* For BSD, consult the Linux instructions, and possibly [http://www.freeorion.org/forum/viewtopic.php?p=36318#p36318 this forum thread].
+

Latest revision as of 14:39, 22 April 2020

Currently, FreeOrion will compile in most recent Windows, Linux, and MacOSX. The *BSD genus of operating systems might also work; follow the Linux instructions in this case.

Consult the build instructions in the project git repository.