Skip to content

Latest commit

 

History

History
100 lines (71 loc) · 6.15 KB

windows_msvc.md

File metadata and controls

100 lines (71 loc) · 6.15 KB

Procedure for Microsoft Windows users (Windows 10)

NOTE: We also have an installer for Win10 (x64), if you just want to play around with openage you can find it here.

Since Windows doesn't offer a native package manager, we use a mixture of manual and automated steps to get the dependencies for openage. Please remember to replace the directories referenced below (written in <...>) with the appropriate values.

Using CI to build openage

If you use any CI (like Travis-CI or Appveyor) you can make your life easier by using the following yaml-configuration files:

They will build you the latest version from our master branch and package them into an installer and a portable 7z-file.

NOTE: You need to manually make sure and doublecheck if the system you are building on has fulfilled all the dependencies.

Setting up the build environment

You will need to download and install the following manually. Those who already have the latest stable versions of these programs can skip this:

  • Visual Studio Buildtools

    • With the "Visual C++ Buildtools" workload.

    NOTE: If you are searching for an IDE for development you can get an overview here, we've also written some instructions for developing with different IDEs.

  • Python 3

    • With the "pip" option enabled. We use pip to install other dependencies.
    • With the "Precompile standard library" option enabled.
    • With the "Download debug binaries (...)" option enabled.
    • If in doubt, run the installer again and choose "Modify".
    • You are going to need the 64-bit version of python if you are planning to build the 64-bit version of openage, and vice versa.

  • CMake

Python Modules

Open a command prompt at <Python 3 installation directory>/Scripts

pip install cython numpy pillow pygments pyreadline Jinja2

vcpkg packages

Set up vcpkg. Open a command prompt at <vcpkg directory>

vcpkg install dirent eigen3 fontconfig freetype harfbuzz libepoxy libogg libpng opus opusfile qt5-base qt5-declarative qt5-quickcontrols sdl2 sdl2-image

Note: The qt5 port in vcpkg has been split into multiple packages, build times are acceptable now. If you want, you can still use the prebuilt version instead. If you do so, include -DCMAKE_PREFIX_PATH=<QT5 directory> in the cmake configure command.

Note: If you are planning to build the 64-bit version of openage, you are going to need 64-bit libraries. Add command line option --triplet x64-windows to the above command or add the environment variable VCPKG_DEFAULT_TRIPLET=x64-windows to build x64 libraries. See here

Building openage

Note that openage doesn't support completely out-of-source-tree builds yet. We will, however, use a separate build directory to build the binaries.

Note: You will also need to set up the dependencies for Nyan, which is mainly flex

Open a command prompt at <openage directory>:

 mkdir build
 cd build
 cmake -DCMAKE_TOOLCHAIN_FILE=<vcpkg directory>/scripts/buildsystems/vcpkg.cmake ..
 cmake --build . --config RelWithDebInfo -- /nologo /m /v:m

Note: If you want to build the x64 version, please add -G "Visual Studio 15 2017 Win64" (for VS2017) to the first cmake command. Note: If you want to download and build Nyan automatically add -DDOWNLOAD_NYAN=YES -DFLEX_EXECUTABLE=<path to win_flex.exe> to the first cmake command.

Running openage (in devmode)

While this is straightforward on other platforms, there is still stuff to do to run openage on Windows:

  • Install the DejaVu Book Font.
    • Download and extract the latest dejavu-fonts-ttf tarball/zip file.
    • Copy ttf/DejaVuSerif*.ttf font files to %WINDIR%/Fonts.
    • Set the FONTCONFIG_PATH environment variable to <vcpkg directory>\installed\<relevant config>\tools\fontconfig\fonts\.
    • Copy fontconfig/57-dejavu-serif.conf to %FONTCONFIG_PATH%/conf.d.
  • [Optional] Set the AGE2DIR environment variable to the AoE 2 installation directory.
  • Set QML2_IMPORT_PATH to <vcpkg directory>\installed\<relevant config>\qml or for prebuilt Qt <qt directory>\<qt-version>\<compiler-version>\qml
  • Append the following to the environment PATH:
    • <openage directory>\build\libopenage\<config built> (for openage.dll)
    • Path to nyan.dll (depends on the procedure chosen to get nyan)
    • <vcpkg directory>\installed\<relevant config>\bin
    • <QT5 directory>\bin (if prebuilt QT5 was installed)

Now, execute <openage directory>/run.exe and enjoy!

Packaging

  • Install NSIS.
  • Depending on the way you installed Qt (vcpkg/pre-built) you need to edit the following line in <openage-repo-dir>\buildsystem\templates\ForwardVariables.cmake.in:
	# Use windeploy for packaging qt-prebuilt, standard value '1' for windeploy, '0' for vcpkg
	set(use_windeployqt 1)

Open a command prompt at <openage directory>\build (or use the one from the building step):

cpack -C RelWithDebInfo

The installer (openage-<version>-<arch>.exe) will be generated in the same directory.

Hint: Append -V to the cpack command for verbose output (it takes time to package all dependencies).

Hint: you can set with the environment variable TARGET_PLATFORM (e.g. amd64, x86).