Difference between revisions of "Compile"

From FreeOrionWiki
Jump to: navigation, search
m (fat OSses)
(Remove most content; just link to github build instructions)
 
(96 intermediate revisions by 12 users not shown)
Line 1: Line 1:
Currently, [[FreeOrion]] will compile in Windows XP (SP2), Windows Vista and Linux.  Mac OS X versions have been produced, but are not actively supported.  The *BSD genus of operating systems might also work; follow the Linux instructions in this case, and drop us a note telling us what you did if you manage to build it.
+
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 [https://github.com/freeorion/freeorion/blob/master/BUILD.md build instructions] in the project git repository.
==Overview==
+
First of all, you will need to obtain the [[source]].  This can be grabbed from our [[project page]] or from Subversion (SVN).  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 SVN copy.  Then you need to set up the required software, compile the game, download the missing artwork, and run it.
+
 
+
 
+
==Hardware requirements==
+
The FreeOrion code makes heavy use of templates, and requires much memory to compile; at least 1 GB of RAM is recommended, and at least 512 MB is strongly recommended.  If you have less than 256 MB of RAM plus at least the same amount of swap, you probably will run into trouble.
+
 
+
On Linux, if you have only 256 MB of RAM and want to speed up compilation significantly, you could shut down your X server and compile from console.  (If this doesn't mean anything to you, simply ignore this advice.)  Otherwise, your computer will spend 95% of the time swapping, but will finish, eventually.
+
 
+
You will also need a fast processor.  Expect more than one hour for a first-time build on a 2 GHz processor (after building GG and any other necessary dependencies).
+
 
+
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, most dependencies are available pre-compiled in the FreeOrion SDK.'''
+
 
+
* [[GiGi]] - Latest version from [http://sourceforge.net/svn/?group_id=84040 SourceForge SVN], will automatically be included in the FreeOrion/GG directory when checking out the FreeOrion Subversion archive
+
* [http://www.freetype.org FreeType2] - a GiGi dependency
+
* [http://www.boost.org/ Boost] - '''version 1.36'''
+
* [http://www.libsdl.org SDL] - a GiGi dependency
+
* [http://www.graphviz.org/ GraphViz] - '''version 2.8''' ('''version <2.22''' on Linux)
+
* [http://www.ogre3d.org/ Ogre 3D] - '''version 1.6.1'''
+
* [http://www.openal.org/downloads.html OpenAL and ALUT]
+
* [http://xiph.org/downloads/ libogg] - '''version 1.1.3'''
+
* [http://xiph.org/downloads/ libvorbis] - '''version 1.1.2'''
+
* [http://www.python.org/download/ Python] - '''version 2.4 or later''' ('''version 2.5 if using the FreeOrion Windows SDK''') ('''version 2.x only; 3.x will not work''')
+
* [http://www.bulletphysics.com/Bullet/wordpress/ Bullet]  - '''version 2.73'''
+
* [http://glew.sourceforge.net/ GLEW] - (Windows only)
+
* [http://www.scons.org/ SCons] - Optional on Windows, but required on Linux to build GiGi and FreeOrion
+
 
+
==Getting the source==
+
 
+
===Subversion===
+
 
+
The source code can be obtained from the sourceforge Subversion server, using this command from the Linux command prompt:
+
 
+
svn co https://freeorion.svn.sourceforge.net/svnroot/freeorion/trunk freeorion
+
 
+
For Windows, a graphical shell-extension SVN client, such as [http://tortoisesvn.tigris.org/ TortoiseSVN] is recommended, with which the source can be obtained from ''https://freeorion.svn.sourceforge.net/svnroot/freeorion''.''
+
 
+
===Tarballs===
+
 
+
The SourceForge web Subversion client allows one to download numbered versions of the source code as a tarball.
+
 
+
The latest version can be obtained from the '''Download GNU tarball''' link on the bottom of this page: ''http://freeorion.svn.sourceforge.net/viewvc/freeorion/trunk/FreeOrion/''
+
 
+
You can also download versions corresponding to previous releases:
+
 
+
* [https://sourceforge.net/project/showfiles.php?group_id=75752&package_id=111134&release_id=660507 FreeOrion v0.3.12 '''for Windows'''] is SVN revision 2807: '''http://freeorion.svn.sourceforge.net/viewvc/freeorion/trunk/?pathrev=2807''' with GiGi revision 710 '''http://gigi.svn.sourceforge.net/viewvc/gigi/?pathrev=710'''
+
 
+
* [https://sourceforge.net/project/showfiles.php?group_id=75752&package_id=111134&release_id=660507 FreeOrion v0.3.12.1 '''for Linux'''] is SVN revision 2918: '''http://freeorion.svn.sourceforge.net/viewvc/freeorion/trunk/?pathrev=2918''' with GiGi revision 711 '''http://gigi.svn.sourceforge.net/viewvc/gigi/?pathrev=711'''
+
 
+
* [https://sourceforge.net/project/showfiles.php?group_id=75752&package_id=111134&release_id=652545 FreeOrion v0.3.11] is SVN revision 2729 on Windows: '''http://freeorion.svn.sourceforge.net/viewvc/freeorion/trunk/FreeOrion/?pathrev=2729''' and 2732 on Linux: '''http://freeorion.svn.sourceforge.net/viewvc/freeorion/trunk/FreeOrion/?pathrev=2732''' with GiGi revision 695 '''http://gigi.svn.sourceforge.net/viewvc/gigi/trunk/GG/?pathrev=695'''
+
 
+
* [https://sourceforge.net/project/showfiles.php?group_id=75752&package_id=111134&release_id=609273 FreeOrion v0.3.10] is SVN revision 2607 '''http://freeorion.svn.sourceforge.net/viewvc/freeorion/trunk/FreeOrion/?pathrev=2607''' with GiGi revision 651 '''http://gigi.svn.sourceforge.net/viewvc/gigi/trunk/GG/?pathrev=651'''
+
 
+
==Compilation==
+
Compilation instructions and troubleshooting tips are available for the following operating systems:
+
* [[Compile_In_Linux|Linux]]
+
* [[Compile_In_Windows|Windows]]
+
* [[Compile_In_MacOsX|MacOS X]]
+

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.