BuildingWindows

From Mumble Wiki
Jump to: navigation, search

Building Guides

This page is one of a set of Building pages/guides for the different OSes with information on building Mumble/Murmur.

BuildingLinux BuildingFreeBSD BuildingOpenBSD BuildingMacOSX BuildingWindows


Commandline instructions

Whenever something appears

like this

you're supposed to enter it in that command shell (or copy it from this webpage and right click in the command window and select Paste).

Note that each line is a separate command. So, if you wanted to do the following,

cd mumble
nmake

you would type "cd mumble" in your command prompt, and press enter, and then you would type "nmake", and press enter.

Ok. So you're ready to start working.

Build using MSVC on Windows

Introduction

Mumble has quite a few dependencies for building on Windows, and as the feature set grows, so does the list of dependencies. Therefore we have built some automated scripts to create a sane build environment for Mumble. To make this build environment as similar as possible across all of Mumble's supported Platforms, the Windows build is strongly dependent on Cygwin.

The mumble-releng Github repository has an up-to-date README on how to create the build environment!

Icons oxygen 48x48 actions view-pim-notes.png
Note:
The most up-to-date information on how to create a Mumble build environment are always to be found in this README file!
Elaboration: There is an older deprecated version of this article at BuildingWindows (deprecated) showing how to build Mumble manually with QT4 which is far more complex.


Software you will need

Icons oxygen 48x48 actions view-pim-notes.png
Note:
Install everything to it's default locations except explicitly stated otherwise!
  • Visual C++ Build Tools 2015: Contains MSVC 2015, the compiler we are currently using for the releases. During the installation you can deselect the Windows SDKs, because we are going to install the up-to-date one, listed below.
  • Windows SDK: Contains the updated development resources, including the headers. If you are on Windows 7, don't select "Windows Performance Toolkit", because it isn't compatible.
  • Cygwin, either 64-bit or 32-bit. This is only used to fetch and build dependencies, Mumble itself will not depend on Cygwin. You can accept the default settings of the installer.
  • Git: You can use any version of Git, it only has to be in your PATH variable. (If you insist you can also use a Git version from Cygwin but it still has to be in your PATH).

Creating the build environment

First you need to clone the mumble-releng repository into a directory in which your Windows user has write access cd into this directory, then

git clone https://github.com/mumble-voip/mumble-releng.git mumble-releng

afterwards you have to open your Windows Explorer and navigate to buildenv\1.3.x\win32-static\cygwin-deps and put your cygwin installer .exe file in this directory. The installer should be named setup-x86_64.exe if you have Cygwin x64 or setup-x86.exe if you have Cygwin x86.

Then run install-cygwin-deps.cmd inside this folder to fetch the required cygwin packets.

Elaboration: The repository's README has a comprehensive list of packages needed, should you for whatever reason not want to use the script.

Back in the terminal window, change to the directory the scripts for Windows (32-bit) and static build reside in.

cd mumble-releng/buildenv/1.3.x/win32-static

and execute

setup.cmd

This should install a Mumble build environment in your %USERPROFILE% directory named MumbleBuild inside of it should be a directory named like win32-static-1.3.x-2015-05-25-1234ab7.

If everything went right Windows Explorer should open up the directory named above.

Build Mumble's dependencies

To start building Mumble's dependencies, double-click the "MumbleBuild - cygwin" shortcut. This will open a cygwin terminal inside it type:

cd mumble-releng/buildenv/1.3.x/win32-static

to change directory to the build environment's local clone of the mumble-releng repository.

Elaboration: This is not the same mumble-releng clone than what you used to create the %USERPROFILE%\MumbleBuild directory. Use the one you checked out first (on your own) to update the MumbleBuild directory should the need arise.

To make the .bash files inside this directory executable do

chmod +x *.bash

and then start the dependency fetch&compile operation with

./build-all.bash

This operation will take a long time (like you can eat something in between long), depending on your hardware and internet connection.

Once all dependencies are built, you will be returned to your Cygwin shell.

You can double check that everything has been built by inspecting the build environment's root directory. You should see a lot of folders containing installed/built products for all of the Mumble dependencies.

Building Mumble

To build Mumble itself using your newly-built build environment, you should use the "MumbleBuild - cmd" shortcut to launch a Windows command prompt.

Next, make a checkout of the Mumble source tree and enter the root of the source tree with

git clone --recursive https://github.com/mumble-voip/mumble.git mumble
cd mumble

to generate Makefiles for use with the build environment, run

qmake -recursive main.pro CONFIG+="release static no-elevation no-g15 no-asio" CONFIG-=sse2
Icons oxygen 48x48 actions view-pim-notes.png
Note:
This build environment does not install the libraries and headers needed to build Mumble with G15 LCD or ASIO audio support. If you want to build Mumble with one of them you need to install them to the build environment on your own. In this case remove no-g15 or rather no-asio accordingly.

After all this preparation start the actual Mumble compilation with

nmake

You should end up with a mumble.exe and a murmur.exe binary (and a whole collection of .DLL files to go along with the two) in the "release" directory in the root of the Mumble source tree.

If you want to distribute your own mumble.exe you can either create an installer (see below) or collect mumble.exe and the needed .DLL files yourself.

(Optional) Visual Leak Detector

Icons oxygen 48x48 actions view-pim-notes.png
Note:
VLD is no longer a default requirement for a Mumble build environment. You only have to install it if you want to use it in which case you have to manually enable it with CONFIG+=vld.

Download VLD and install it to its default install location.

