Downloading and Compiling under Windows

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

• Visual C++ 2010 Express Edition: http://www.microsoft.com/express/Downloads/
  • You can optionally install Visual Studio 2010 Service Pack 1: http://www.microsoft.com/express/Downloads/#2010-Service-Pack-1
• CMake: http://www.cmake.org/cmake/resources/software.html
• MinGW: http://sourceforge.net/projects/mingw/files/Automated%20MinGW%20Installer/mingw-get-inst
  • In the installer, make sure you check MSYS
• msysgit: Follow the setup described on GitHub: http://help.github.com/win-set-up-git/
• Optional: TortoiseGit: http://code.google.com/p/tortoisegit/

Libraries

ZLib - http://www.zlib.net

• Download the latest version of the "zlib compiled DLL": http://zlib.net/zlib125-dll.zip
  • Extract in C:\Code\Libs\zlib
• Download the latest version of the "zlib source code": http://zlib.net/zlib125.zip
  • Extract in C:\Code\Libs\zlib-src
• Open this VC10 solution: C:\Code\Libs\zlib-src\contrib\vstudio\vc10\zlibvc.sln
  • Build the ReleaseWithoutAsm target
• Copy the generated library
  • C:\Code\Libs\zlib-src\contrib\vstudio\vc10\x86\ZlibDllReleaseWithoutAsm\zlibwapi.lib
  • To the following location (replace the existing file): C:\Code\Libs\zlib\lib\zdll.lib
• Copy the generated dll
  • C:\Code\Libs\zlib-src\contrib\vstudio\vc10\x86\ZlibDllReleaseWithoutAsm\zlibwapi.dll
  • To the arx bin folder: C:\Code\git\ArxFatalis\bin\zlibwapi.dll

Freetype - http://freetype.sourceforge.net

• Download freetype2: http://freetype.sourceforge.net/download.html
• Extract in C:\Code\Libs\freetype
• Open VC2008 solution: C:\Code\Libs\freetype\builds\win32\vc2008\freetype.sln"
  • VC2010 should convert it without any problem.
  • Select the "LIB Release Multithreaded" target
  • Build, should give you a lot of warnings but succeed anyway
• Copy the generated library
  • C:\Code\Libs\freetype\objs\win32\vc2008\freetype244MT.lib
  • To the following location: C:\Code\Libs\freetype\lib\freetype.lib

DevIL - http://openil.sourceforge.net

• Download "DevIL 1.x.y SDK for 32-bit Windows": http://openil.sourceforge.net/download.php
• Extract in "C:\Code\Libs\devil"
• Copy the following DLL
  • C:\Code\Libs\devil\lib\DevIL.dll
  • To the arx bin folder: C:\Code\git\ArxFatalis\bin\DevIL.dll
• You need to fix the CMake FindDevIL.cmake which contains error
  • Open %YOUR_CMAKE_INSTALL%\share\cmake-2.8\Modules\FindDevIL.cmake
  • Replace this line: FIND_PATH(IL_INCLUDE_DIR il.h)
  • By: FIND_PATH(IL_INCLUDE_DIR IL/il.h)

DirectX 7 SDK

• Not available anymore from Microsoft... so download it here: http://bcb-tools.com/Downloads/Microsoft/dx7adxf.exe
• Run it, its a setup in a self extracting exe (extracted to C:\dx7asdk\ by default)
• Run the setup
  • C:\dx7asdk\DXF\setup.exe
  • Install to C:\Code\Libs\directx7
• Add DX7SDK_PATH to your environment variable:
  • DX7SDK_PATH=C:\Code\Libs\directx7

OpenAL Soft - http://kcat.strangesoft.net/openal.html

• Download the latest source version: http://kcat.strangesoft.net/openal-releases/openal-soft-1.13.tar.bz2
• Extract in C:\Code\Libs\openal
• Run GitBash - msysgit should have installed a shortcut for it on your desktop

cd /c/Code/Libs/openal/build/
cmake .. -G "Visual Studio 10"

• Open the solution: C:\Code\Libs\openal\build\OpenAL.sln
  • Select the "Release" target
  • Build the whole solution
• Copy the generated library
  • C:\Code\Libs\openal\build\Release\OpenAL32.lib
  • To the following location: C:\Code\Libs\freetype\lib\OpenAL32.lib
• Copy the generated dll
  • C:\Code\Libs\openal\build\Release\OpenAL32.dll
  • To the arx bin folder: C:\Code\git\ArxFatalis\bin\OpenAL32.dll

Configure CMake

We need to tell cmake where to search for our libs

• Add CMAKE_PREFIX_PATH to your environment variable:
  • CMAKE_PREFIX_PATH=C:\Code\Libs\zlib;C:\Code\Libs\freetype;C:\Code\Libs\DevIL;C:\Code\Libs\openal
• 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\Libs\zlib;C:\Code\Libs\freetype;C:\Code\Libs\devil;C:\Code\Libs\openal

Get the code

In GitBash

cd /c/Code/git
git clone git@github.com:lubosz/ArxFatalis.git
cd ArxFatalis

Generating VC++ projects

We'll use CMake for that

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

Building ArxFatalis

• Open the solution in Visual Studio: C:\Code\git\ArxFatalis\build_vc10\ArxFatalis.sln
  • If you use Visual C++ 2010, there's a bug causing all cpp files to be place in the root of the project... it is annoying but has no effect on the build itself. See http://public.kitware.com/Bug/view.php?id=11925. VC++ 2008 is fine.
• 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_default.ini, as debugging with a fullscreen dx windows is a pain
• Click the "debug" button (F5) and enjoy :D