Difference between revisions of "BuildingWindows"
|Line 192:||Line 192:|
This will also take quite a while.
This will also take quite a while.
== Protocol Buffers ==
== Protocol Buffers ==
Revision as of 11:29, 20 December 2009
- 1 Introduction
- 2 Preparations
- 2.1 Visual Studio
- 2.2 Intel C++ Compiler
- 2.3 Git
- 2.4 TortoiseSVN
- 2.5 Create the bat file
- 2.6 Boost
- 2.7 Microsoft Windows SDK
- 2.8 Microsoft DirectX SDK
- 2.9 Visual Leak Detector
- 2.10 WinDBUS
- 2.11 OpenSSL
- 2.12 MySQL
- 2.13 Qt
- 2.14 Protocol Buffers
- 2.15 libsndfile
- 2.16 libogg
- 2.17 ZeroC Ice
- 2.18 Bonjour
- 2.19 G15SDK
- 2.20 Download Mumble and Submodules
- 3 Building Mumble and Murmur
- 4 Running Mumble and Murmur
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.
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".
You'll need Visual Studio 2008 (or Visual C++ Express Edition) with SP1.
Visual Studio 2008 Professional 90 day trial: http://msdn2.microsoft.com/en-us/vs2008/products/cc268305.aspx
Visual C++ Express Edition: http://www.microsoft.com/express/vc/ (Look at the bottom right corner for "Visual C++ 2008.")
Intel C++ Compiler
You can also use the Intel C++ Compiler in conjuction with VS2008. You can find it here: http://www.intel.com/cd/software/products/asmo-na/eng/368972.htm
This is strictly optional and you can compile a perfectly working version of Mumble without this compiler following this guide. This guide does not give information on how to use the Intel compiler with VS2008 to compile Mumble, so you will need to either have the programming experience necessary to know how to do this or find the procedures to do so elsewhere.
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."
Download the most recent version of TortoiseSVN at http://tortoisesvn.net/downloads and install it. The defaults are fine.
Note: TortoiseSVN is only need to checkout the SVN of WinDBus. You can skip this step.
Create the bat file
Create C:\dev, and inside that directory create a file prep.bat containing:
@echo off SET QTDIR=C:\dev\Qt4.6.0 SET DBUSDIR=C:\dev\dbus 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" 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;%DBUSDIR%\bin;c:\dev\OpenSSL\bin;c:\dev\libsndfile;c:\dev\cmake\bin;%MYSQL%\lib\opt;%ICE%\bin;c:\dev\protobuf-2.2.0\vsprojects\Release;%PATH%
change the last line to
if you're compiling Mumble 1.1.x along with Mumble 1.2.0.
Start a new command shell (run cmd.exe) (Make sure you have Microsoft Visual C++ and Git installed before you run prep!)
cd \dev prep
After you run prep make sure a message similar to "Setting environment for using Microsoft Visual Studio 2008 x86 tools" appears.
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). When you later want to compile things, remember to call prep.bat first to set paths correctly.
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 QT4.5.1, that you see "bin" "include" and such folders as that directly inside of the folder named "Qt4.5.1". If you just see one folder and no other files, you have done it wrong.
Download http://prdownloads.sf.net/boost/boost_1_41_0.7z?download and http://prdownloads.sf.net/boost/boost-jam-3.1.17-1-ntx86.zip?download and unzip both to c:\dev
cd \dev prep cd boost_1_41_0 copy ..\boost-jam-3.1.17-1-ntx86\bjam.exe bjam --toolset=msvc --prefix=C:\dev\Boost install
This might take a while, 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_40_0 and boost-jam directories. If you get the warning, that some targets were skipped or failed, it can be ignored for our purposes.
Microsoft Windows SDK
Go here to download: http://www.microsoft.com/downloads/details.aspx?FamilyID=c17ba869-9671-4330-a63e-1fd44e0e2505&displaylang=en . At the time of this writing, the latest version is the "Microsoft Windows SDK for Windows 7 and .NET Framework 3.5 SP1". 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.
Microsoft DirectX SDK
Go to http://msdn.microsoft.com/directx/sdk/ and download the latest SDK. Install it to c:\dev\DXSDK
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.
From http://www.winkde.org/pub/kde/ports/win32/repository/win32libs/ download the following archives:
Whereas * represents the newest version on the server. Unpack all of them to 'c:\Program Files\win32libs'. If you have extracted them all correctly you should see inside of 'c:\Program Files\win32libs' "include," bin," lib," and "manifest" folders. Note that you may also download the dbus library from there, but if you do it will not automatically spawn dbus-daemon as that needs patching.
Download CMake and unpack it to c:\dev. Rename the top directory to just 'cmake'.
Checkout the SVN of WinDBus from https://windbus.svn.sourceforge.net/svnroot/windbus/trunk to c:\dev\windbus
If you skipped installing TortoiseSVN, download http://windbus.svn.sourceforge.net/viewvc/windbus/trunk.tar.gz?view=tar and extract the archive to c:\dev\. Rename the extracted trunk folder to windbus.
cd \dev prep mkdir windbus-build cd windbus-build cmake -DCMAKE_BUILD_TYPE=Release -DDBUS_INSTALL_SYSTEM_LIBS=ON -G "NMake Makefiles" c:\dev\windbus\cmake nmake nmake install
Regardless of what you say, Windbus is installed to c:\<Program Files>\dbus. Move that entire directory into c:\dev (so it ends up as c:\dev\dbus)
Copy all .dll files from c:\Program Files\win32libs\bin to c:\dev\dbus\bin
You can remove the c:\dev\windbus and c:\dev\windbus-build directories at this point.
Download the OpenSSL source named "openssl-1.0.0-beta4.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 and install ActivePerl from here: http://www.activestate.com/activeperl/
Download and install NASM from here: https://sourceforge.net/projects/nasm/
Open a new shell (so that %PATH% includes ActivePerl and NASM).
cd \dev prep cd openssl<press tab> perl Configure VC-WIN32 --prefix=c:\\dev\\OpenSSL zlib zlib-dynamic enable-static-engine -Ic:\\dev\\zlib\\include 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.
Download the latest release of MySQL Server. It can be found here: http://dev.mysql.com/downloads/mysql/5.1.html#win32 (select "Without installer (unzip in C:\)"). Unzip it to c:\dev\MySQL.
Checkout the Mumble Qt git repo to C:\dev\Qt4.6.0.
cd \dev prep git clone git://gitorious.org/+mumble-developers/qt/mumble-developers-qt.git Qt4.6.0
Start a regular command shell:
cd \dev prep cd Qt4.6.0
The demos and examples need a lot of time and disk space. You can skip them. Add the following parameter to the configure line:
-nomake demos -nomake examples
This saves time, disk space, and nerves.
configure -debug-and-release -qt-sql-sqlite -qt-sql-mysql -no-qt3support -no-exceptions -qt-zlib -qt-libpng -qt-libjpeg -openssl -dbus-linked -I c:\dev\OpenSSL\include -L c:\dev\OpenSSL\lib -I c:\dev\dbus\include -L c:\dev\dbus\lib -I c:\dev\mysql\include -L c:\dev\mysql\lib\opt -platform win32-msvc2008 nmake
This will also take quite a while.
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.
Download the 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.
Download the latest libogg-1.x.x.zip from http://downloads.xiph.org/releases/ogg/ and unpack it to c:\dev\libogg.
If you want to compile Mumble 1.1.x, you need to go to C:\dev\libogg\win32\VS2008, build the release builds of libogg, and copy C:\dev\libogg\win32\VS2008\Win32\Release_SSE2\libogg.lib to the new Folder C:\dev\libogg\lib\.
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 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
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.
Download the bonjour sdk from http://developer.apple.com/networking/bonjour/download/ and install it to c:\dev\Bonjour\ .
Note: Bonjour can be disabled by passing CONFIG+=no-bonjour to qmake.
Download the G15 software from here: http://www.logitech.com/index.cfm/434/180&cl=us,en?WT.ac=sc%7Cdownloads%7C%7Cdd 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.
Note: Support for G15 Displays can be disabled by passing CONFIG+=no-g15 to qmake.
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
To use the v1.1.x branch (which you most likely do) run this command after running the commands above:
git checkout --track -b v1.1.x origin/v1.1.x
If you are using the current branch, you will need to open git bash and cd to the mumble folder that was created. Now cd to
and then do
Building 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, and 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, replace the qmake command below with this one:
qmake CONFIG+=no-11x CONFIG+=no-asio CONFIG+=no-g15 CONFIG+=no-bonjour -recursive
To compile Mumble with Mumble 1.1.x, replace the qmake command below with this one:
qmake 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 required.
To compile Mumble:
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.
Running 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 to find out which files you will need.