Context Navigation

Changes between Version 172 and Version 173 of BuildInstructions

Timestamp:: May 26, 2012, 9:36:21 PM (12 years ago)
Author:: mackwic
Comment:: adding premake in dependency + some visual changes

Legend:

: Unmodified
: Added
: Removed
: Modified

BuildInstructions

-              v172
+              v173
 [[TOC]]
+'''NOTE: The build system has changed since Alpha 7 and the instructions are now subtly different. If you want to build Alpha 7 or previous versions of the game, use the [http://trac.wildfiregames.com/wiki/BuildInstructions?version=140 older version] of this page.'''
+This page describes how to get the very latest unstable version of the code. Unless you want to actively follow and contribute to development, you probably want the [LatestRelease latest relatively-stable release] instead.
+[[br]]
+    **NOTE: The build system has changed since Alpha 7 and the instructions are now subtly different.**
+    **If you want to build Alpha 7 or previous versions of the game, use the older version of this page.**
+[[br]]
+This page describes how to get the very latest unstable version of the code. Unless you want to actively follow and contribute to development, **you probably want the [wiki:LatestRelease latest relatively-stable release] instead.**
 The current release of the game is aimed at developers and not at 'normal' users. As such, the following instructions assume a reasonable level of technical proficiency. If you encounter difficulties, please post on the [http://www.wildfiregames.com/forum/index.php?showforum=312 forum].
+[[br]]
 == General prerequisites ==
 …
  * An adequately high-spec computer:
   * At least 5GB of free disk space
   * Preferably at least 1GB of RAM for compiling
   * Intel x86-compatible CPU, 32- or 64-bit, multiple cores will help compile faster
   * Modern graphics hardware is also recommended, though the game can run (slowly) on fairly old devices (!GeForce 4, Intel 945GM, etc)
+   * At least 5GB of free disk space
+   * At least 1GB of RAM for compiling
+   * Intel x86-compatible CPU, 32- or 64-bit
+   * Modern graphics hardware is also recommended, though the game can run (slowly) on fairly old devices (!GeForce 4, Intel 945GM, etc)
  * One of the following operating systems:
   * [#Windows Windows] (2000 or newer)
   * [#Linux Linux]
   * [#OSX OS X] (currently 10.6 or newer)
   * [#FreeBSD FreeBSD] (only experimental support at this time)
+   * [#Windows Windows] (2000 or newer)
+   * [#Linux Linux]
+   * [#OSX OS X] (currently 10.6 or newer)
+   * [#FreeBSD FreeBSD] (only experimental support at this time)
  * Up-to-date system software (Windows service packs, graphics driver updates, etc)
  * Some technical proficiency. We try to make the build process as smooth and painless as possible, but it's designed to be followed by programmers - if you just want to play the game, wait for a pre-packaged installer instead.
+[[br]]
 == Windows ==
+Windows 7, Vista and XP are the main supported versions; 2000 should work too but is rarely tested. Visual C++ 2010 and 2008 are supported. Visual C++ 2005 may also work given a sufficiently modern Platform SDK. Only 32-bit builds are supported (though they can be compiled and run on 64-bit Windows). We have noticed occasional trouble with the free Express Editions; if possible, please consider acquiring the full version (e.g. via university programs). In particular, failures of the built-in self-test test_wdbg_sym.h seem to occur with VC2008 EE but not VC2008 nor VC2010 (c.f. #884).
+The main supported OS are :
+ * Windows 7
+ * Windows Vista
+ * Windows XP
+Windows 2000 should work too but is rarely tested.
+The main supported IDE are :
+ * Visual C++ 2010 and 2008
+ * Code Blocks
+{{{
+#!comment
+Code Blocks is guessed from 0ad/build/workspaces/codeblocks
+What about the support of Eclipse ?
+}}}
+NOTE : Visual C++ 2005 may work with a sufficiently modern Platform SDK.
+NOTE : Only 32-bit builds are supported (though they can be compiled and run on 64-bit Windows)
+NOTE : We have noticied occasional trouble with the free Express Editions; please consider acquire the full version (e.g. via university programs) or using free IDE like Code Blocks or Eclipse CDT.
+In particular, failures of the built-in self-test test_wdbg_sym.h seem to occur with VC2008 EE but not VC2008 nor VC2010 (c.f. #884).
 === Acquiring the code ===
 …
  * If you have the old VC++ 2005 Express, you need to install the separate [http://social.msdn.microsoft.com/forums/en-US/Vsexpressvc/thread/c5c3afad-f4c6-4d27-b471-0291e099a742/ Platform SDK] (steps 1-3).
 The Visual Studio project/solution files are automatically generated from the source files:
 …
  * Open `build/workspaces/vc2010/pyrogenesis.sln`. (Use the `vc2005` directory for VC++ 2005 or the `vc2008` directory for VC++ 2008.)
 === Optimised builds ===
 Make sure to select the "Release" configuration to build an optimised, more playable version of the game (the target will be `pyrogenesis.exe`). The "Debug" configuration can be more useful for debugging but has significantly reduced performance (the target will be `pyrogenesis_dbg.exe`). Both "Release" and "Debug" builds include debug symbols, see [wiki:DebuggingOnWindows Debugging on Windows] for more details on debugging.
+=== Type of builds ===
+Make sure to select the "Release" configuration to build a more playable version of the game (the target will be `pyrogenesis.exe`). The "Debug" configuration can be more useful for debugging but has significantly reduced performance (the target will be `pyrogenesis_dbg.exe`). Both "Release" and "Debug" builds include debug symbols, see [wiki:DebuggingOnWindows Debugging on Windows] for more details on debugging.
 Now you should be able to build the code from within Visual Studio, using "Build Solution" (F7).
 …
  * Build again.
+[[br]]
 == Linux ==
 A.D. should work on any reasonably modern Linux distro, on x86 and x86_64 (amd64). The details depend on exactly which distro you use.
 === Dependencies ===
 First you need to install various standard tools and development libraries:
  * Boost
  * CMake (only needed if you use bundled NVTT)
+ * premake4
  * Gamin (FAM should work too, but is considered deprecated)
  * GCC (at least 4.0, preferably 4.3 or later)
 …
 ==== Debian (wheezy or later) / Ubuntu (12.04 or later) ====
 Install the dependencies with:
+{{{
+#!html
+<pre class="wiki" style="white-space: pre-wrap">
+sudo apt-get install build-essential libboost-dev libboost-filesystem-dev libboost-signals-dev libcurl4-gnutls-dev libenet-dev libgamin-dev libjpeg-dev libmozjs185-dev libnvtt-dev libogg-dev libopenal-dev libpng-dev libsdl-dev libvorbis-dev libwxgtk2.8-dev libxcursor-dev libxml2-dev subversion zlib1g-dev
+</pre>
+{{{
+#!sh
+sudo apt-get install build-essential libboost-dev libboost-filesystem-dev   \
+    libboost-signals-dev libcurl4-gnutls-dev libenet-dev libgamin-dev       \
+    libjpeg-dev libmozjs185-dev libnvtt-dev libogg-dev libopenal-dev        \
+    libpng-dev libsdl-dev libvorbis-dev libwxgtk2.8-dev libxcursor-dev      \
+    libxml2-dev premake subversion zlib1g-dev
 }}}
  * You can also use `libcurl4-openssl-dev` instead of `libcurl4-gnutls-dev` (it's not possible to install both at once), but note that openssl is not GPL compatible and the resulting binaries could not be redistributed.
 …
 ==== Mandriva ====
 Install the dependencies with:
 {{{
 #!html
+<pre class="wiki" style="white-space: pre-wrap">
+urpmi gcc-c++ python subversion zip cmake boost-devel fam-devel libcurl-devel libjpeg-devel libpng-devel libvorbis-devel libxml2-devel libwxgtku2.8-devel openal-soft-devel
+</pre>
+#!sh
+urpmi gcc-c++ python subversion zip cmake premake boost-devel fam-devel     \
+    libcurl-devel libjpeg-devel libpng-devel libvorbis-devel libxml2-devel  \
+    libwxgtku2.8-devel openal-soft-devel
 }}}
 ==== Fedora ====
 Install the dependencies with:
 {{{
 #!html
+<pre class="wiki" style="white-space: pre-wrap">
+su -c 'yum -y install gcc-c++ python subversion zip cmake boost-devel fam-devel libcurl-devel libjpeg-devel libpng-devel libvorbis-devel libxml2-devel openal-soft-devel pkgconfig SDL-devel wxGTK-devel'
+</pre>
+#!sh
+su -c 'yum -y install gcc-c++ python premake subversion zip cmake boost-devel \
+    fam-devel libcurl-devel libjpeg-devel libpng-devel libvorbis-devel        \
+    libxml2-devel openal-soft-devel pkgconfig SDL-devel wxGTK-devel'
 }}}
 ==== OpenSUSE ====
 Install the dependencies with:
 {{{
 #!html
+<pre class="wiki" style="white-space: pre-wrap">
+sudo zypper install gcc-c++ python subversion zip cmake boost-devel fam-devel libcurl-devel libjpeg-devel libpng-devel libvorbis-devel libxml2-devel openal-soft-devel pkg-config wxGTK-devel libSDL-devel
+</pre>
+#!sh
+sudo zypper install gcc-c++ python premake subversion zip cmake boost-devel \
+    fam-devel libcurl-devel libjpeg-devel libpng-devel libvorbis-devel      \
+    libxml2-devel openal-soft-devel pkg-config wxGTK-devel libSDL-devel
 }}}
 …
 === Getting the code ===
 A.D. is primarily developed on SVN. To checkout the latest code from SVN, run this command:
 {{{
+#!sh
 svn co http://svn.wildfiregames.com/public/ps/trunk/ 0ad
 }}}
+Sometimes SVN stops before it has downloaded all files. You should check that it outputs something like `at revision rXXXX`. Otherwise run
+{{{
+Note : Sometimes SVN stops before it has downloaded all files. You should check that it outputs something like `at revision rXXXX`. Otherwise run
+{{{
+#!sh
 svn up 0ad
 }}}
 …
 {{{
+#!sh
 git clone https://github.com/0ad/0ad.git
 }}}
 === Building ===
 Compile the code with:
 {{{
 #!sh
 …
 === Testing ===
 Run the automated tests to verify that everything works as expected like this:
 {{{
+#!sh
 binaries/system/test
 }}}
 === Running ===
 If everything went well, compiling the code worked and all tests passed, it's finally time to run the game:
 {{{
+#!sh
 binaries/system/pyrogenesis
 }}}
 === Keeping up to date ===
 If you already checked out the code and only want to update and rebuild it, you may find it helpful to save the lines below to a script called e.g. `rebuild.sh`, place it in your 0ad directory, make it executable and run it.
 …
 If you just edited one source code file and want to rebuild, you can usually get away with:
 {{{
 make -j3
 …
 If you want to rebuild quickly after updating from SVN, you can usually get away with:
 {{{
 #!sh
 …
 make -j3
 }}}
 If the `make` line gives errors, you may need to run `make clean` before it. If the `update-workspaces.sh` gives errors, you may need to run `clean-workspaces.sh` before it.
+== Creating Linux packages ==
+If you want to create packages for a Linux distribution, see the current [https://build.opensuse.org/package/files?package=0ad&project=games 0ad] and [https://build.opensuse.org/package/files?package=0ad-data&project=games 0ad-data] packages on OBS for examples (especially the `.spec` and `debian.rules` files).
+[[br]]
 == OS X ==
 …
  * If you're using Lion 10.7.3 or later, Apple has made their ''Command Line Tools for Xcode'' package freely available, as a separate download. '''It does not include or require Xcode.''' If you don't want the Xcode IDE, it's recommended to install only this package from [https://developer.apple.com/downloads/index.action Apple Developer Downloads]. You need a free Apple ID to access the download. If you already have Xcode 4.3+, you can download the command line tools from the [https://developer.apple.com/library/IOs/#recipes/xcode_help-documentation_preferences/DownloadingandInstallingXcodeComponents/DownloadingandInstallingXcodeComponents.html download preferences].
  * If you're using Snow Leopard or Lion 10.7.2 or earlier, you'll probably need to install Xcode to get the command line tools (or you can try [https://github.com/kennethreitz/osx-gcc-installer/ OSX GCC Installer]):
     * If available, use your Mac OS X install DVD which saves downloading 1.72+ GB.
     * Visit [https://developer.apple.com/downloads/index.action Apple Developer Downloads] (logging in with your free Apple ID) and download the latest Xcode version for your OS. Version 4.x is required for Lion, while version 3.x is required for Snow Leopard. It's very important you install the correct version.
     * The latest version of Xcode is also available for free from the [http://www.apple.com/mac/app-store/ Mac App Store], you'll need Snow Leopard 10.6.6 or later to access the App Store. ''Note: if you download the app, it is only the installer for Xcode. You need to open it and run the "Install Xcode" app.''
+   * If available, use your Mac OS X install DVD which saves downloading 1.72+ GB.
+   * Visit [https://developer.apple.com/downloads/index.action Apple Developer Downloads] (logging in with your free Apple ID) and download the latest Xcode version for your OS. Version 4.x is required for Lion, while version 3.x is required for Snow Leopard. It's very important you install the correct version.
+   * The latest version of Xcode is also available for free from the [http://www.apple.com/mac/app-store/ Mac App Store], you'll need Snow Leopard 10.6.6 or later to access the App Store. ''Note: if you download the app, it is only the installer for Xcode. You need to open it and run the "Install Xcode" app.''
  * Install [http://www.macports.org/install.php MacPorts]. This is the easiest way to install all the dependencies needed by the game.
  * `sudo port install` the following packages :
 …
    * wxWidgets-devel (required for building Atlas, only the 2.9.x branch will work on 64-bit Macs)
    * subversion (the default version on 10.5 seems to cause checksum mismatch errors)
+Run the fdollowing command in a shell :
+{{{
+#!sh
+sudo port install boost cmake libenet libsdl libvorbis libxml2 curl wxWidgets-devel subversion
+}}}
  * Now follow the [#Gettingthecode same instructions] as for Linux above, starting from the `svn co`.
  * Newer versions of Xcode no longer include the command line tools by default, you need to install them as described above. Additionally, the command line tools package no longer includes GCC but it does include LLVM-GCC which is compatible. If you get errors during the build like "C compiler cannot create executables" then you probably have the newer command line tools with LLVM. The following command should fix it:
+ {{{
+{{{
+#!sh
  export CC=gcc CXX=g++
+ }}}
+}}}
 === Compiling with GCC 4.2 or 4.3 under OS X ===
+If you get errors compiling with OS X's default version of GCC (4.0.1), you can try compiling with GCC 4.2 or 4.3. On Snow Leopard, running
+{{{
+If you get errors compiling with OS X's default version of GCC (4.0.1), you can try compiling with GCC 4.2 or 4.3. On Snow Leopard, running
+{{{
+#!sh
 export CXX=/usr/bin/g++-4.2
 }}}
 before compiling the game may be sufficient. Leopard does not ship with a recent version of GCC, so you first have to get them from !MacPorts and then patch some system libraries:
+ * `sudo port install gcc42 gcc43 gcc_select`
+ * Select GCC 4.2 or 4.3: `sudo gcc_select mp-gcc42` or `sudo gcc_select mp-gcc43`
+{{{
+#!sh
+sudo port install gcc42 gcc43 gcc_select`
+}}}
+ * Select GCC 4.2 or 4.3:
+{{{
+#!sh
+sudo gcc_select mp-gcc42
+}}}
+or
+{{{
+#!sh
+sudo gcc_select mp-gcc43
+}}}
  * You may need to patch Apple's OpenAL (`/System/Library/Frameworks/OpenAL.Framework/Headers/alc.h`: replace all `ALCvoid` by `void`, except the first one which is a `typedef`). (GCC >=4.2 is stricter about parameters invalidly typedefed to void in C++.)
 …
 == FreeBSD ==
 '''Note: this is a work in progress and should be considered experimental. That means don't try it unless you "know what you're doing" :)'''
  * Install the following ports or packages (using `pkg_add -r`):
+  * sdl
+  * boost-libs
+  * png
+  * execinfo
+  * libxml2
+  * libGL
+  * openal
+  * zip
+  * libogg
+  * libvorbis
+  * curl
+  * gamin
+  * cmake
+  * wxgtk2-unicode - required to build Atlas tools
+  * subversion - note the latest version for 8.2 Release is 1.6
+  * Note: GCC 4.2.1 and zlib should already be installed by default
+   * sdl
+   * boost-libs
+   * png
+   * execinfo
+   * libxml2
+   * libGL
+   * openal
+   * zip
+   * libogg
+   * libvorbis
+   * curl
+   * gamin
+   * cmake
+   * wxgtk2-unicode - required to build Atlas tools
+   * subversion - note the latest version for 8.2 Release is 1.6
+   * Note: GCC 4.2.1 and zlib should already be installed by default
+{{{
+#!sh
+pkg_add -r adl boots-libs png execinfo libxml2 libGl openal zip libogg  \
+    libvorbis curl gamin cmake premake wxgetk2-unicode subversion
+}}}
  * Obtain the game's source code as [#Gettingthecode described above] for Linux.
  * TODO: Fix missing ecvt() and get premake to generate a proper build/gmake.unix/Makefile, or maybe create a build/gmake.bsd/? (the only difference is it tries to link libdl, which doesn't exist on FreeBSD)
  * If building Atlas, you need to set the `WX_CONFIG` variable, because `wx-config` has a different name on FreeBSD. For example, you'd run this command if you built the wxGTK 2.8 package with unicode support:
 {{{
+#!sh
 export WX_CONFIG=wxgtk2u-2.8-config
 }}}
    if not correct, you will get errors about missing "wx/*.h" includes. You can skip building Atlas altogether (and the wxWidgets dependency) by later passing the `--disable-atlas` option to `update-workspaces.sh`.
   * You'll have to set this variable every time you run `update-workspaces.sh`, so it may be most convenient to put these commands into another shell script.
+   * You'll have to set this variable every time you run `update-workspaces.sh`, so it may be most convenient to put these commands into another shell script.
  * Note: FreeBSD's `make` command is actually Berkeley [http://www.freebsd.org/cgi/man.cgi?query=make make], which is similar to but different than GNU make. Our build scripts will detect if you're on FreeBSD and use the `gmake` command instead. If for some reason this isn't correct, you can set the `MAKE` environment variable with the path and name of the correct GNU make.
  * Follow the [#Building build] instructions above for Linux.
 …
 }}}
    then you are likely using a build directory with spaces in its path. !SpiderMonkeys build system isn't designed to cope with spaces in the source path (see #916). Rename your build directory so that it doesn't contain any spaces.
-== Creating Linux packages ==
-If you want to create packages for a Linux distribution, see the current [https://build.opensuse.org/package/files?package=0ad&project=games 0ad] and [https://build.opensuse.org/package/files?package=0ad-data&project=games 0ad-data] packages on OBS for examples (especially the `.spec` and `debian.rules` files).