Difference between revisions of "BuildingMacOSX"

From Mumble Wiki
Jump to: navigation, search
(Added link to new build docs)
 
(97 intermediate revisions by 4 users not shown)
Line 1: Line 1:
== Universal or not Universal? ==
+
{{Warning
 +
|message=The build instructions listed here only apply to Mumble v1.3.x or older. If you want to build Mumble starting from v1.4.0, checkout https://github.com/mumble-voip/mumble/tree/master/docs/dev/build-instructions
 +
}}
  
If you want to build Mumble as universal binary you will first have to build all dependencies as universal binary.
+
{{Building}}
 +
 
 +
=== Introduction ===
 +
 
 +
This guide describes the method to get a fully working and redistributable version of Mumble and Murmur that uses the Cocoa version of Qt 4.
  
== Dependencies ==
 
 
To build Mumble you will need:
 
To build Mumble you will need:
* Mac OS X 10.4 (Tiger) or 10.5 (Leopard)
+
* Mac OS X 10.8 (Mountain Lion)
* XCode (http://developer.apple.com/tools/xcode/, or from your Mac OS X install disks)
+
* Xcode 4.4
* pkg-config (http://pkg-config.freedesktop.org/)
 
* Qt 4.3.4 (http://trolltech.com/developer/downloads/qt/mac)
 
* Boost (http://www.boost.org/)
 
* Portaudio (http://www.portaudio.com/)
 
  
=== Compiling pkg-config ===
+
=== Creating a build environment ===
  
This is just a build tool, so you do not have to build it as universal binary.
+
The git repository at https://github.com/mumble-voip/mumble-releng contains pre-made scripts that build the current canonical Mumble OS X build environment.
  
If you have MacPorts installed, you probably already have pkg-config as well. If not, you can install it by doing
+
Simply clone the repo, and cd into it:
sudo port install pkgconfig
 
  
In case you want to compile it yourself, you'll have to download and unpack pkg-config.
+
  $ git clone https://github.com/mumble-voip/mumble-releng
sudo mkdir /usr/lib/pkgconfig (choose a path you like)
+
  $ cd mumble-releng/buildenv/1.3.x/osx
export PKG_CONFIG_PATH=/usr/lib/pkgconfig
 
./configure && make && sudo make install
 
  
To make the path permanent add the following line to your ''~/.profile'' file:
+
Create a MumbleBuild directory in your home dir:
export PKG_CONFIG_PATH=/usr/lib/pkgconfig
 
Also add a path entry to the pkg-config binary to this file:
 
export PATH=$PATH:/usr/local/bin
 
  
=== Compiling Qt ===
+
  $ mkdir -p ~/MumbleBuild
  
Download an unpack Qt.
+
Copy the 'env' script to the directory you created in the previous step:
  
Since we want our build to be as compatible as possible, we will build against the 10.4 (Tiger) SDK (even on Leopard). To build Qt, run:
+
  $ cp env ~/MumbleBuild/env
export MACOSX_DEPLOYMENT_TARGET="10.4"
 
./configure -universal -qt-sql-sqlite -qt-libpng -sdk /Developer/SDKs/MacOSX10.4u.sdk
 
in the Qt directory.
 
If configure runs sucessfully, continue by executing:
 
make && sudo make install
 
Qt will be installed to the directory ''/usr/local/Trolltech/Qt-4.3.4''.
 
  
To make the Qt tools visible add the following line to your ''~/.profile'' file:
+
Source the env script to set up the proper environment variables for the Mumble build environment:
export PATH=$PATH:/usr/local/Trolltech/Qt-4.3.4/bin
 
  
=== Compiling Boost ===
+
  $ source ~/MumbleBuild/env
  
As Mumble only uses some Boost headers you do not have to build/install this. Just unpack Boost.
+
Build the enviroment:
  
It is advisible to unpack Boost to /usr/local/include/, so the Boost headers will be available in /usr/local/include/boost-1_34_1/, since Mumble will look for the headers in this place by default.
+
  $ ./build-all.bash
  
If you have MacPorts installed, you can install Boost by executing
+
Once this is done, you should have a fully functional installation of Mumble's dependencies (tools and libs) in a self-contained MumbleBuild directory in your home directory.
sudo port install boost
 
  
Mumble will also look for the headers in /opt/local/include/boost-1_34_1/ - the default install location for MacPorts.
+
=== Building Mumble ===
  
=== Compiling PortAudio ===
+
Make sure you've sourced ~/MumbleBuild/env into your current shell session:
  
Download and extract the latest nightly PortAudio snapshot:
+
$ source ~/MumbleBuild/env
  
http://portaudio.com/archives/pa_snapshot.tar.gz
+
Fetch the Mumble source from Git into a directory of your choosing:
  
Build and install it:
+
git clone --recursive https://github.com/mumble-voip/mumble
  
export MACOSX_DEPLOYMENT_TARGET="10.4"
+
To build the client, execute:
export OSX_SDK="/Developer/SDKs/MacOSX10.4u.sdk"
+
 
  export OSX_CFLAGS="-isysroot $OSX_SDK -arch ppc -arch i386"
+
  cd mumble
  export OSX_LDFLAGS="-Wl,-syslibroot,$OSX_SDK -arch ppc -arch i386"
+
  qmake -recursive -Wall main.pro CONFIG+="release static"
CFLAGS="-O2 -g $OSX_CFLAGS" LDFLAGS="$OSX_LDFLAGS" ./configure --disable-mac-universal --disable-dependency-tracking --prefix=/opt/mumble/portaudio/
 
 
  make
 
  make
sudo make install
 
  
== Building Mumble ==
+
If everything went well, you should now have a Mumble.app application bundle in the release directory of the root of the source tree.
  
Fetch the Mumble source from SVN.
+
=== Building Murmur ===
  
To build the client, execute:
+
Make sure you've sourced ~/MumbleBuild/env into your current shell session:
 +
 
 +
$ source ~/MumbleBuild/env
 +
 
 +
Fetch the Mumble and Murmur source from Git into a directory of your choosing:
 +
 
 +
git clone --recursive https://github.com/mumble-voip/mumble
 +
 
 +
To build the server, execute:
  
  export PKG_CONFIG_PATH=/opt/mumble/portaudio/lib/pkgconfig/:$PKG_CONFIG_PATH
+
  cd mumble
  qmake main.pro CONFIG+='no-server release'
+
  qmake -spec unsupported/macx-clang -recursive CONFIG+="release static no-client no-dbus"
 
  make
 
  make
  
Note: If you didn't install Boost in the advised directory or through MacPorts, you should add your own include path to src/mumble/mumble.pro (search for boost).
+
If everything went well, you should now have a murmur binary in the release directory of the root of the source tree.
 +
 
 +
=== Distributing Mumble ===
 +
 
 +
If you wish to create a proper redistributable Mumble application bundle, please refer to the osxdist.py script in
 +
the macx/scripts directory. This will help you clean up your application bundle, include the needed dependencies, resources etc., and create a compressed disk image - ready to redistribute!
 +
 
 +
The script expects you to be in the root of the source tree. After executing, it will spit out a .dmg of your Mumble build in the release folder.
 +
 
 +
If you only have a Mumble.app, and have not built Murmur, you should also pass the
  
If everything went well, you should now have a Mumble.app application bundle in the release directory of the root of the source tree.
+
--no-server
  
== Distributing Mumble ==
+
parameter to the osxdist.py script. This will not attempt to package Murmur-specific files in the generated .dmg.
  
If you wish to create a proper redistributable Mumble application bundle, please refer to the osxdist.sh script in
+
The script supports code signing, and among other things, allow you to build a copy of Mumble signed with your Developer ID certificates from Apple.
the scripts directory. This will help you clean up your application bundle, include the needed dependencies, resources etc., and create a compressed disk image - ready to redistribute!
+
To build with code signing enabled, use the following three parameters to the osxdist.py script:
  
The script expects you to be in the root of the source tree. After executing, it will spit out a .dmg of your Mumble build in the release folder.
+
* --developer-id='<Name or Organization>'
 +
* --keychain=<keychain> (optional, defaults to 'login.keychain')
  
Please note that the script currently is tuned for creating real redistributable versions of Mumble, and as such only works on universal (x86, ppc) release builds!
+
[[Category:Development]]

Latest revision as of 07:40, 12 October 2020

Icons oxygen 48x48 status task-attention.png
Warning: The build instructions listed here only apply to Mumble v1.3.x or older. If you want to build Mumble starting from v1.4.0, checkout https://github.com/mumble-voip/mumble/tree/master/docs/dev/build-instructions


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


Introduction

This guide describes the method to get a fully working and redistributable version of Mumble and Murmur that uses the Cocoa version of Qt 4.

To build Mumble you will need:

  • Mac OS X 10.8 (Mountain Lion)
  • Xcode 4.4

Creating a build environment

The git repository at https://github.com/mumble-voip/mumble-releng contains pre-made scripts that build the current canonical Mumble OS X build environment.

Simply clone the repo, and cd into it:

 $ git clone https://github.com/mumble-voip/mumble-releng
 $ cd mumble-releng/buildenv/1.3.x/osx

Create a MumbleBuild directory in your home dir:

 $ mkdir -p ~/MumbleBuild

Copy the 'env' script to the directory you created in the previous step:

 $ cp env ~/MumbleBuild/env

Source the env script to set up the proper environment variables for the Mumble build environment:

 $ source ~/MumbleBuild/env

Build the enviroment:

 $ ./build-all.bash

Once this is done, you should have a fully functional installation of Mumble's dependencies (tools and libs) in a self-contained MumbleBuild directory in your home directory.

Building Mumble

Make sure you've sourced ~/MumbleBuild/env into your current shell session:

$ source ~/MumbleBuild/env

Fetch the Mumble source from Git into a directory of your choosing:

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

To build the client, execute:

cd mumble
qmake -recursive -Wall main.pro CONFIG+="release static"
make

If everything went well, you should now have a Mumble.app application bundle in the release directory of the root of the source tree.

Building Murmur

Make sure you've sourced ~/MumbleBuild/env into your current shell session:

$ source ~/MumbleBuild/env

Fetch the Mumble and Murmur source from Git into a directory of your choosing:

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

To build the server, execute:

cd mumble
qmake -spec unsupported/macx-clang -recursive CONFIG+="release static no-client no-dbus"
make

If everything went well, you should now have a murmur binary in the release directory of the root of the source tree.

Distributing Mumble

If you wish to create a proper redistributable Mumble application bundle, please refer to the osxdist.py script in the macx/scripts directory. This will help you clean up your application bundle, include the needed dependencies, resources etc., and create a compressed disk image - ready to redistribute!

The script expects you to be in the root of the source tree. After executing, it will spit out a .dmg of your Mumble build in the release folder.

If you only have a Mumble.app, and have not built Murmur, you should also pass the

--no-server

parameter to the osxdist.py script. This will not attempt to package Murmur-specific files in the generated .dmg.

The script supports code signing, and among other things, allow you to build a copy of Mumble signed with your Developer ID certificates from Apple. To build with code signing enabled, use the following three parameters to the osxdist.py script:

  • --developer-id='<Name or Organization>'
  • --keychain=<keychain> (optional, defaults to 'login.keychain')