Context Navigation

Changes between Version 278 and Version 279 of BuildInstructions

Timestamp:: Nov 12, 2015, 1:28:27 AM (8 years ago)
Author:: scythetwirler
Comment:: --

Legend:

: Unmodified
: Added
: Removed
: Modified

BuildInstructions

-              v278
+              v279
 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 ==
 …
  * 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 ==
 The main supported versions are:
  * Windows 10
  * Windows 8.1
 …
  * Windows 7
+The only supported IDEs are:
+If you want to develop, the only supported IDEs are:
  * Visual C++ 2013
 '''Important notes:'''
  * We have dropped support for older versions of Visual Studio when moving to C++11, see #2669.
  * XP and Vista are supported as targets, but not for installing Visual Studio 2013.
 …
 (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.)
+If you only wish to play the most cutting-edge version, this is all you have to do (other than [#Keepinguptodate Keeping up to date]). The executable will be located at `binaries/system/pyrogenesis.exe`.
 === Setting up the build environment ===
 The game must be compiled with Microsoft Visual C++. You can get the free Express edition here: [http://www.visualstudio.com/en-us/products/visual-studio-express-vs.aspx Visual Studio Express 2013]. Choose the version for "Windows Desktop". There is also the free [http://www.visualstudio.com/en-us/products/visual-studio-community-vs.aspx Community Edition], which has all the features of the Professional version for open source development.
 …
  * 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.)
  * Build again.
-[[br]]
 == Linux ==
 …
 To compile editing tools (enabled by default; pass the flag `--disable-atlas` to `update-workspaces.sh` to disable):
  * wxWidgets (packages are probably called wxgtk)
 To use shared system libraries instead of bundled copies (default) of libraries (pass the flag `--with-system-$COMPONENT` to `update-workspaces.sh` to use the non-bundled copy):
  * [https://developer.mozilla.org/docs/SpiderMonkey/31 SpiderMonkey 31] (`--with-system-mozjs31`)
  * [http://code.google.com/p/nvidia-texture-tools NVTT] (`--with-system-nvtt`)
+For a list of all options to `update-workspaces.sh` see [wiki:premake premake].
+For a list of all options to `update-workspaces.sh` see [wiki:premake].
 ==== Debian / Ubuntu ====
 …
     libxml2-dev subversion zlib1g-dev
 }}}
   * With these dependencies you have to run:
    * `./update-workspaces.sh --with-system-nvtt`
+   * With these dependencies you have to run:
+     * `./update-workspaces.sh --with-system-nvtt`
  * If you want to use a packaged **mozjs31**, available for example in [https://launchpad.net/~wfg/+archive/ubuntu/0ad.dev/+packages 0ad.dev PPA]:
    * you should replace `libnspr4-dev` with `libmozjs-31-dev` and run `update-workspace.sh` with `--with-system-mozjs31`.
  * On systems **earlier than Debian 8/jessie and Ubuntu 14.04/trusty**:
   * you should run `update-workspace.sh` with `--without-miniupnpc` if you don't have `libminiupnpc-dev` >= 1.6;
   * you should replace `libwxgtk3.0-dev` with `libwxgtk2.8-dev`;
+   * you should run `update-workspace.sh` with `--without-miniupnpc` if you don't have `libminiupnpc-dev` >= 1.6;
+   * you should replace `libwxgtk3.0-dev` with `libwxgtk2.8-dev`;
  * When not using system nvidia-texture-tools, `libnvtt-dev` can be omitted, but `cmake` is needed to build the bundled NVTT.
  * You can also use `libcurl4-openssl-dev` instead of `libcurl4-gnutls-dev` (it's not possible to install both at once), but [http://lintian.debian.org/tags/possible-gpl-code-linked-with-openssl.html note that openssl is not GPL compatible and the resulting binaries could not be redistributed].
 …
     libxml2-devel libwxgtku2.8-devel openal-soft-devel libicu-devel
 }}}
 ==== Fedora ====
 Install the dependencies with:
 …
     gloox-devel libicu-devel miniupnpc-devel'
 }}}
 ==== openSUSE ====
 Install the dependencies with:
 …
     gloox-devel libicu-devel miniupnpc-devel
 }}}
 Users of openSUSE 11.4 and later should install the wxWidgets-devel package instead of wxGTK-devel.
 …
 }}}
 === Getting the code ===
 A.D. is primarily developed on SVN. To checkout the latest code from SVN, run this command:
 …
 svn co http://svn.wildfiregames.com/public/ps/trunk/ 0ad
 }}}
 '''Note:''' Sometimes SVN stops before it has downloaded all files. You should check that it outputs something like `at revision rXXXX`. Otherwise run
 …
 svn up 0ad
 }}}
 '''Note:''' Make sure that the checkout directory doesn't contain special characters (spaces or non-ASCII characters)
 …
 }}}
 or
 {{{
 #!sh
 git clone https://gitlab.com/0ad/0ad.git
 }}}
 === Building ===
 Compile the code with:
 …
 make -j3
 }}}
  * '''-j3''' gives the number of parallel builds to run, and should typically be one plus the number of CPU cores available.
  * The '''Release''' mode builds (which are the default) are more optimised, but are harder to debug. Use `make config=debug` (and run `pyrogenesis_dbg`) if you need better debugging support. See [wiki:Debugging] for more details.
 …
 binaries/system/test
 }}}
 === Running ===
 If everything went well, compiling the code worked and all tests passed, it's finally time to run the game:
 …
 binaries/system/pyrogenesis
 }}}
 === Keeping up to date ===
 If you want to rebuild quickly after updating from SVN, you can usually get away with:
 …
 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.
 …
 If you want to create packages for a Linux distribution see the current [http://anonscm.debian.org/viewvc/pkg-games/packages/trunk/0ad/debian/ 0ad] and [http://anonscm.debian.org/viewvc/pkg-games/packages/trunk/0ad-data/debian/ 0ad-data] packages on OBS for examples (especially the `control` and `rules` files).
-[[BR]]
 == OS X ==
 The process on OS X is similar to Linux:
  * Obtain the command line tools:
   * 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 Lion 10.7.2 or earlier, you'll probably need to install Xcode to get the command line tools:
     * 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.
     * The latest version of Xcode is also available for free from the [http://www.apple.com/mac/app-store/ Mac 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 you want to build a distributable app bundle as described below, you will need Xcode.
   * '''Note:''' As of Mavericks (10.9) and Xcode 5, Apple [https://developer.apple.com/library/mac/releasenotes/DeveloperTools/RN-Xcode/xc5_release_notes/xc5_release_notes.html#//apple_ref/doc/uid/TP40001051-CH2-SW302 no longer supports] llvm-gcc, instead it is required to use clang. Additionally, the default C++ library is now libc++ instead of libstdc++. If you've upgraded and previously built the game, you should pass the `--force-rebuild` flag to `build-osx-libs.sh`.
+   * 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 Lion 10.7.2 or earlier, you'll probably need to install Xcode to get the command line tools:
+     * 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.
+     * The latest version of Xcode is also available for free from the [http://www.apple.com/mac/app-store/ Mac 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 you want to build a distributable app bundle as described below, you will need Xcode.
+   * '''Note:''' As of Mavericks (10.9) and Xcode 5, Apple [https://developer.apple.com/library/mac/releasenotes/DeveloperTools/RN-Xcode/xc5_release_notes/xc5_release_notes.html#//apple_ref/doc/uid/TP40001051-CH2-SW302 no longer supports] llvm-gcc, instead it is required to use clang. Additionally, the default C++ library is now libc++ instead of libstdc++. If you've upgraded and previously built the game, you should pass the `--force-rebuild` flag to `build-osx-libs.sh`.
  * As of Alpha 18, the game uses SpiderMonkey 31 which requires a Python 2.7 version later than 2.7.3. If you're on Mountain Lion (10.8) or earlier, you will need to first update your Python installation with the latest 2.7.x installer from [https://www.python.org/downloads/release/python-279/ here].
  * Obtain CMake:
   * You can download a prebuilt OS X package [http://www.cmake.org/cmake/resources/software.html here].
   * If prompted, install the CMake command line tools to the default location.
   * '''Note:''' Recent versions have no installer, so after copying the app bundle to '''Applications''', you need to run CMake with elevated permissions to install the command line tools. From the terminal:
     {{{
+   * You can download a prebuilt OS X package [http://www.cmake.org/cmake/resources/software.html here].
+   * If prompted, install the CMake command line tools to the default location.
+   * '''Note:''' Recent versions have no installer, so after copying the app bundle to '''Applications''', you need to run CMake with elevated permissions to install the command line tools. From the terminal:
+{{{
 #!sh
  sudo "/Applications/CMake.app/Contents/bin/cmake-gui" --install
     }}}
   * If the install command fails, you can manually add the following line to the end of `/etc/paths`:
     {{{
+}}}
+   * If the install command fails, you can manually add the following line to the end of `/etc/paths`:
+{{{
 /Applications/CMake.app/Contents/bin
     }}}
+}}}
  * Obtain the game's source code:
   * 0 A.D. is primarily developed on SVN. To checkout the latest code from SVN, run this command:
    {{{
+   * 0 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
    }}}
    '''Note:''' 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
    }}}
   * There is also a Git mirror, which may be slightly less up-to-date but usually offers faster downloads. To use the Git mirror, use this command instead:
    {{{
+}}}
+   * There is also a Git mirror, which may be slightly less up-to-date but usually offers faster downloads. To use the Git mirror, use this command instead:
+{{{
 #!sh
 git clone https://github.com/0ad/0ad.git
    }}}
+}}}
 Now you have two options:
 === 1. Build the game for your personal use ===
  * Run [source:/ps/trunk/libraries/osx/build-osx-libs.sh libraries/osx/build-osx-libs.sh], the OS X libraries build script, this will download and build the game's dependencies (except CMake, see above). This script will take some time to finish when first run, after that it will reuse the old build.
  {{{
+{{{
 #!sh
 cd libraries/osx
 ./build-osx-libs.sh -j3
  }}}
   * '''-j3''' gives the number of parallel builds to run, and should typically be one plus the number of CPU cores available.
   * To force a rebuild for some reason, e.g. the SVN folder is moved or Xcode / OS X is upgraded, pass in the `--force-rebuild` flag.
+}}}
+   * '''-j3''' gives the number of parallel builds to run, and should typically be one plus the number of CPU cores available.
+   * To force a rebuild for some reason, e.g. the SVN folder is moved or Xcode / OS X is upgraded, pass in the `--force-rebuild` flag.
  * Next, to build the game on the command line, use the following commands:
    {{{
+{{{
 #!sh
 cd 0ad/build/workspaces
 …
 cd gcc
 make -j3
    }}}
   * The '''Release''' mode builds (which are the default) are more optimised, but are harder to debug. Use `make config=debug` (and run `pyrogenesis_dbg`) if you need better debugging support. See [wiki:Debugging] for more details.
   * If you encounter any build errors, review the [http://trac.wildfiregames.com/report existing bug reports], check the [#Knownproblemsandsolutions known problems section] or please file a [http://trac.wildfiregames.com/newticket new bug in the tracker].
+}}}
+   * The '''Release''' mode builds (which are the default) are more optimised, but are harder to debug. Use `make config=debug` (and run `pyrogenesis_dbg`) if you need better debugging support. See [wiki:Debugging] for more details.
+   * If you encounter any build errors, review the [http://trac.wildfiregames.com/report existing bug reports], check the [#Knownproblemsandsolutions known problems section] or please file a [http://trac.wildfiregames.com/newticket new bug in the tracker].
  * Or if you have Xcode 4 installed, you can open `build/workspaces/xcode4/pyrogenesis.xcworkspace` (see discussion on this [http://www.wildfiregames.com/forum/index.php?showtopic=15511&st=160#entry261743 here]).
  * Run the automated tests to verify that everything works as expected like this:
 …
 === 2. Build the game as a distributable app bundle ===
  * You will need Xcode installed (for its SDKs)
  * Open [source:/ps/trunk/build/workspaces/build-osx-bundle.sh build/workspaces/build-osx-bundle.sh] and read the comments. You will need to change a few settings depending on your version of OS X, Xcode, etc.
  * Run `build-osx-bundle.sh`, the bundle build script, which will download and build the game's dependencies for the appropriate SDK, build the game's source code, package the mod data, and set up the app bundle info.
  {{{
+{{{
 #!sh
 cd build/workspaces
 ./build-osx-bundle.sh -j3
  }}}
+}}}
  * '''-j3''' gives the number of parallel builds to run, and should typically be one plus the number of CPU cores available.
  * When it's finished, there should be a complete '''0ad app''' bundle in `build/workspaces`. You can open it by double-clicking its icon in Finder or with the `open 0ad.app` command in the terminal.
 …
    * Package the bundle inside a compressed DMG with background image, for easy distribution (see ReleaseProcess).
-[[BR]]
 == BSD ==
 '''Note: The *BSD support 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 (names probably differ depending on the BSD variant):[[BR]]
+   Install commands for the variants are provided below.
+ * Install the following ports or packages (names probably differ depending on the BSD variant):[[BR]] Install commands for the variants are provided below.
    * boost-libs
    * cmake
 …
  * You probably need to run pyrogenesis with `LD_PRELOAD=/usr/local/lib/libogg.so.6.2:/usr/local/lib/libvorbis.so.8.0` (see #1463).
-[[BR]]
 == Known problems and solutions ==
  * None currently.