Downloading and Compiling under Windows

From Arx Libertatis Wiki
Revision as of 18:28, 18 December 2013 by Ds (talk | contribs) (→‎Getting the libs)
Jump to navigation Jump to search

ℹ️  This page describes compiling Arx Libertatis from source under Windows 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 Windows.
There are also instructions available for Linux / FreeBSD and macOS

Here's a quick guide describing how to compile and debug Arx Fatalis under Windows using Visual Studio 2010. It should also work using Visual Studio 2008, given that you generate the right projects using CMake. Paths used here are only to give as an example...

Applications

Getting the libs

Getting all libraries to work under Windows required a lot of work and was error prone... So we decided to provide prebuilt versions (32-bit and 64-bit) to simply the process. Arx Libertatis depends on the following libraries on Windows. Those followed by an asterisk are optional; depending on which backend you want to use they might not be needed.

  • Boost - ArxWindows only contains the Boost source, it doesn't contain any prebuilt libraries, but those aren't needed for arx.
  • GLM
  • FreeType
  • OpenAL 1
  • OpenGL
  • GLEW
  • SDL
  • ZLib

1. We strongly recommend you use the [OpenAL Soft](http://kcat.strangesoft.net/openal.html) implementation of OpenAL. Creative's OpenAL implementation is severely limited, which can cause missing sounds in arx. OAL implementations from IHVs are just buggy and the cause for many crash reports.

Here's how to obtain them:

In GitBash 

cd /c/Code/git
git clone --depth 1 git://github.com/arx/ArxWindows.git

Then we need to tell cmake where to search for our libs

  • Add CMAKE_PREFIX_PATH to your environment variable:
    • CMAKE_PREFIX_PATH=C:\Code\git\ArxWindows\libs\zlib;C:\Code\git\ArxWindows\libs\freetype;C:\Code\git\ArxWindows\libs\openal;C:\Code\git\ArxWindows\libs\boost;C:\Code\git\ArxWindows\libs\glm;C:\Code\git\ArxWindows\libs\opengl;C:\Code\git\ArxWindows\libs\sdl;C:\Code\git\ArxWindows\libs\dbghelp
  • After that, you need to start a new prompt (GitBash, Command Prompt, etc) so that the new environment variable is available
  • Start a new GitBash instance
    • Run the following: echo $CMAKE_PREFIX_PATH
    • It should echo: C:\Code\git\ArxWindows\libs\zlib;C:\Code\git\ArxWindows\libs\freetype;C:\Code\git\ArxWindows\libs\openal;C:\Code\git\ArxWindows\libs\boost;C:\Code\git\ArxWindows\libs\glm;C:\Code\git\ArxWindows\libs\opengl;C:\Code\git\ArxWindows\libs\sdl;C:\Code\git\ArxWindows\libs\dbghelp

Finally, copy the necessary dlls to C:\Code\git\ArxFatalis\bin\... 

C:\Code\git\ArxWindows\libs\sdl\bin\SDL32.dll
C:\Code\git\ArxWindows\libs\sdl\bin\SDL64.dll

Getting the source code

In GitBash 

cd /c/Code/git
git clone git://github.com/arx/ArxLibertatis.git
cd ArxLibertatis

Alternatively you can download a stable source code release and extract that:


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.

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:

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

Generating VC++ projects

We'll use CMake for that 

mkdir build_vc10
cd build_vc10
cmake .. -G "Visual Studio 10" -DUNITY_BUILD=1

Building ArxFatalis

  • Open the solution in Visual Studio: C:\Code\git\ArxFatalis\build_vc10\ArxFatalis.sln
  • You can build the debug target (has debug symbols & can be debugged) or the release target (faster, but currently without debug information)

Debugging ArxFatalis

  • Right click on the arx project and select "Properties..."
  • Go to "Configuration Properties->Debugging"
  • Change the "Working Directoy" property to "..\bin"
    • Note that this needs to be done for each target you wish to build/debug
  • Change full_screen to 0 in bin\cfg.ini, as debugging with a fullscreen dx windows is a pain
  • Click the "debug" button (F5) and enjoy :D
Retrieved from "https://wiki.arx-libertatis.org/index.php?title=Downloading_and_Compiling_under_Windows&oldid=3516"