Context Navigation

Changes between Version 58 and Version 59 of BuildInstructions

Timestamp:: Aug 6, 2009, 12:55:44 PM (15 years ago)
Author:: Erik Johansson
Comment:: spelling error corrected

Legend:

: Unmodified
: Added
: Removed
: Modified

BuildInstructions

-              v58
+              v59
 == General prerequisites ==
+You'll need:
-You'll need:
  * An adequately high-spec computer - several gigabytes of free disk space, preferably at least 1GB of RAM for compiling, a fast CPU unless you want to spend ages waiting for the compiler, etc. Modern graphics hardware is also recommended, though the game can run (slowly) on fairly old devices (!GeForce 4, Intel 945GM, etc).
  * Up-to-date system software (Windows service packs, graphics driver updates, etc).
 …
 == Windows ==
 Windows XP and Vista are the main supported versions; 2000 and 7 may work too.
 === Acquiring the code ===
 The game's code, data and build environment are stored on a Subversion server. The recommended way to get an up-to-date copy is with TortoiseSVN:
  * Download and install [http://tortoisesvn.net/ TortoiseSVN]. (Make sure you reboot when it asks you to.)
  * Use TortoiseSVN to check out `http://svn.wildfiregames.com/public/ps/trunk/`. This may take a while, and will use around 700MB of disk space. Make sure it's in a path that does not contain any space characters.
   * '''Note:''' The SVN server is currently very busy, and is likely to return "503 Service Unavailable" errors. You might want to wait a few days before downloading all the code. (Linux users should see below for a quicker way to download the code.)
+   * '''Note:''' The SVN server is currently very busy, and is likely to return "503 Service Unavailable" errors. You might want to wait a few days before downloading all the code. (Linux users should see below for a quicker way to download the code.)
 The [http://tortoisesvn.net/docs/release/TortoiseSVN_en/index.html TortoiseSVN manual] has information on [http://tortoisesvn.net/docs/release/TortoiseSVN_en/tsvn-dug-checkout.html checking out], as well as [http://tortoisesvn.net/docs/release/TortoiseSVN_en/tsvn-dug-update.html updating] and [http://tortoisesvn.net/docs/release/TortoiseSVN_en/tsvn-dug-patch.html creating patches].
 …
 (This is the read-only public SVN URL. If you have commit access, you need to use `http://svn.wildfiregames.com/svn/ps/trunk/` instead.)
 === Setting up the build environment ===
 The game must be compiled with Microsoft Visual C++. If you already have Visual C++ 2005 or 2008 installed, make sure you have SP1 and then continue. Otherwise, you can get the free Express edition:
 …
 === Running ===
 Run the game with F5 inside Visual Studio (assuming "pyrogenesis" is set as the startup project, which is default). If you want to run it outside the debugger, run `binaries/system/pyrogenesis_dbg.exe`.
 …
 === Keeping up to date ===
+After you've set everything up, the process for staying up to date is:
-After you've set everything up, the process for staying up to date is:
  * [http://tortoisesvn.net/docs/release/TortoiseSVN_en/tsvn-dug-update.html Update] the root directory of the checkout.
  * Close the solution in Visual Studio if you've got it open. Run `update-workspaces.bat` again. (This is only needed if any source files have been added or removed. If you forget to run this, you'll probably get build errors about missing symbols.)
 …
 == Linux ==
 This is much less streamlined than the process for Windows. But you're cooler than a Windows developer, so you should be able to cope.
  * Install various standard tools and development libraries:
   * GCC (at least 4.1, preferably 4.3)
   * Subversion
   * NASM
    * There is a [http://sourceforge.net/tracker/?func=detail&aid=2821249&group_id=6208&atid=106208 bug] in NASM 2.06 on x86_64, so you might want to try a different version if you get errors.
   * SDL
   * Boost
   * zlib
   * libpng
   * libxml2
   * OpenGL
   * OpenAL
   * libogg
   * libvorbis
   * cryptopp
   * !SpiderMonkey (1.6, threadsafe) (sometimes called libjs)
   * wxWidgets (probably called wxgtk on Linux) (optional, but required for the editor tools)
   * gamin (Linux only)
   * BFD (typically called something like binutils-dev) (Linux only)
   * enet
   * DevIL
   * and maybe some other things?
+   * GCC (at least 4.1, preferably 4.3)
+   * Subversion
+   * NASM
+     * There is a [http://sourceforge.net/tracker/?func=detail&aid=2821249&group_id=6208&atid=106208 bug] in NASM 2.06 on x86_64, so you might want to try a different version if you get errors.
+   * SDL
+   * Boost
+   * zlib
+   * libpng
+   * libxml2
+   * OpenGL
+   * OpenAL
+   * libogg
+   * libvorbis
+   * cryptopp
+   * !SpiderMonkey (1.6, threadsafe) (sometimes called libjs)
+   * wxWidgets (probably called wxgtk on Linux) (optional, but required for the editor tools)
+   * gamin (Linux only)
+   * BFD (typically called something like binutils-dev) (Linux only)
+   * enet
+   * DevIL
+   * and maybe some other things?
  * For '''Ubuntu''' the following might help: ''sudo apt-get install build-essential libsdl1.2-dev zlib1g-dev libpng12-dev libjpeg62-dev libgamin-dev nasm libwxgtk2.8-dev libboost-dev libboost-signals-dev libboost-filesystem-dev libopenal-dev libalut-dev libvorbis-dev libogg-dev libcrypto++-dev binutils-dev libnspr4-dev libdevil-dev libenet-dev libxml2-dev''
 …
  * `svn co http://svn.wildfiregames.com/public/ps/trunk/` (or `http://svn.wildfiregames.com/svn/ps/trunk/` if you have commit access)
   * '''Note:''' The SVN server is currently very busy, and is likely to return "503 Service Unavailable" errors. You might want to wait a few days before downloading all the code. Alternatively, download and extract http://os.wildfiregames.com/ps-snapshot-r6953.tar.gz (300MB) or http://os.wildfiregames.com/ps-snapshot-r6953.tar.7z (140MB, 7-Zip) then run `svn up`. (The snapshot requires Subversion 1.5 or higher. It will break badly if you try it on Windows.)
+   * '''Note:''' The SVN server is currently very busy, and is likely to return "503 Service Unavailable" errors. You might want to wait a few days before downloading all the code. Alternatively, download and extract http://os.wildfiregames.com/ps-snapshot-r6953.tar.gz (300MB) or http://os.wildfiregames.com/ps-snapshot-r6953.tar.7z (140MB, 7-Zip) then run `svn up`. (The snapshot requires Subversion 1.5 or higher. It will break badly if you try it on Windows.)
  * `( cd trunk/libraries/fcollada/src && make )`
  * `cd trunk/build/workspaces`
 …
  * `( cd ../../../binaries/system && ./pyrogenesis_dbg )`
+[[BR]]
+=== OS X ===
+Follow this steps to install under OS X:
+=== OS X ===
+ * Install Apple's XCode for your system : see your Mac OsX install DVD or go to [http://connect.apple.com Apple's Developer Connection Site][[BR]] This provides the necessary tools to compile programs.[[BR]] Note that for Leopard, '''it is mandatory to''' install XCode >= 3.1, as the tiff dependency won't compile either. On my DVD, Apple shipped only XCode 3.0, so I had to download 3.1 from the ADC site.
+Follow this steps to install under OS X:
+ * Install Apple's XCode for your system : see your Mac OsX install DVD or go to [http://connect.apple.com Apple's Developer Connection Site][[BR]]
+   This provides the necessary tools to compile programs.[[BR]]
+   Note that for Leopard, '''it is mandatory to''' install XCode >= 3.1, as the tiff dependency won't compile either. On my DVD, Apple shipped only XCode 3.0, so I had to download 3.1 from the ADC site.
+ * Install Macports : [http://www.macports.org/install.php MacPorts][[BR]]
+   This is the easiest way to install all the dependencies needed by 0ad.
+ * Install Macports : [http://www.macports.org/install.php MacPorts][[BR]] This is the easiest way to install all the dependencies needed by 0ad.
  * `sudo port install` the following packages :
   * boost
   * libsdl
   * spidermonkey
   * xercesc
   * wxWidgets
   * ffmpeg
   * libxml2
   * libdevil
   * libenet
+   * boost
+   * libsdl
+   * spidermonkey
+   * xercesc
+   * wxWidgets
+   * ffmpeg
+   * libxml2
+   * libdevil
+   * libenet
  * Now get the last revision of the game : `svn co http://svn.wildfiregames.com/public/ps/trunk/` (or `http://svn.wildfiregames.com/svn/ps/trunk/` if you have commit access)
 …
  * then compile the game :
   * `cd trunk/build/workspaces`
   * `./update-workspaces.sh` (you'll have to repeat this step each time a source file is added or removed)
   * `cd gcc`
   * `make -j3` (where `3` is the number of parallel builds to run, and could perhaps be one plus the number of CPU cores available)
   * ''' If you cannot manage to compile with the Apple's default compiler (gcc 4.0.1), you may try compiling with gcc 4.2 (recommanded) or 4.3 ''' (this worked for me a least) : see the [http://trac.wildfiregames.com/wiki/BuildInstructions#Compilingwithgcc4.2or4.3underOSX detailed section here under].  Note that gcc 4.1 failed to compile FCollada for me, so I don't recommand it
   * If you encounter any build errors, look for an existing bug report or report a new bug (I myself still get a last error, but it seems harmless).
+   * `cd trunk/build/workspaces`
+   * `./update-workspaces.sh` (you'll have to repeat this step each time a source file is added or removed)
+   * `cd gcc`
+   * `make -j3` (where `3` is the number of parallel builds to run, and could perhaps be one plus the number of CPU cores available)
+   * ''' If you cannot manage to compile with the Apple's default compiler (gcc 4.0.1), you may try compiling with gcc 4.2 (recommended) or 4.3 ''' (this worked for me a least) : see the [http://trac.wildfiregames.com/wiki/BuildInstructions#Compilingwithgcc4.2or4.3underOSX detailed section here under].  Note that gcc 4.1 failed to compile FCollada for me, so I don't recommand it
+   * If you encounter any build errors, look for an existing bug report or report a new bug (I myself still get a last error, but it seems harmless).
  * Finally, launch the game : ` cd ../../../binaries/system && ./pyrogenesis_dbg`
-[[BR]]
 ==== Compiling with gcc 4.2 or 4.3 under OS X ====
 For those who get weird errors, you can try compiling with gcc 4.2 or 4.3, which are not shipped with any version of Apple's XCode.  So you first have to get them from !MacPorts and then patch some system libraries (certainly not the better way to do it, but for now the game is targetted for developpers, so you can manage to do it :) ).
+ * `sudo port install gcc42 gcc43 gcc_select`[[BR]]
+   Select gcc 4.2 or 4.3 :
+   `sudo gcc_select mp-gcc42` or `sudo gcc_select mp-gcc43`[[BR]]
+ * `sudo port install gcc42 gcc43 gcc_select`[[BR]] Select gcc 4.2 or 4.3 : `sudo gcc_select mp-gcc42` or `sudo gcc_select mp-gcc43`[[BR]]
  * Take care that '''libdevil 1.6.8-rc2 (the version in macports) is not compatible with GCC 4.3''', you'll need to install 1.7.8. Get it from http://openil.sourceforge.net/download.php. Then extract the archive, and run ./configure, make, and sudo make install.[[BR]]
  * Right, you're almost ready to compile 0ad :
   * you need to patch Apple's OpenAL (/System/Library/Frameworks/OpenAL.Framework/alc.h : replace all ALCvoid by void, except first one which is a typedef).  Indeed, as Jan said, "C allows parameters typedefed to void, C++ does not; GCC >=4.2 are now strict about the error" (and will end to compilation error).
   * you'll then need to patch Macports IL (/opt/local/include/IL/il.h and ilu.h : replace all ILvoid by void, except typedefs).
+ * Right, you're almost ready to compile 0ad :
+   * you need to patch Apple's OpenAL (/System/Library/Frameworks/OpenAL.Framework/alc.h : replace all ALCvoid by void, except first one which is a typedef).  Indeed, as Jan said, "C allows parameters typedefed to void, C++ does not; GCC >=4.2 are now strict about the error" (and will end to compilation error).
+   * you'll then need to patch Macports IL (/opt/local/include/IL/il.h and ilu.h : replace all ILvoid by void, except typedefs).
  * Then, launch again the compilation starting from `./update-workspace.sh`
-[[BR]]
 === Known problems and solutions ===
  * If you get linker errors like '''`multiple definition of '(anonymous namespace)::_1'`''', particularly when using GCC 4.1, try running `./update-workspaces.sh --without-pch` and then `cd gcc; make clean` and rebuild.
 …
 make: *** [pyrogenesis] Error 2
 }}}
+  Actually, older versions of glibc doesn't support the stack-protection feature. So, until this is detected by the build system, you can hack it by removing the "-fstack-protector-all" line and the next line too from build/premake/premake.lua
- Actually, older versions of glibc doesn't support the stack-protection feature. So, until this is detected by the build system, you can hack it by removing the "-fstack-protector-all" line and the next line too from build/premake/premake.lua
-[[BR]]
 === Installing thread-safe !SpiderMonkey ===
 On Linux:
 …
 On '''Gentoo''', you could use the system library (with the `threadsafe` flag) instead:
  * `echo dev-lang/spidermonkey threadsafe >> /etc/portage/package.use`
  * `emerge -av spidermonkey`