Changes between Version 397 and Version 398 of BuildInstructions

Timestamp:

Feb 20, 2021, 11:14:48 PM (3 years ago)

Author:

thedwarf

Comment:

--

BuildInstructions

@@ -22 +22 @@
 
 == Introduction ==
-
 The development environment for 0 A.D. is comprised of three layers. Each goes on top of the previous:
 
-1. Libraries.
-2. Workspaces.
-3. Source code.
+ 1. Libraries.
+ 1. Workspaces.
+ 1. Source code.
 
 Libraries are external dependencies (such as SpiderMonkey). For Windows and Linux, the script to create or update the Workspaces also handles installation and updating of libraries. For macOS, the `libraries/osx/build-osx-libs.sh` script should be used instead.
@@ -54 +53 @@
 
 === Getting the code ===
-
 See [wiki:BuildInstructionsGettingTheCode Getting the Code].
 
@@ -86 +84 @@
 
 === Building Windows dependencies ===
-
 By default windows come with prebuilt libraries but you might want to rebuild them yourself, to do so follow the instructions at BuildingWindowsDependencies.
 
@@ -171 +168 @@
     gloox-devel libicu-devel miniupnpc-devel fmt-devel
 }}}
-
-* To submit a patch for review via arcanist ([wiki:Phabricator Phabricator]), php is needed:  `dnf install php-cli php-json php-xml`.
+ * To submit a patch for review via arcanist ([wiki:Phabricator]), php is needed:  `dnf install php-cli php-json php-xml`.
 
 ==== openSUSE ====
@@ -184 +180 @@
     gloox-devel libicu-devel miniupnpc-devel libfmt-devel
 }}}
-
 ==== !ArchLinux/Manjaro ====
 {{{
@@ -192 +187 @@
     python2 rust sdl2 subversion wxgtk3 zip zlib
 }}}
-
 ==== Solus ====
 {{{
@@ -198 +192 @@
 sudo eopkg install libboost-devel curl-devel enet-devel gloox-devel libicu-devel libogg-devel libpng-devel libsodium-devel libvorbis-devel libxml2-devel miniupnpc-devel openal-soft-devel mesalib-devel sdl2-devel zlib-devel wxwidgets-devel libgnutls-devel fmt-devel
 }}}
-
 ==== Slackware ====
