Skip to content

Latest commit

 

History

History
238 lines (183 loc) · 8.96 KB

Build.md

File metadata and controls

238 lines (183 loc) · 8.96 KB
Raw

Building TrenchBroom

All Platforms

  • We use pandoc to generate the documentation. Install a binary distribution from the website and make sure that it is in your PATH, otherwise your builds will fail.

Windows

  • Generally, the cmake scripts don't handle paths with spaces very well, so make sure that you check out the TrenchBroom source repository somewhere on a path without any spaces.
  • For Visual Studio (only tested with 2010)

    • Get the binary build of wxWidgets 3 for your platform from http://www.wxwidgets.org

    • For 32bit builds, you need the following files: If you are using a different version of Visual Studio, you will have to download other binaries, e.g., wxMSW-<version>-vc120_Dev.7z etc. and you will also have to use different directory names instead of vc140_dll below.

      • wxWidgets-<version>_headers.7z
      • wxMSW-<version>_vc140_Dev.7z
      • wxMSW-<version>_vc140_ReleaseDLL.7z
      • wxMSW-<version>_vc140_ReleasePDB.7z

    • Unpack all files into c:\wxWidgets-<version> so that include and lib directories are at the same level after unpacking.

    • The directory layout should look like this:

      wxWidgets-3.1.0
  \include
      \msvc
      \wx
      \wx
      <wxwidgets header files>
  \lib
      \vc140_dll
      <wxwidgets libraries>

    • Set a new environment variable WXWIN=C:\wxWidgets-<version> (replace the path with the path where you unpacked wxWidgets).

    • If you want to run the binaries without using the installer, add %WXWIN%\lib\vc140_dll to your path. The relevant parts of my PATH variable look something like this:

      C:\Program Files (x86)\CMake 2.8\bin;c:\wxWidgets-3.1.0\lib\vc140_dll;

    • Download and install CMake for Windows

    • Open a command prompt and change into the directory where you unpacked the TrenchBroom sources.

    • Create a new directory, e.g. "build", and change into it.

    • Run the following two commands

      cmake .. -DCMAKE_BUILD_TYPE=Release
cmake --build . --config Release --target TrenchBroom

      You can replace "Release" with "Debug" if you want to create a debug build. This is also recommended if you want to work on the source in Visual Studio.

  • For MinGW 64

    • Download and install MinGW

      • Scroll down to Mingw-builds and select the appropriate version for your OS (32 or 64 Bit), then select the SJLJ variant.
      • Add <MinGW installation dir>/bin to your path.

    • Download wxWidgets source (for DOS / Windows) from http://www.wxwidgets.org/

      • Unpack the sources somewhere to C:\wxWidgets-3.0.0

    • Build wxWidgets

      • Open a command prompt and cd into C:\wxWidgets-3.0.0\build\msw

      • Run these commands

        mingw32-make -f makefile.gcc SHARED=1 UNICODE=1 OPENGL=1 BUILD=release clean
mingw32-make -f makefile.gcc SHARED=1 UNICODE=1 OPENGL=1 BUILD=release
mingw32-make -f makefile.gcc SHARED=1 UNICODE=1 OPENGL=1 BUILD=debug clean
mingw32-make -f makefile.gcc SHARED=1 UNICODE=1 OPENGL=1 BUILD=debug

    • Set a new environment variable WXWIN=C:\wxWidgets-<version> (replace the path with the path where you unpacked wxWidgets).

    • If you want to run the binaries without using the installer, add %WXWIN%\lib\gc_dll to your path. The relevant parts of my PATH variable look something like this:

      C:\Program Files (x86)\CMake 2.8\bin;c:\wxWidgets-3.0.0\lib\gcc_dll;

Linux

Dependencies

Compiling wxWidgets 3 requires the following dependencies. You should install them using the packager of your Linux distribution.

  • g++ GNU c++ compiler

  • GTK2 and development packages: libgtk2.0-dev (GTK3 will NOT work)

  • FreeImage: libfreeimage-dev

  • OpenGL and GLU development headers (Mesa OpenGL development packages) freeglut3, freeglut3-dev, mesa-common-dev

  • X11 video mode extension library: libxxf86vm-dev

  • If you have a debian-based distribution, install them with this command:

    sudo apt-get install libgtk2.0-dev freeglut3 freeglut3-dev libglew-dev mesa-common-dev build-essential libglm-dev libxxf86vm-dev libfreeimage-dev pandoc