If you're using Visual C++ Express Edition, you will need to manually extract the files using a tool like 7-zip . Extract it to C:\dev\ and adjust the VLD_PATH to point to it.

Icons oxygen 48x48 actions view-pim-notes.png
Note:
VLD is only enabled for debug builds. If you only compile Release builds you do not need it.

(Optional) Custom Dependency Paths

The build files were modified to support custom dependency paths a while ago. This is for the people who have the dependencies installed in some other place than the autogenerated directory structure. To specify the custom paths you need to create a winpaths_custom.pri file to the root of your Mumble project. In this file you can override all paths found in winpaths_default.pri. For example:

 OPENSSL_PATH = C:\\dev\MyOpenSSLIsSomewhereElse
 ICE_PATH = C:\\Program Files (x86)\\ZeroC\\Ice-3.4.1

Would make the build process search its OpenSSL and Ice dependencies in the specified folders and use defaults for everything else. Note that you should only override the variables for dependencies you actually installed in non-default locations to prevent clashes with possible future updates.


Note: If you copied winpaths_default.pri to create your winpaths_custom.pri make sure to delete the following lines from your winpaths_custom.pri file:

# Include custom file if it exists
exists(winpaths_custom.pri) {
	include(winpaths_custom.pri)
}

(Optional) Build a Mumble installer package

If you want to create an installable .msi package from your self-compiled Mumble some additional steps are needed.

Download and install the latest WIX stable Version (currently 3.8) from here.

Set the following environment variables as needed (see defaults in installer/Settings.wxi):

 MumbleSourceDir  default: \dev\mumble
 MumbleQtDir  default: \dev\QtMumble
 MumbleDebugToolsDir  default: C:\Program Files (x86)\Debugging Tools for Windows (x86)
 MumbleSndFileDir  default: \Program Files (x86)\Mega-Nerd\libsndfile\bin
   Define MumbleNoSndFile to exclude  libsndfile
 MumbleMySQLDir  default: \dev\MySQL
   Define MumbleNoMySQL to exclude  MySQL
 MumbleIceDir  default: \Program Files (x86)\ZeroC\Ice-3.4.2\bin\vc100
   Define MumbleNoIce to exclude Ice
 MumbleOpenSslDir  default: \dev\openssl
 MumbleZlibDir  default: \dev\zlib
 MumbleMergeModuleDir  default: C:\Program Files (x86)\Common Files\Merge Modules
 Define MumbleSSE to include SSE
 Define MumbleNoSSE2 to exclude SSE2
 Define MumbleNoG15 to exclude G15

Open installer/MumbleInstall.sln, switch to release and build the installer.

Once this completed successfully run the build_installer.pl script to include all translations into your installer.

You should now have a working .msi installer.

Build using MXE on Debian and derivates

Icons oxygen 48x48 actions view-pim-notes.png
Note:
Mumble supports MinGW since commit 10079ed9867308aad098231f86e260bd831b0ac6.

Introduction

It is possible to cross-compile Mumble using a MinGW toolchain. If you're more comfortable with a Unix-like system, you will probably prefer this method. The easiest way to cross-compile Mumble is by using MXE, which provides all the required dependencies.

Features currently not available with MinGW:

  • Overlay
  • Logitech G15 LCD
  • ZeroC Ice
  • Bonjour
Icons oxygen 48x48 actions view-pim-notes.png
Note:
In the guide there are some commands with ${ARCH} in them. You need to replace it with the desired architecture, which can be x86-64 (64 bit) or i686 (32 bit).

Installing the required MXE packages

Add MXE's repository to your system's sources

echo "deb http://pkg.mxe.cc/repos/apt/debian jessie main" > /etc/apt/sources.list.d/mxeapt.list
apt-key adv --keyserver keyserver.ubuntu.com --recv-keys D43A795B73B16ABE9643FE1AFD8FFF16DB45C6AB
apt-get update

Install the required packages

apt-get install \
	mxe-${ARCH}-w64-mingw32.static-qtbase \
	mxe-${ARCH}-w64-mingw32.static-qtsvg \
	mxe-${ARCH}-w64-mingw32.static-qttools \
	mxe-${ARCH}-w64-mingw32.static-qttranslations \
	mxe-${ARCH}-w64-mingw32.static-boost \
	mxe-${ARCH}-w64-mingw32.static-protobuf \
	mxe-${ARCH}-w64-mingw32.static-sqlite \
	mxe-${ARCH}-w64-mingw32.static-flac \
 	mxe-${ARCH}-w64-mingw32.static-ogg \
	mxe-${ARCH}-w64-mingw32.static-vorbis \
	mxe-${ARCH}-w64-mingw32.static-libsndfile

Preparing the environment

Clone Mumble's Git repository

git clone https://github.com/mumble-voip/mumble.git
cd mumble

Get the ASIO SDK

wget http://www.steinberg.net/sdk_downloads/asiosdk2.3.zip -P /tmp/
unzip /tmp/asiosdk2.3.zip -d /tmp/
mv /tmp/ASIOSDK2.3 3rdparty/asio

Export environment variable to tell QMake where MXE's protobuf compiler is

export MUMBLE_PROTOC=/usr/lib/mxe/usr/x86_64-unknown-linux-gnu/bin/protoc

Add MXE's directory to PATH

PATH=$PATH:/usr/lib/mxe/usr/bin

Build

Run QMake to process the project(s) files

${ARCH}-w64-mingw32.static-qmake-qt5 -recursive CONFIG+="release g15-emulator no-overlay no-bonjour no-elevation no-ice"

Start the build

make