Difference between revisions of "BuildingWindows"

From Mumble Wiki
Jump to: navigation, search
m (Create Prep)
(Build using MXE on Debian and derivates)
 
(170 intermediate revisions by 16 users not shown)
Line 1: Line 1:
 
{{Building}}
 
{{Building}}
  
= Introduction =
+
= 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'').
  
Mumble has quite a few dependencies for building on Windows, and as the feature set grows, so does the list of dependencies. This page will try to detail the steps required to set up a Win32 build environment suitable for compiling the current code found in our repository. Be aware that this steps might not work for older revisions of Mumble as dependencies might have been removed or updated to an incompatible version in the meantime. '''Note that you must follow each step in order, or you will have problems.'''
+
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.
  
The paths used here equal the defaults assumed in the Mumble build files. You are free to change them, but you might need to [[#Custom Dependency Paths|adjust the build files]] themselves. If you find any problems or incorrect steps in this article please either correct them or contact us and we will try our best to resolve the issue.
+
Ok. So you're ready to start working.
  
Also note, that if you are submitting a bug report for a self-built executable, we expect you to either
+
= Build using MSVC on Windows =
* Follow these instructions to the letter
 
or
 
* Report any deviations from these instructions
 
  
Deviations means anything, from "I installed to the D: drive" to "I changed the gcc build options for Qt" or "I used another version of Speex".
+
== Introduction ==
  
'''A note to those following this guide''': When you extract compressed files, sometimes they will have container folders and sometimes they will not. Please ensure (for example) that when you extract a compressed file like protobuf-2.2.0.zip, you see "bin" "include" and such folders as that directly inside of the folder named "protobuf-2.2.0". If you just see one folder and no other files, then you need to open that folder, and use the folder that is inside of it.
+
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 [https://www.cygwin.com/ Cygwin].
  
'''Also remember that this guide may not be updated every single time a build dependency gets updated. It's up to you to make sure that you have the latest versions on the various dependencies; it would also be appreciated if you would update this wiki to reflect any changes you run into.'''
+
The [https://github.com/mumble-voip/mumble-releng mumble-releng] Github repository has an [https://github.com/mumble-voip/mumble-releng/blob/master/buildenv/1.3.x/win32-static/README up-to-date README] on how to create the build environment!
 +
{{Notice|message=
 +
The most up-to-date information on how to create a Mumble build environment are always to be found in this README file!
 +
}}
 +
{{Elaboration|message=
 +
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.
 +
}}
  
= Preparations =
+
== Software you will need ==
 +
{{Notice|message=
 +
We currently depend on Visual Studio to be in their default locations, and the Windows 7 SDK to be in ''C:\Program Files (x86)\Microsoft SDKs\Windows\v7.1A'' (rather than the default ''C:\Program Files\…'').
 +
}}
  
== Tools Used in Compiling ==
+
* ''Visual Studio Community 2015 Update 3'': You need MSVC 2015. During installation you can deselect the Windows SDKs, because we are going to install the up-to-date one, listed below.
=== Visual Studio ===
+
* [https://www.microsoft.com/en-us/download/details.aspx?id=8279 Windows SDK 7] for XP/x86 Overlay (You may have to [http://stackoverflow.com/questions/19366006/error-when-installing-windows-sdk-7-1#23032807 temporarily remove ''Microsoft Visual C++ 2010 * Redistributable'' for the installer to work].)
 +
* [https://developer.microsoft.com/en-us/windows/downloads/windows-10-sdk Windows SDK] (If you are on Windows 7, don't select "Windows Performance Toolkit", because it isn't compatible)
 +
* [https://msysgit.github.io/ Git]: You can use any version of Git, it only has to be in your PATH variable.
  
You'll need Visual Studio 2008 (or Visual C++ Express Edition) with SP1.
+
== 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 that directory, then
 +
git clone https://github.com/mumble-voip/mumble-releng.git mumble-releng
  
Visual Studio 2008 Professional 90 day trial: http://msdn2.microsoft.com/en-us/vs2008/products/cc268305.aspx
+
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 ''C:\MumbleBuild'' directory named with a date and shortened commit hash like ''win32-static-1.3.x-2015-05-25-1234ab7''.
  
Visual C++ Express Edition: http://www.microsoft.com/express/vc/ (Look at the bottom right corner for "Visual C++ 2008.")
+
If everything went right Windows Explorer should open up the new build environment directory as named above.
  
'''Note: The latest Mumble Git code supports Visual Studio 2010. Download it here: http://www.microsoft.com/express/downloads/#2010-Visual-CPP'''
+
== Build Mumble's dependencies ==
 +
To start building Mumble's dependencies, double-click the "MumbleBuild - cygwin" shortcut. This will open a cygwin terminal. To change the current directory to the ''build environment's local clone'' of the mumble-releng repository type:
 +
cd mumble-releng/buildenv/1.3.x/win32-static
  
=== Git ===
+
{{Notice|message=
 +
This mumble-releng directory is a copy. Should you want to update your build environment in the future, proceed from the original.
 +
}}
  
Download the most recent Git from http://code.google.com/p/msysgit/downloads/list and install it. Make sure you select "Run Git from the Windows Command Prompt."
+
To download and build all dependencies (this will take a long time!), execute
 +
./build-all.bash
  
'''After you install Git, start a command prompt and run'''
+
Once all dependencies are built, you will be returned to your Cygwin shell. Make sure it did not stop because of an error.
git config --global core.symlinks true
 
git config --global core.autocrlf true
 
  
=== TortoiseGit ===
+
The built dependencies are located in the corresponding ''.build'' folder.
  
[http://code.google.com/p/tortoisegit/downloads/list TortoiseGit] is a GUI frontend for Git. You can install this along with the one above for realtime information about changes to the Git code.
+
== 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.
  
=== ActivePerl and NASM ===
+
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
 +
{{Notice|message=
 +
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.
 +
}}
  
Download and install ActivePerl from here: http://www.activestate.com/activeperl/<br>
+
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.
  
Download and install NASM from here: https://sourceforge.net/projects/nasm/
+
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.
  
=== 7-Zip and Notepad++ ===
+
== (Optional) Visual Leak Detector ==
  
Get 7-Zip [http://7-zip.org/ here]. After you install it, start the 7-Zip File Manager, go to Tools -> Options, and select the file associations you want. We recommend selecting .zip and .7z file extensions.
+
{{Notice|message=
 +
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''.
 +
}}
  
[https://sourceforge.net/projects/notepad-plus/files/ Notepad++]. After you install Notepad++, start it, go to Preferences -> New Document/Default Directory, and check "Unix" in the Format box.
+
[http://dmoulding.googlepages.com/vld Download] VLD and install it to its default install location.
  
== Libraries and Depedencies ==
+
If you're using Visual C++ Express Edition, you will need to manually extract the files using a tool like [http://7-zip.org/ 7-zip ]. Extract it to ''C:\dev\'' and adjust [[BuildingWindows#Custom_Dependency_Paths|the VLD_PATH]] to point to it.
  
=== Bonjour ===
+
{{Notice|message=
Download the bonjour sdk from http://developer.apple.com/opensource/ and install it to ''c:\dev\Bonjour\'' .
+
VLD is only enabled for debug builds. If you only compile Release builds you do not need it.
 +
}}
  
'''Note:''' Bonjour can be disabled by passing ''CONFIG+=no-bonjour'' to qmake. Visit http://www.bugmenot.com/view/daw.apple.com for login info.
+
== (Optional) Custom Dependency Paths ==
  
=== G15SDK ===
+
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:
Download the G15 software from here: http://www.logitech.com/en-us/434/3498?section=downloads&WT.ac=sc|downloads||dd and install it.
 
  
Now go to ''C:\Program Files\Logitech\GamePanel Software\LCD Manager\SDK'' and extract "LCDSDK_3.02.173.zip". Take the folder that has been extracted and rename it to ''G15SDK''. Put this folder into ''c:\dev''.
+
  OPENSSL_PATH = C:\\dev\MyOpenSSLIsSomewhereElse
 +
  ICE_PATH = C:\\Program Files (x86)\\ZeroC\\Ice-3.4.1
  
'''Note:''' Support for G15 Displays can be disabled by passing ''CONFIG+=no-g15'' to qmake.
+
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.
  
=== libsndfile ===
 
Download the Win32 binary release from http://www.mega-nerd.com/libsndfile/#Download and install it to ''c:\dev\libsndfile\'' . Make sure the libsndfile-1.dll is visible to the executables.
 
  
'''Note''': This dependency is not needed for the server.
+
'''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:
  
=== libogg ===
+
# Include custom file if it exists
Download the latest libogg-1.x.x.zip from http://downloads.xiph.org/releases/ogg/ and unpack it to ''c:\dev\libogg''.
+
exists(winpaths_custom.pri) {
 +
include(winpaths_custom.pri)
 +
}
  
If you want to compile Mumble 1.1.x, you need to go to ''C:\dev\libogg\win32\VS2008'', start the libogg_dynamic project, then build the release builds of libogg. Copy ''C:\dev\libogg\win32\VS2008\Win32\Release_SSE2\libogg.lib'' to the new folder ''C:\dev\libogg\lib\''.
+
== (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.
  
'''Note:''' This dependency is not needed if you do not want to compile the Mumble compatibility client (Mumble 1.1.x). The Mumble compatibility client can be disabled by passing ''CONFIG+=no-11x'' to qmake. This dependency is not needed for building the server.
+
Download and install the latest WIX stable Version (currently 3.8) from [http://wixtoolset.org/releases/ here].
  
=== Microsoft Windows SDK ===
+
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
  
Go here to download: http://msdn.microsoft.com/en-us/windows/bb980924.aspx . At the time of this writing, the latest version is the "Microsoft Windows SDK for Windows 7 and .NET Framework 4". Install it to ''C:\dev\WinSDK''
+
Open installer/MumbleInstall.sln, switch to release and build the installer.
  
As you are going through the installer you will come to a window where you will see two main categories and then subcategories below them. Uncheck the green check boxes next to “Documentation” and “Samples”. Continue with the installation. These take a long time to download and are not really needed for Mumble.
+
Once this completed successfully run the ''build_installer.pl'' script to include all translations into your installer.
  
After installing Windows SDK then you must change version to use. Start C:\dev\WinSDK\Setup\WindowsSdkVer.exe and change version to 7.x. If you got error that you don't have installed VS2005 or VS2008, then see [http://blogs.msdn.com/b/windowssdk/archive/2009/08/21/windows-sdk-configuration-tool-may-report-an-error-when-os-display-format-is-not-english.aspx this how to fix it].
+
You should now have a working .msi installer.
  
=== Microsoft DirectX SDK ===
+
= Build using MXE on Debian and derivates =
  
Go to http://msdn.microsoft.com/directx/sdk/ and download the latest SDK. Install it to ''c:\dev\DXSDK''
+
{{Notice|message=
 +
Mumble supports MinGW since [https://github.com/mumble-voip/mumble/commit/10079ed9867308aad098231f86e260bd831b0ac6 commit 10079ed9867308aad098231f86e260bd831b0ac6] (March 2017, first stable version 1.3.0).
 +
}}
  
=== MySQL ===
+
== Introduction ==
  
Download the latest release of MySQL Server (x86, 32-bit). It can be found here: http://dev.mysql.com/downloads/mysql/ (select "Without installer (unzip in C:\)"). Unzip it to ''c:\dev\MySQL''.
+
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.
  
=== Protocol Buffers ===
+
Features currently not available with MinGW:
 +
* Overlay
 +
* Logitech G15 LCD
 +
* ZeroC Ice
 +
* Bonjour
  
Download Protocol Buffers from [http://code.google.com/p/protobuf/ Google] (''protobuf-x.y.z.zip'')  and unpack it to ''c:\dev\protobuf-z.y.z''. Follow the documentation in ''c:\dev\protobuf-x.y.z\vsprojects\readme.txt''. Note that if the release number changes you will need to change prep.bat to whatever ''z.y.z'' changed to or you won't be able to call ''protoc.exe''.
+
{{Notice|message=
 +
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).
 +
}}
  
If you're using VS2010, convert the project, and when it's finished, find a dropdown box at the top right of VS2010 that says "Debug" on it. Change that to "Release". Now right click the "Solution 'protobuf' (9 projects)" at the top left of VS2010 and select "Batch Build..." Select all the releases and build them; you'll get errors, but for our purposes, you can ignore them.
+
== Installing the required MXE packages ==
  
=== Visual Leak Detector ===
+
Add MXE's repository to your system's sources:
  
[http://dmoulding.googlepages.com/vld Download] VLD and install it to ''C:\dev\vld\''.
+
'''Debian'''
 +
echo "deb https://dl.mumble.info/mirror/pkg.mxe.cc/repos/apt stretch main" | sudo tee /etc/apt/sources.list.d/mxe.list
 +
'''Ubuntu'''
 +
echo "deb https://dl.mumble.info/mirror/pkg.mxe.cc/repos/apt xenial main" | sudo tee /etc/apt/sources.list.d/mxe.list
  
If you're using Visual C++ Express Edition, you will need to manually extract the files using a tool like [http://7-zip.org/ 7-zip ]. Extract it to ''C:\dev\'' and rename it to ''vld''.
+
Add the repository's key:
 +
sudo apt-key adv --keyserver keyserver.ubuntu.com --recv-keys 86B72ED9
  
'''Note:''' VLD is only enabled for debug builds.
+
Update packages index:
 +
sudo apt update
  
=== ZeroC Ice ===
+
Install the required packages
 +
sudo apt 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
  
Download the latest version of ZeroC Ice from http://www.zeroc.com/download.html and make sure you select the VS2008 version. Install to ''c:\dev\Ice''
+
== Preparing the environment ==
  
'''Note:''' Ice can be disabled by passing ''CONFIG+=no-ice'' to qmake. Bear in mind that the [[Ice]] RPC Interface is the recommended way to control the server. This dependency is not needed for building the client.
+
Clone Mumble's Git repository
 +
git clone https://github.com/mumble-voip/mumble.git
 +
cd mumble
  
= Create Prep =
+
Get the ASIO SDK
 +
wget https://www.steinberg.net/sdk_downloads/asiosdk2.3.zip -P /tmp/
 +
unzip /tmp/asiosdk2.3.zip -d /tmp/
 +
mv /tmp/ASIOSDK2.3 3rdparty/asio
  
Create ''C:\dev'', and inside that directory create a file ''prep.bat'' containing:
+
Export environment variable to tell QMake where MXE's protobuf compiler is
@echo off
+
  export MUMBLE_PROTOC=/usr/lib/mxe/usr/x86_64-pc-linux-gnu/bin/protoc
  SET QTDIR=C:\dev\QtMumble
 
SET LIB=
 
SET VLD_DIR=C:\dev\vld
 
SET MYSQL=c:\dev\mysql
 
SET ICE=c:\dev\Ice
 
CALL "%DXSDK_DIR%\Utilities\bin\dx_setenv.cmd" x86
 
IF DEFINED %PROGRAMFILES(X86)% (
 
CALL "%PROGRAMFILES(X86)%\Microsoft Visual Studio 9.0\VC\vcvarsall.bat" x86
 
) ELSE (
 
CALL "%PROGRAMFILES%\Microsoft Visual Studio 9.0\VC\vcvarsall.bat" x86
 
)
 
SET PATH=%QTDIR%\bin;c:\dev\OpenSSL\bin;c:\dev\libsndfile;%MYSQL%\lib\opt;%ICE%\bin;c:\dev\protobuf-2.3.0\vsprojects\Release;%PATH%;C:\Program Files (x86)\NASM
 
change the last line to
 
SET PATH=%QTDIR%\bin;c:\dev\OpenSSL\bin;c:\dev\libsndfile;%MYSQL%\lib\opt;%ICE%\bin;c:\dev\protobuf-2.3.0\vsprojects\Release;C:\dev\libogg\win32\VS2008\Win32\Release;%PATH%;C:\Program Files (x86)\NASM
 
if you're compiling Mumble 1.1.x along with Mumble 1.2.x.
 
  
Change Program Files (x86) to Program Files if you're on Win32.
+
Add MXE's directory to PATH
 +
PATH=$PATH:/usr/lib/mxe/usr/bin
  
'''Change
+
== Build ==
 
 
CALL "%PROGRAMFILES(X86)%\Microsoft Visual Studio 9.0\VC\vcvarsall.bat" x86
 
 
 
'''to'''
 
 
 
CALL "%PROGRAMFILES(X86)%\Microsoft Visual Studio 10.0\VC\vcvarsall.bat" x86
 
 
 
'''if you installed Visual Studio 2010.'''
 
 
 
'''Notice:''' If you want to speed up Qt compilation you can add extra two lines to the file:
 
SET QMAKE_CFLAGS=-MX
 
SET QMAKE_CXXFLAGS= /MP
 
Change -M'''X''' to the number of used processors, for example '''-M8''' is for '''eight''' procesors, and '''-M4''' would be for '''four''' processors, and so on.
 
 
 
= 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 C:\dev directory structure. To specify the custom paths you need to create a ''winpaths_custom.pri'' file to the root of your Mumble project. The template for this file is below. Modify the file by specifying the library paths. '''Remember to use forward slashes ''/'' instead of backslashes ''\'' as directory separators.'''
 
 
 
ICE_PATH = /dev/Ice-3.4.1
 
PROTOBUF_PATH = /dev/protobuf-2.3.0
 
OPENSSL_PATH = /dev/OpenSSL
 
LIBSNDFILE_PATH = /dev/libsndfile
 
BOOST_PATH = /dev/Boost
 
VLD_PATH = /dev/vld
 
BONJOUR_PATH = /dev/Bonjour
 
ASIO_PATH = /dev/mumble/asio
 
G15SDK_PATH = /dev/G15SDK/SDK
 
LIBOGG_PATH = /dev/libogg
 
  
 +
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
  
 
[[Category:Development]]
 
[[Category:Development]]
 
= 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
 
prep
 
you would type "cd mumble" in your command prompt, and press enter, and then you would type "prep", and press enter.
 
 
Ok. So you're ready to start compiling.
 
 
Start a new command shell (run ''cmd.exe'')
 
cd \dev
 
prep
 
 
After you run prep make sure a message similar to "Setting environment for using Microsoft Visual Studio 2008 x86 tools" appears.
 
 
 
'''''When you later want to compile a dependency or program, always remember to call prep.bat first to set paths correctly.'''''
 
 
= Compile Mumble Dependencies =
 
 
=== Boost ===
 
 
Download the Windows version of [http://www.boost.org/users/news/version_1_45_0 Boost C++ libraries] and unzip it to ''c:\dev''
 
 
cd \dev
 
prep
 
cd boost_1_4x_0
 
bootstrap.bat
 
bjam --toolset=msvc --prefix=C:\dev\Boost install
 
 
This might take a while (like hour), but when done you'll have Boost installed.
 
Note that none of the other build dependencies do themselves depend on boost, so if you want you can just continue in a new command shell (but remember to call ''prep.bat''). Once all is done, you can safely delete the boost_1_4x_0 directory. If you get the warning, that some targets were skipped or failed, it can be ignored for our purposes.
 
 
=== OpenSSL ===
 
 
Download the OpenSSL source named "openssl-1.0.0a.tar.gz" from here http://www.openssl.org/source/. Unpack it to ''c:\dev'' (it will create a directory called openssl-x.y.z)
 
 
Download [http://www.zlib.net/ zlib] and unpack it to C:\dev\zlib
 
 
'''Note:''' Copy files from ''C:\dev\zlib\include'' to ''C:\dev\zlib\'' (zconf.h and zlib.h)
 
 
cd \dev
 
prep
 
cd openssl<press tab>
 
perl Configure VC-WIN32 --prefix=c:\\dev\\OpenSSL zlib zlib-dynamic enable-static-engine -Ic:\\dev\\zlib
 
ms\do_nasm
 
nmake -f ms\ntdll.mak
 
nmake -f ms\ntdll.mak install
 
You can remove ''c:\dev\openssl-x.y.z'' after this.
 
 
=== Qt ===
 
 
Checkout the Mumble Qt git repo to C:\dev\QtMumble.
 
cd \dev
 
prep
 
git clone git://gitorious.org/+mumble-developers/qt/mumble-developers-qt.git QtMumble
 
 
Switch to the 4.6-mumble branch:
 
 
cd QtMumble
 
git checkout --track -b 4.6-mumble origin/4.6-mumble
 
 
'''Note: For the latest Mumble Git, change the above "4.6" to "4.7" or the latest version listed [http://gitorious.org/+mumble-developers/qt/mumble-developers-qt here].'''
 
 
The demos and examples need a lot of time and disk space. You can skip them.
 
Add the following parameters to the configure line listed below:
 
-nomake demos -nomake examples
 
This saves time, disk space, and nerves.
 
 
Now do
 
configure -debug-and-release -qt-sql-sqlite -qt-sql-mysql -no-qt3support -no-exceptions -qt-zlib -qt-libpng  -qt-libjpeg  -openssl -I c:\dev\OpenSSL\include -L c:\dev\OpenSSL\lib -I c:\dev\mysql\include -L c:\dev\mysql\lib\opt -platform win32-msvc2008 -no-dbus
 
 
or, if you're running VS2010,
 
configure -debug-and-release -qt-sql-sqlite -qt-sql-mysql -no-qt3support -no-exceptions -qt-zlib -qt-libpng  -qt-libjpeg  -openssl -I c:\dev\OpenSSL\include -L c:\dev\OpenSSL\lib -I c:\dev\mysql\include -L c:\dev\mysql\lib\opt -platform win32-msvc2010 -no-dbus
 
 
nmake
 
 
This will also take quite a while, something around 4 hours.
 
 
= Download, Compile and Run Mumble =
 
 
=== Download Mumble and Submodules ===
 
 
To clone the repositories:
 
 
cd \dev
 
prep
 
git clone git://mumble.git.sourceforge.net/gitroot/mumble/mumble mumble
 
cd mumble
 
git submodule init
 
git submodule update
 
 
=== Compile Mumble and Murmur ===
 
 
Once all of the above is done we can get to compiling Mumble itself.
 
 
If you want to have ASIO support you have to install an additional, proprietary, ASIO SDK.
 
 
There are four dependencies that most people who make their own compiles will not need:
 
# g15
 
# asio
 
# bonjour
 
# 11x
 
 
The bonjour dependency is useful if you want to browse servers across a local network, but you can disable it if this feature is not needed.
 
 
To compile Mumble without Mumble 1.1.x, ASIO, G15, and Bonjour, replace the qmake command below with this one:
 
 
qmake CONFIG-=sse2 CONFIG+=no-11x CONFIG+=no-asio CONFIG+=no-g15 CONFIG+=no-bonjour -recursive
 
 
To compile Mumble with Mumble 1.1.x, but without ASIO, Bonjour, and G15 replace the qmake command below with this one:
 
 
qmake CONFIG-=sse2 CONFIG+=no-asio CONFIG+=no-bonjour CONFIG+=no-g15 -recursive
 
 
Note that the compile ''will fail'' if you leave out these build flags and do not have the SDK(s) required.
 
 
If you get errors about qt_*.ts files, then go to ''C:\dev\QtMumble\translations'' and copy and rename any qt_*.qm's to qt_*.ts.
 
 
To compile Mumble:
 
 
Open a new command prompt, then do
 
 
cd \dev
 
prep
 
cd mumble
 
qmake
 
nmake clean
 
nmake
 
 
Note that this builds the debug versions, which is what we strongly recommend to use while developing. If you want to send the binary to someone else, use
 
nmake release
 
instead of the  last
 
nmake
 
command listed above. This will result in a much smaller binary with fewer dependencies.
 
 
=== Run Mumble and Murmur ===
 
 
Once compiled, you can go into ''c:\dev\mumble\release'' or (''\debug'' if you compiled the debug version) and can execute mumble.exe or murmur.exe. Before executing Mumble or Murmur you need to open a command prompt and do
 
cd \dev
 
prep
 
cd mumble\debug (or release)
 
Then execute either Mumble or Murmur ''from the command prompt'' with
 
mumble.exe
 
or
 
murmur.exe
 
 
If you want to run the release build directly from Windows Explorer, you will need to collect all the library files into one folder, along with the executables you built when you compiled Mumble. Have a look at the files the official Mumble installer creates in ''Program Files\Mumble'', and/or check the Mumble.nsi installer file at ''C:\dev\Mumble\installer\Mumble.nsi'' to find the files you need.
 

Latest revision as of 21:38, 12 September 2019

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:
We currently depend on Visual Studio to be in their default locations, and the Windows 7 SDK to be in C:\Program Files (x86)\Microsoft SDKs\Windows\v7.1A (rather than the default C:\Program Files\…).

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 that directory, then

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

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 C:\MumbleBuild directory named with a date and shortened commit hash like win32-static-1.3.x-2015-05-25-1234ab7.

If everything went right Windows Explorer should open up the new build environment directory as named above.

Build Mumble's dependencies

To start building Mumble's dependencies, double-click the "MumbleBuild - cygwin" shortcut. This will open a cygwin terminal. To change the current directory to the build environment's local clone of the mumble-releng repository type:

cd mumble-releng/buildenv/1.3.x/win32-static
Icons oxygen 48x48 actions view-pim-notes.png
Note:
This mumble-releng directory is a copy. Should you want to update your build environment in the future, proceed from the original.

To download and build all dependencies (this will take a long time!), execute

./build-all.bash

Once all dependencies are built, you will be returned to your Cygwin shell. Make sure it did not stop because of an error.

The built dependencies are located in the corresponding .build folder.

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 (March 2017, first stable version 1.3.0).

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:

Debian

echo "deb https://dl.mumble.info/mirror/pkg.mxe.cc/repos/apt stretch main" | sudo tee /etc/apt/sources.list.d/mxe.list

Ubuntu

echo "deb https://dl.mumble.info/mirror/pkg.mxe.cc/repos/apt xenial main" | sudo tee /etc/apt/sources.list.d/mxe.list

Add the repository's key:

sudo apt-key adv --keyserver keyserver.ubuntu.com --recv-keys 86B72ED9

Update packages index:

sudo apt update

Install the required packages

sudo apt 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 https://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-pc-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