Downloading and Compiling under macOS

ℹ️  This page describes compiling Arx Libertatis from source under Mac OS X and assumes some familiarity with the command-line. If you just want to play the game, it might be easier to grab a binary release or snapshot if available.

This page documents how to compile Arx Libertatis from https://github.com/arx/ArxLibertatis under Mac OS X.
There are also instructions available for Windows and Linux / FreeBSD

Specific instructions are given for a cleanly installed Lion 10.7.3 system, but the procedure should be similar for other versions.

Setting Up the Build Environment

To download and compile Arx Libertatis you will need the following tools:

• Xcode Tested with 4.3, install the latest from the App Store (https://developer.apple.com/xcode/)
  • Install command line tools from Xcode, in Preferences -> Download
  • Set the path to the Xcode folder: sudo xcode-select -switch /Applications/Xcode.app/Contents/Developer
• github for Mac Also install the command line tools (http://mac.github.com/)
  • Note: if you are using an older mac (Core Duo, i.e. 32-bit processor), install git from here: http://code.google.com/p/git-osx-installer/
• cmake should be build from source (http://www.cmake.org/)
• MacPorts (http://www.macports.org/)

Libraries

• SDL 1.2 (http://www.libsdl.org/)
• GLEW (http://glew.sourceforge.net/)
• zlib (http://zlib.net/)
• Boost (headers only, http://www.boost.org/)
• GLM (http://glm.g-truc.net/)
• Freetype (http://www.freetype.org/)
• OpenGL Nothing to do... Framework is bundled with Xcode
• OpenAL Nothing to do... Framework is bundled with Xcode

I installed those using MacPorts... but you can probably obtain "native" versions too:

sudo port install zlib freetype boost qt4-mac libsdl glew

• NOTE: these packages take a long time to build. Do not be discouraged if it seems like nothing is happening.

Getting the source code

There are several methods to get the Arx Libertatis source code - choose the one that suits you best:

Downloading a released version

The easiest way to get the AL source code is to download a versioned release. This will get you a reasonably up to date copy of the source code that has been tested to work.

• Arx Libertatis Source Codearx-libertatis-1.2.tar.xz2.4 MiB
  MD5: 8e05754b75af0ed7fbf709d30b28df3csignature

Cloning the repository

If you want the absolute latest version of the Arx Libertatis development code and stay up to date, you can clone the AL source code repository. Beware that this will give you the current master development branch that we are actively working on. While the code in that branch should always work, it hasn't undergone any significant testing. If you just want to play the game, consider using a released version instead.

To clone the repository, type:

git clone git://github.com/arx/ArxLibertatis.git

This creates a directory called ArxLibertatis and downloads the current source code from github.

Later if you want to update your local copy of the source code, run

git pull

The git repository does not contain raster images for the icon and logo. These will be generated from scalable versions when building Arx Libertatis, but doing so requires additional dependencies (Inkscape, ImageMagick and OptiPNG). To avoid this, you can instead get the generated images from the ArxLibertatisData repo:

git clone --depth 1 git://github.com/arx/ArxLibertatisData.git

Downloading a snapshot

Alternatively you can download the current snapshot of the source code repository as a .zip or .tar.gz file and extract that:

• Arx Libertatis Development Snapshot (tar.gz)latest snapshot of branch 'master'

• Arx Libertatis Development Snapshot (zip)latest snapshot of branch 'master'

This will give you the same code as cloning the repository, but won't let you update it without downloading everything again.

Using GitHub for Mac

Finally, you can use the GitHub for Mac application to clone the repository. Refer to http://mac.github.com/help.html :)

Compiling

Building CMake from source

The latest release of CMake (2.8.7) still has issues with Xcode 4.3, but it's been fixed in the development branch. You can build cmake from source to fix this:

git clone http://cmake.org/cmake.git
cd cmake
./configure
make
sudo make install

You're now ready to generate makefiles or an Xcode project. cd to the root of the arx repository

Makefiles

mkdir build
cd build
cmake ..
make

NOTE: If this results in an error that says something about an invalid command "--as-needed", try again with a clean build environment (ie: remove CMakeCache.txt). If the error persists, please report it as a bug at bugs.arx-libertatis.org with detailed build logs.

Xcode project

mkdir build_xcode
cd build_xcode
cmake .. -G Xcode
open ArxLibertatis.xcodeproj/

Then compile and run the project from Xcode. (?)

Running the executable

By default, the user directory for Arx on Mac is /Users/username/Library/Application Support/ArxLibertatis/

You will need to obtain a copy of the data files from a commercial copy of Arx Fatalis, or use the demo data files, put these in the directory mentioned above and you are ready to go! Run the file "arx" which is in the ArxLibertatis repository. The game will automatically change all used files to lower-case on the first start. If you want to run the game with read-only data you need to do this manually.

For running arx in a debugger, see Debugging