Skip to content

Latest commit

 

History

History
88 lines (53 loc) · 4.82 KB

COMPILING-VS-VCPKG.md

File metadata and controls

88 lines (53 loc) · 4.82 KB
Raw

Compilation guide for Windows (using Visual Studio and vcpkg)

This guide contains steps required to allow compilation of Cataclysm-BN on Windows using Visual Studio and vcpkg.

Steps from current guide were tested on Windows 10 (64 bit), Visual Studio 2019 (64 bit) and vcpkg, but should as well work with slight modifications for other versions of Windows and Visual Studio.

Prerequisites:

  • Computer with modern Windows operating system installed (Windows 10, Windows 8.1 or Windows 7);
  • NTFS partition with ~15 Gb free space (~10 Gb for Visual Studio, ~1 Gb for vcpkg installation, ~3 Gb for repository and ~1 Gb for build cache);
  • Git for Windows (installer can be downloaded from Git homepage);
  • Visual Studio 2019 (or 2015 Visual Studio Update 3 and above);
  • Latest version of vcpkg (see instructions on vcpkg homepage).

Note: Windows XP is unsupported!

Installation and configuration:

  1. Install Visual Studio (installer can be downloaded from Visual Studio homepage).

  2. Install Git for Windows (installer can be downloaded from Git homepage).

  3. Install and configure vcpkg using instruction from vcpkg homepage with following command line:

git clone https://github.com/Microsoft/vcpkg.git
cd vcpkg
.\bootstrap-vcpkg.bat
.\vcpkg integrate install
  1. Install (or upgrade) neccessary packages with following command line:

install 64 bit dependencies:

.\vcpkg --triplet x64-windows-static install sdl2 sdl2-image sdl2-mixer[dynamic-load,libflac,mpg123,libmodplug,libvorbis] sdl2-ttf gettext

install 32 bit dependencies:

.\vcpkg --triplet x86-windows-static install sdl2 sdl2-image sdl2-mixer[dynamic-load,libflac,mpg123,libmodplug,libvorbis] sdl2-ttf gettext

upgrade all dependencies:

.\vcpkg upgrade

Cloning and compilation:

  1. Clone Cataclysm-BN repository with following command line:

Note: This will download whole CBN repository. If you're just testing you should probably add --depth=1.

git clone https://github.com/cataclysmbnteam/Cataclysm-BN.git
cd Cataclysm-BN
  1. Open the provided solution (msvc-full-features\Cataclysm-vcpkg-static.sln) in Visual Studio, select configuration (Release or Debug) and platform (x64 or x86) and build it.

Note: This will compile release version with Sound, Tiles and Localization support (language files won't be automatically compiled).

  1. Building Cataclysm with Visual Studio is very simple. Just build it like a normal Visual C++ project. The process may takes a long period of time, so you'd better prepare a cup of coffee and some books in front of your computer :)

  2. If you need localization support, execute the bash script lang/compile_mo.sh inside Git Bash GUI just like on a UNIX-like system. This will compile the language files that were not automatically compiled in step 2 above.

Even if you do not need languages other than English, you may still want to execute lang/compile_mo.sh en or lang/compile_mo.sh all to compile the language file for English, in order to work-around a libintl bug that is causing significant slow-down on Windows targets if a language file is not found.

Debugging

Ensure that the Cataclysm project (Cataclysm-vcpkg-static) is the selected startup project, configure the working directory in the project settings to $(ProjectDir).., and then press the debug button (or use the appropriate shortcut, e.g. F5).

If you discover that after pressing the debug button in Visual Studio, Cataclysm just exits after launch with return code 1, that is because of the wrong working directory.

When debugging, it is not strictly necessary to use a Debug build; Release builds run significantly faster, can still be run in the debugger, and most of the time will have most of the information you need.

Running unit tests

Ensure that the Cataclysm test project (Cataclysm-test-vcpkg-static) is the selected startup project, configure the working directory in the project settings to $(ProjectDir).., and then press the debug button (or use the appropriate shortcut, e.g. F5). This will run all of the unit tests. Additional command line arguments may be configured in the project's command line arguments setting, or if you are using a compatible unit test runner (e.g. Resharper) you can run or debug individual tests from the unit test sessions.

Make a distribution

There is a batch script in msvc-full-features folder distribute.bat. It will create a sub folder distribution and copy all required files(eg. data/, Cataclysm.exe and dlls) into that folder. Then you can zip it and share the archive on the Internet.