-
 After installing the dependencies for your particular version, you can build **0 A.D.** from the [#Gettingthecode svn code] using the instructions from the [#Building Building] section.
 
@@ -210 +202 @@
 
  * enet
- * fmt
- * gloox
+ * fmt^1^
+ * gloox^2^
  * libsodium
  * miniupnpc
@@ -219 +211 @@
 
 Required to build Atlas:
+
  * wxGTK3 (install/build this first, required by wxPython3)
  * wxPython3
@@ -225 +218 @@
 
 Default 14.2 packages:
+
 {{{
 a/sed-4.2.2-x86_64-1.txz
@@ -241 +235 @@
 x/mesa-11.2.2-x86_64-1.txz
 }}}
-
 Upgraded packages:
+
 {{{
 OpenAL-1.18.1-x86_64-1alien.txz
@@ -262 +256 @@
 zlib-1.2.11-x86_64-1_slack14.2.txz
 }}}
-
 Special packages:
+
 {{{
 gloox-1.0.24-x86_64-1_SBo.tgz
 kernel-headers-4.4.157-x86-1.txz
 }}}
-
-Notes:
-
-Gloox 1.0.24 was created using src2pkg or this [https://slackbuilds.org/repository/14.2/libraries/gloox/ Slackbuild]. If using the slackbuild script open the Slackbuild script and change version from 1.0.13 to 1.0.24 and compile with this [https://camaya.net/download/gloox-1.0.24.tar.bz2 tarball].
+Notes:[[BR]]^1^Gloox 1.0.24 was created using src2pkg or this [https://slackbuilds.org/repository/14.2/libraries/gloox/ Slackbuild]. If using the slackbuild script open the Slackbuild script and change version from 1.0.13 to 1.0.24 and compile with this [https://camaya.net/download/gloox-1.0.24.tar.bz2 tarball].
+
+^2^Fmt will need to be built using src2pkg from https://github.com/fmtlib/fmt/releases/
 
 Kernel headers must match your kernel version.
@@ -277 +270 @@
 '''''Slackware-current'''''
 
-Get the updated build scripts from:
-http://ponce.cc/slackware/testing/0ad/
-http://ponce.cc/slackware/testing/0ad-data/
-
-Make the following modifications to both 0ad.SlackBuild and 0ad-data.SlackBuild build scripts:
-tar xvf $CWD/$PRGNAM-$VERSION-$RELEASE-unix-build.tar.xz
-cd $PRGNAM-$VERSION-$RELEASE
-chown -R root:root .
-
-tar xvf $CWD/$PRGNAM-$VERSION-$RELEASE-unix-build.tar.xz
-# cd $PRGNAM-$VERSION-$RELEASE
-chown -R root:root .
-
+Get the updated build scripts from: http://ponce.cc/slackware/testing/0ad/ http://ponce.cc/slackware/testing/0ad-data/
+
+Make the following modifications to both 0ad.[wiki:SlackBuild] and 0ad-data.[wiki:SlackBuild] build scripts: tar xvf $CWD/$PRGNAM-$VERSION-$RELEASE-unix-build.tar.xz cd $PRGNAM-$VERSION-$RELEASE chown -R root:root .
+
+tar xvf $CWD/$PRGNAM-$VERSION-$RELEASE-unix-build.tar.xz # cd $PRGNAM-$VERSION-$RELEASE chown -R root:root .
 
 ==== CentOS ====
-
 Discussion of installing on //CentOS 7// can be found on the forums [https://wildfiregames.com/forum/index.php?/topic/24985-installation-on-centos-7 here].
 
 **Note:** The advice below is derived from installing in a Virtual Machine with //CentOS 7// 64-bit minimally installed. If you have //CentOS 6// (or earlier), the following steps may not be possible. Installation on a physical machine, a machine with more stuff already installed upon it, or a machine that is 32-bit, may differ slightly.
 
-1. Firstly, you will need to enable the "Extra Packages for Enterprise Linux" (or "EPEL") repository (if you haven't already). You can do this by running (as root/via sudo)
-   {{{ #!sh
-   yum install epel-release
-   }}}
-
-2. Install some auxiliary packages. These are not dependencies of 0 A.D. itself, but are necessary to run update_workspaces.sh successfully. They might already be installed on your system:
-   {{{ #!sh
-   yum install bzip2 patch
-   }}}
-
-3. Install the 0 A.D. dependencies that are available directly from repos:
-   {{{ #!sh
-   yum install cmake gcc-c++ enet-devel libglvnd-devel gloox-devel libicu-devel \
-        libogg-devel libpng-devel libsodium-devel libvorbis-devel libxml2-devel \
-        miniupnpc-devel openal-soft-devel subversion wxGTK3-devel zlib-devel SDL2-devel
-   }}}
-
-4. Acquire a sufficiently recent version of //libcurl//:
+ 1. Firstly, you will need to enable the "Extra Packages for Enterprise Linux" (or "EPEL") repository (if you haven't already). You can do this by running (as root/via sudo) {{{ #!sh yum install epel-release }}}
+
+ 2. Install some auxiliary packages. These are not dependencies of 0 A.D. itself, but are necessary to run update_workspaces.sh successfully. They might already be installed on your system: {{{ #!sh yum install bzip2 patch }}}
+
+ 3. Install the 0 A.D. dependencies that are available directly from repos: {{{ #!sh yum install cmake gcc-c++ enet-devel libglvnd-devel gloox-devel libicu-devel \ libogg-devel libpng-devel libsodium-devel libvorbis-devel libxml2-devel \ miniupnpc-devel openal-soft-devel subversion wxGTK3-devel zlib-devel SDL2-devel }}}
+
+ 4. Acquire a sufficiently recent version of //libcurl//:
    * From this site: https://mirror.city-fan.org/ftp/contrib/libraries/, download the two files that satisfy one of the following patterns:
-     - `libssh2-{version}.cf.rhel7.{arch}.rpm`
-     - `libssh2-devel-{version}.cf.rhel7.{arch}.rpm`
+     * `libssh2-{version}.cf.rhel7.{arch}.rpm`
+     * `libssh2-devel-{version}.cf.rhel7.{arch}.rpm`
    * From this site: https://mirror.city-fan.org/ftp/contrib/sysutils/Mirroring/, download the three files that satisfy one of the following patterns:
-     - `curl-{version}.cf.rhel7.{arch}.rpm`
-     - `libcurl-{version}.cf.rhel7.{arch}.rpm`
-     - `libcurl-devel-{version}.cf.rhel7.{arch}.rpm`
-   * Install some dependencies from repos:
-     {{{ #!sh
-     yum install nss-devel libnghttp2 libpsl libmetalink
-     }}}
-   * Install dependencies from downloaded packages.
-     [[BR]][[BR]]
-     **Note:** This will replace the version of //libssh2// that is provided by the //CentOS// official repos. This is necessary as the version of //libcurl// we're installing needs a more up-to-date version than what the official repos can provide. As the packages we've acquired are compiled as to be interoperable with //CentOS// systems, this shouldn't cause any problems with other programs installed on your system.
-     [[BR]][[BR]]
-     Install the `libssh2-*` and `libssh2-devel-*` packages using `rpm -Uvh`. For example:
-     {{{ #!sh
-     rpm -Uvh libssh2-1.8.0-8.0.cf.rhel7.x86_64.rpm libssh2-devel-1.8.0-8.0.cf.rhel7.x86_64.rpm
-     }}}
-   * Install the updated //curl// packages (`curl-*`, `libcurl-*` and `libcurl-devel-*`) using `rpm -Uvh`. For example:
-     {{{ #!sh
-     rpm -Uvh curl-7.61.1-3.0.cf.rhel7.x86_64.rpm libcurl-7.61.1-3.0.cf.rhel7.x86_64.rpm libcurl-devel-7.61.1-3.0.cf.rhel7.x86_64.rpm
-     }}}
-
-5. Acquire a sufficiently recent version of //boost//:
+     * `curl-{version}.cf.rhel7.{arch}.rpm`
+     * `libcurl-{version}.cf.rhel7.{arch}.rpm`
+     * `libcurl-devel-{version}.cf.rhel7.{arch}.rpm`
+   * Install some dependencies from repos: {{{ #!sh yum install nss-devel libnghttp2 libpsl libmetalink }}}
+   * Install dependencies from downloaded packages. [[BR]][[BR]] **Note:** This will replace the version of //libssh2// that is provided by the //CentOS// official repos. This is necessary as the version of //libcurl// we're installing needs a more up-to-date version than what the official repos can provide. As the packages we've acquired are compiled as to be interoperable with //CentOS// systems, this shouldn't cause any problems with other programs installed on your system. [[BR]][[BR]] Install the `libssh2-*` and `libssh2-devel-*` packages using `rpm -Uvh`. For example: {{{ #!sh rpm -Uvh libssh2-1.8.0-8.0.cf.rhel7.x86_64.rpm libssh2-devel-1.8.0-8.0.cf.rhel7.x86_64.rpm }}}
+   * Install the updated //curl// packages (`curl-*`, `libcurl-*` and `libcurl-devel-*`) using `rpm -Uvh`. For example: {{{ #!sh rpm -Uvh curl-7.61.1-3.0.cf.rhel7.x86_64.rpm libcurl-7.61.1-3.0.cf.rhel7.x86_64.rpm libcurl-devel-7.61.1-3.0.cf.rhel7.x86_64.rpm }}}
+
+ 5. Acquire a sufficiently recent version of //boost//:
    * From https://www.boost.org/users/history/version_1_70_0.html, download `boost_1_70_0.tar.gz`.
    * Uncompress archive:
-     - $ `tar -xf boost_1_70_0.tar.gz`
+     * $ `tar -xf boost_1_70_0.tar.gz`
    * Enter folder:
-     - $ `cd ./boost_1_70_0`
+     * $ `cd ./boost_1_70_0`
    * Compile the parts that are needed to be compiled, and install the libraries:
-     - $ `./bootstrap.sh --with-libraries=filesystem,system`
-     - # `./b2 install`
-     - (Compiled files end up in `/usr/local/lib/`, header files in `/usr/local/include/boost/`)
+     * $ `./bootstrap.sh --with-libraries=filesystem,system`
+     * # `./b2 install`
+     * (Compiled files end up in `/usr/local/lib/`, header files in `/usr/local/include/boost/`)
    * Make sure the runtime linker can find the updated //boost// libraries:
-     - Navigate to `/etc/ld.so.conf.d` and create a blank file called `pyro.conf`.
-     - Within this file, enter the text `/usr/local/lib` and save.
-
-6. Acquire a sufficiently recent version of //fmt//:
+     * Navigate to `/etc/ld.so.conf.d` and create a blank file called `pyro.conf`.
+     * Within this file, enter the text `/usr/local/lib` and save.
+
+ 6. Acquire a sufficiently recent version of //fmt//:
    * From https://github.com/fmtlib/fmt/releases, download the latest release.
    * Follow the instructions to build and install.
 
-7. You should now have all dependencies for 0 A.D. Continue by [#Gettingthecode getting the code], as described below. When you get to the part below in [#Building Building] where you run `./update-workspaces.sh`, you **must** use the argument `--prefer-local-libs`.
+ 7. You should now have all dependencies for 0 A.D. Continue by [#Gettingthecode getting the code], as described below. When you get to the part below in [#Building Building] where you run `./update-workspaces.sh`, you **must** use the argument `--prefer-local-libs`.
 
 ==== !VoidLinux ====
@@ -364 +324 @@
 sudo xbps-install -Syv base-devel boost-devel cmake curl fmt-devel gcc icu-devel libcurl-devel libenet-devel libogg-devel libopenal-devel libpng-devel libsodium-devel libvorbis-devel libxml2 MesaLib-devel miniupnpc-devel patch pkg-config SDL2-devel wxWidgets-devel zip zlib
 }}}
-If there are issues, install more header files depending on the compiler's error message.
-pyrogenesis requires `MesaLib-devel` to provide header files for libGL.
-Custom compile `gloox` for the Lobby or use xbps source packages or use `update-workspaces.sh --without-lobby`. 
-If there are unresolved shlibs or an update breaks a package, then e.g.
+If there are issues, install more header files depending on the compiler's error message. pyrogenesis requires `MesaLib-devel` to provide header files for libGL. Custom compile `gloox` for the Lobby or use xbps source packages or use `update-workspaces.sh --without-lobby`.  If there are unresolved shlibs or an update breaks a package, then e.g.
+
 {{{
 #!sh
@@ -373 +331 @@
 sudo xpbs-install -Su  # update, add -d for debugging, credit duncaen
 }}}
-
-
 === Getting the code ===
-
 See [wiki:BuildInstructionsGettingTheCode Getting the Code].
 
@@ -425 +380 @@
 If you want to create packages for a Linux distribution see the current [https://salsa.debian.org/games-team/0ad/tree/master/debian 0ad] and [https://salsa.debian.org/games-team/0ad-data/tree/master/debian 0ad-data] packages on [https://salsa.debian.org/public Salsa] for examples (especially the `control` and `rules` files).
 
-{{{#!comment Keep anchor for convenient fragment links to the former "OS X" heading.
-}}}
-[=#OS_X]
+{{{#!comment Keep anchor for convenient fragment links to the former "OS X" heading. }}} [=#OS_X]
+
 == macOS ==
-
 The process on macOS is similar to Linux:
 
 === Dependencies ===
-1. Install Xcode, version 10.1+ is recommended. Only 10.13+ are supported to compile the game.
-2. Install the command line tools for Xcode:
+ 1. Install Xcode, version 10.1+ is recommended. Only 10.13+ are supported to compile the game.
+ 1. Install the command line tools for Xcode:
    * Open a Terminal window and enter `xcode-select --install`.
-2. Install the rust toolchain.
-   * (recommended) If you have [https://brew.sh/ Homebrew] installed, use [https://formulae.brew.sh/formula/rust `brew install rust`]. 
+ 1. Install the rust toolchain.
+   * (recommended) If you have [https://brew.sh/ Homebrew] installed, use [https://formulae.brew.sh/formula/rust `brew install rust`].
    * Alternatively, open a Terminal window and enter `curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh`.
    * See https://www.rust-lang.org/tools/install for more information.
-3. CMake:
+ 1. CMake:
    * (recommended) If you have [https://brew.sh/ Homebrew] installed, use [https://formulae.brew.sh/formula/cmake `brew install cmake`].
    * Alternatively, download a prebuilt macOS package at https://cmake.org/download/. If prompted, choose to install the "CMake command line tools" to the **default location**.
@@ -447 +400 @@
 
 === Getting the code ===
-
 See [wiki:BuildInstructionsGettingTheCode Getting the Code].
 
@@ -484 +436 @@
 
 === macOS Troubleshooting ===
-
-* `ERROR: virtualenv is not compatible with this system or executable` [[BR]]
-  `ERROR: The executable …0ad/libraries/source/spidermonkey/mozjs-78.6.0/build-debug/_virtualenvs/init_py3/bin/python3.9 is not functioning` [[BR]] 
-  `ERROR: It thinks sys.prefix is '/usr/local/Cellar/python@3.9/…' (should be '…/init_py3')` [[BR]]
-  There is a known issue with how SpiderMonkey asserts whether python-virtualenv is working correctly. If you have a custom version of Python 3 installed from Homebrew, you may need to uninstall this first, by running: `brew uninstall --ignore-dependencies --force python@3.9`. Beware that if you did not explicitly choose to install this override, it likely came from another Homebrew package and uninstalling it may break that. Note that macOS 10.15+ comes with Python 3.8 by default, which means an override from Homebrew should generally not be necessary any more.
-
+ * `ERROR: virtualenv is not compatible with this system or executable` [[BR]] `ERROR: The executable …0ad/libraries/source/spidermonkey/mozjs-78.6.0/build-debug/_virtualenvs/init_py3/bin/python3.9 is not functioning` [[BR]]  `ERROR: It thinks sys.prefix is '/usr/local/Cellar/python@3.9/…' (should be '…/init_py3')` [[BR]] There is a known issue with how SpiderMonkey asserts whether python-virtualenv is working correctly. If you have a custom version of Python 3 installed from Homebrew, you may need to uninstall this first, by running: `brew uninstall --ignore-dependencies --force python@3.9`. Beware that if you did not explicitly choose to install this override, it likely came from another Homebrew package and uninstalling it may break that. Note that macOS 10.15+ comes with Python 3.8 by default, which means an override from Homebrew should generally not be necessary any more.
 
 == Create macOS distributable app bundle ==