Difference between revisions of "BuildingWindows"
(→Create Prep: vs2010 has a different ice folder)
|Line 136:||Line 136:|
CALL "%PROGPATH%\Microsoft Visual Studio %VSVER%\VC\vcvarsall.bat" x86
CALL "%PROGPATH%\Microsoft Visual Studio %VSVER%\VC\vcvarsall.bat" x86
TITLE Mumble Development Environment
TITLE Mumble Development Environment
Revision as of 21:05, 8 April 2011
- 1 Introduction
- 2 Preparations
- 2.1 Tools Used in Compiling
- 2.2 Libraries and Depedencies
- 3 Create Prep
- 4 Custom Dependency Paths
- 5 Commandline Instructions
- 6 Compile Mumble Dependencies
- 7 Download, Compile and Run Mumble
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 these 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.
The paths used here equal the defaults assumed in the Mumble build files. You are free to change them, but you might need to 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.
Also note, that if you are submitting a bug report for a self-built executable, we expect you to either
- Follow these instructions to the letter
- 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".
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.
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.
Tools Used in Compiling
You'll need Visual Studio 2010 (or Visual C++ Express Edition) with SP1 or later.
Visual Studio 2010 trials: http://www.microsoft.com/visualstudio/en-us/try
Visual C++ 2010 Express Edition: http://www.microsoft.com/express/Downloads/#2010-Visual-CPP
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."
After you install Git, start a command prompt and run
git config --global core.symlinks true git config --global core.autocrlf true
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.
ActivePerl and NASM
Download and install ActivePerl from here: http://www.activestate.com/activeperl/
Download and install NASM from here: http://www.nasm.us/
7-Zip and Notepad++
Get 7-Zip 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.
Notepad++. After you install Notepad++, start it, go to Preferences -> New Document/Default Directory, and check "Unix" in the Format box.
Libraries and Depedencies
Download the bonjour sdk from http://developer.apple.com/opensource/ and install it to c:\dev\Bonjour\ .
Note: Bonjour can be disabled by passing CONFIG+=no-bonjour to qmake. Visit http://www.bugmenot.com/view/daw.apple.com for login info.
Download the G15 software from here: http://www.logitech.com/en-us/434/3498?section=downloads&WT.ac=sc%7Cdownloads%7C%7Cdd and install it.
Now go to C:\Program Files\Logitech Gaming Software\LCDSDK and extract "LCDSDK_3.06.109.zip". Take the folder that has been extracted and rename it to G15SDK. Put this folder into c:\dev.
Note: Support for G15 Displays can be disabled by passing CONFIG+=no-g15 to qmake.
Download the Win32 installer 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.
Microsoft Windows SDK
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
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.
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 this how to fix it.
Microsoft DirectX SDK
Go to http://msdn.microsoft.com/directx/sdk/ and download the latest SDK. Install it to c:\dev\DXSDK
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.
Download Protocol Buffers from 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.
Import 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.
Visual Leak Detector
Download VLD and install it to C:\dev\vld\.
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 rename it to vld.
Note: VLD is only enabled for debug builds.
Download the latest version of ZeroC Ice from http://www.zeroc.com/download.html and make sure you select the VS2010 version. Install to c:\dev\Ice
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.
Create C:\dev, and inside that directory create a file prep.cmd containing:
@echo off SET VSVER=10.0 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)% ( GOTO amd64 ) ELSE ( GOTO x86 ) :amd64 SET PROGPATH=%PROGRAMFILES(X86)% GOTO Common :x86 SET PROGPATH=%PROGRAMFILES% GOTO Common :Common CALL "%PROGPATH%\Microsoft Visual Studio %VSVER%\VC\vcvarsall.bat" x86 SET PATH=%QTDIR%\bin;c:\dev\OpenSSL\bin;c:\dev\libsndfile;%MYSQL%\lib\opt;%ICE%\bin\vc100;c:\dev\protobuf-2.4.0a\vsprojects\Release;%PROGPATH%\NASM;%VLD_DIR%\bin;%PATH% TITLE Mumble Development Environment
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 -MX 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. In this file you can override all paths found in winpaths_default.pri. For example:
OPENSSL_PATH = /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.
Whenever something appears
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 2010 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
Download the most recent Windows version of the Boost C++ libraries and unzip it to c:\dev
cd \dev prep cd boost_* 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_* directory. If you get the warning, that some targets were skipped or failed, it can be ignored for our purposes.
Download the OpenSSL source named "openssl-1.0.0d.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 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-dynamic --with-zlib-include=/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.
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.7-mumble branch:
cd QtMumble git checkout --track -b 4.7-mumble origin/4.7-mumble
Note: For the latest Mumble Git, change the above "4.7" to the latest version listed 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 to not compile them:
-nomake demos -nomake examples
This saves time, disk space, and nerves.
Same with webkit:
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
This will also take quite a while, something around 4 hours.
You may also want to drop mysql support, if you will only use mumble with the default sqlite and/or you only use it for development (without mysql).
A rather minimal configure is thus:
configure -debug-and-release -qt-sql-sqlite -no-qt3support -no-exceptions -qt-zlib -qt-libpng -qt-libjpeg -openssl -I %DIR%\OpenSSL\include -L %DIR%\OpenSSL\lib -platform win32-msvc2010 -no-dbus -nomake demos -nomake examples -no-webkit
This will take about 1 hour (on dual core, with MP flag enabled for using multiple processes for compilation) rather then the above mentioned 4 hours.
Download, Compile and Run Mumble
Download Mumble and Submodules
To clone the repositories:
cd \dev prep git clone git://github.com/mumble-voip/mumble.git 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:
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 ASIO, G15, Bonjour, and with disabled privilege elevation (would require a valid code signing certificate) replace the qmake command below with this one:
qmake CONFIG-=sse2 CONFIG+=no-asio CONFIG+=no-g15 CONFIG+=no-bonjour CONFIG+=no-elevation -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
instead of the last
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
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.