Compiling and linking TrenchBroom requires a working OpenGL installation. This page may help you if you see linker errors about missing GL libraries.

wxWidgets

  • Currently you must download, patch, and build wxWidgets yourself.

    • Get the latest sources of wxWidgets 3 from wxwidgets.org and unpack them.

    • Move the unpacked directory someplace where you want to keep it.

    • Open a terminal and change into the wxwidgets directory.

    • Apply the patches in TrenchBroom/patches/wxWidgets as follows:

      patch -p0 < <path_to_trenchbroom_directory>/patches/wxWidgets/*.patch

    • Create two directories: build-release and build-debug (don't rename those!)

    • Change into wxwidgets/build-release

    • Run

      ../configure --disable-shared --with-opengl --with-gtk=2 --prefix=$(pwd)/install

    • Run

      make
make install

    • Change into wxwidgets/build-debug

    • Run

      ../configure --enable-debug --with-opengl --with-gtk=2 --prefix=$(pwd)/install

    • Run

      make
make install

CMake

  • Install CMake using your package manager: sudo apt-get install cmake

Build TrenchBroom

  • Open a terminal and change into the directory where you unpacked the TrenchBroom sources

  • Create a new directory, e.g. "build", and change into it.

  • Run the following two commands

    cmake .. -DCMAKE_BUILD_TYPE=Release -DwxWidgets_PREFIX=/your/wxWidgets/directory/build-release/install
cmake --build . --target TrenchBroom

  • You can replace "Release" with "Debug" if you want to create a debug build. Also change the value of the wxWidgets_PREFIX variable to point to your wxWidgets build-debug directory in that case.

Packaging

  • If you want to create packages for Linux (deb or rpm), then you'll need to install these packages: devscripts, debhelper, rpm

    sudo apt-get install devscripts debhelper rpm

Notes

  • You can install your preferred wxWidgets configuration using make install. If you wish to do this, then you can omit specifying the wxWidgets_PREFIX variable when generating the build configs with Cmake.

  • On some systems, such as Xubuntu, you may have to pass the following extra paramter to cmake when creating the build scripts: -DFREETYPE_INCLUDE_PATH=/usr/include/freetype2/freetype So the first cmake command should be

    cmake .. -DCMAKE_BUILD_TYPE=Release -DFREETYPE_INCLUDE_PATH=/usr/include/freetype2/freetype

Mac OS X

Build environment

  1. Get Xcode from the App Store

  2. Dependencies

    • Install cmake (required) and ninja (optional). For example, with homebrew:

      brew install cmake ninja

  3. wxWidgets

    • Get the latest sources of wxWidgets 3 from wxwidgets.org and unpack them.

    • Move the unpacked directory someplace where you want to keep it.

    • Open a terminal and change into the wxwidgets directory.

    • Apply the patches in TrenchBroom/patches/wxWidgets as follows:

      patch -p0 < <path_to_trenchbroom_directory>/patches/wxWidgets/*.patch

    • Create two directories: build-release and build-debug (don't rename those!)

    • Change into wxwidgets/build-release

    • Run

      ../configure --with-osx_cocoa --disable-shared --disable-mediactrl --with-opengl --with-macosx-version-min=10.9 --with-cxx=11 --prefix=$(pwd)/install

    • Run

      make
make install

    • Change into wxwidgets/build-debug

    • Run

      ../configure --enable-debug --with-osx_cocoa --disable-mediactrl --with-opengl --with-macosx-version-min=10.9 --with-cxx=11 --prefix=$(pwd)/install

    • Run

      make
make install

  4. Build

    • For a release build:

      mkdir build-ninja
cd build-ninja
cmake .. -GNinja -DCMAKE_BUILD_TYPE=Release -DwxWidgets_PREFIX=/your/wxWidgets/directory/build-release/install
ninja

    • To generate an Xcode project for developing with:

      mkdir build-xcode
cd build-xcode
cmake .. -GXcode -DCMAKE_BUILD_TYPE=Debug -DwxWidgets_PREFIX=/your/wxWidgets/directory/build-debug/install
open TrenchBroom.xcodeproj

Notes

  • You can install your preferred wxWidgets configuration using make install. If you wish to do this, then you can omit specifying the wxWidgets_PREFIX variable when generating the build configs with Cmake.