1Binary versions
2===============
3
4Binary versions for Win32 of the most recent version of mumble are provided
5at http://www.mumble.info/
6
7The only legitimate releases of Mumble will be on www.mumble.info, any other
8place offering Mumble is likely to contain trojans or viruses.
9
10Windows pre-requisites
11======================
12
13Detailed build instructions are available at
14http://wiki.mumble.info/wiki/BuildingWindows and it is highly recommended
15to follow them to the letter.
16
17Mac OS X pre-requisites
18=======================
19
20Detailed build instructions are available at
21http://wiki.mumble.info/wiki/BuildingMacOSX and it is highly recommended
22to follow them to the letter.
23
24Linux pre-requisites
25====================
26
27Detailed build instructions are available at
28http://wiki.mumble.info/wiki/BuildingLinux and it is highly recommended
29to follow them to the letter.
30
31Please note that in addition to the depending libraries, you also need
32lsb_release installed.
33
34Building Mumble and Murmur
35==========================
36
37To build mumble and murmur, type
38qmake main.pro
39make release
40
41You may need to specify dependency installation paths. Please refer to the
42files in the qmake directory. (For windows, copy winpaths_default.pri to
43winpaths_custom.pri and adjust the copies contents.)
44After building, the binaries will be in the release/ directory.
45
46The qmake step supports a number of configurations options. To enable an
47option, simply add CONFIG+=<option> to the end. If you want to change these
48after your initial setup, you'll also need to pass -recursive.
49So, to build without the server and without ASIO, the above line would be
50
51qmake main.pro CONFIG+=no-server CONFIG+=no-asio -recursive
52
53CONFIG+=no-client
54 Don't build the client (Mumble)
55
56CONFIG+=no-server
57 Don't build the server (Murmur)
58
59CONFIG+=no-bundled-celt (Mumble)
60 Don't use the included version of CELT, but look for one on the system.
61 Note that this requires that you have CELT 0.7.0 or 0.7.1 installed on
62 your system as CELT does not maintain bitstream compatibility.
63
64CONFIG+=no-bundled-speex (Mumble)
65 Don't use the included version of Speex, but look for one on the system.
66 Note that this requires your system-installed Speex to be at least version
67 1.2.0.
68
69CONFIG+=no-opus (Mumble)
70 Don't build Opus support at all.
71
72CONFIG+=no-bundled-opus (Mumble)
73 Don't use the included version of Opus, but look for one on the system.
74
75CONFIG+=no-rnnoise (Mumble)
76 Don't build RNNoise support at all.
77
78CONFIG+=no-bundled-rnnoise (Mumble)
79 Don't use the included version of RNNoise, but look for one on the system.
80
81CONFIG+=sbcelt (Mumble, Linux, OSX, FreeBSD)
82 Use the SBCELT library for decoding CELT frames. Enabling this option will
83 build Mumble in a mode that forces all CELT frames to be decoded in a
84 separate, sandboxed, helper process. CELT frames will still be encoded using
85 Mumble's bundled CELT library.  This option implies CONFIG+=bundled-celt.
86
87CONFIG+=optimize
88 Build a heavily optimized version, specific to the machine it's being
89 compiled on.
90
91CONFIG+=static (Mumble)
92 Build Mumble as a static binary.
93
94CONFIG+=no-crash-report (Mumble)
95 Don't include support for reporting crashes to the Mumble developers.
96
97CONFIG+=no-plugins (Mumble)
98 Don't build plugins.
99
100CONFIG+=universal (OSX)
101 Build a universal binary build of Mumble for i386 and ppc instead of the
102 default x86-64-only build. The universal build is meant to be used with
103 the Carbon version of Qt, and is compatible with 10.4+.
104 The x86-64 build of Mumble is compatible with 10.5+ and requires a Cocoa
105 version of Qt.
106
107CONFIG+=no-dbus (Mumble)
108 Don't include DBus support on Mumble. This has no effect on Murmur, which
109 requires DBus to work.
110
111CONFIG+=no-g15 (Mumble)
112 Don't include support for the G15 keyboard (and compatible devices).
113
114CONFIG+=no-jackaudio (Mumble)
115 Don't build support for JackAudio.
116
117CONFIG+=no-asio (Mumble, Win32)
118 Don't build support for ASIO audio input.
119
120CONFIG+=no-directsound (Mumble, Win32)
121 Don't build support for DirectSound.
122
123CONFIG+=no-wasapi (Mumble, Win32)
124 Don't build support for WASAPI.
125
126CONFIG+=portaudio (Mumble, Unix, OSX)
127 Build support for PortAudio.
128
129CONFIG+=no-pulseaudio (Mumble, Unix)
130 Don't build support for PulseAudio.
131
132CONFIG+=no-oss (Mumble, Linux)
133 Don't build support for OSS. Mumble supports OSS4 if you have the correct
134 header files.
135
136CONFIG+=no-alsa (Mumble, Linux)
137 Don't build support for ALSA.
138
139CONFIG+=no-speechd (Mumble, Linux)
140 Don't build support for Speech Dispatcher.
141
142CONFIG+=no-update (Mumble)
143 Default disable the checking of new versions. (For distributions)
144
145CONFIG+=no-vorbis-recording (Mumble)
146 Don't include support for ogg format for recordings.
147
148CONFIG+=no-embed-qt-translations (Mumble)
149 Don't embed the translations for Qt, load them from the system. (For
150 distributions).
151
152CONFIG+=no-ice (Murmur)
153 Don't build support for Ice RPC.
154
155CONFIG+=grpc (Murmur, Linux)
156 Include experimental support for gRPC.
157 We do not currently recommend that packagers
158 ship packages to end users with gRPC enabled.
159 The gRPC library's API is not yet stable, and
160 Murmur's gRPC interface is not yet frozen, and
161 will most likely change in the future.
162 Support for gRPC requires Qt 5.
163
164CONFIG+=no-bonjour
165 Don't build support for Bonjour.
166
167CONFIG+=no-overlay (Mumble)
168 Don't build the overlay library.
169
170CONFIG+=no-xinput2 (Mumble, Linux)
171 Don't build support for XI2.
172
173CONFIG+=no-gkey (Mumble, Win32)
174 Don't build in support for Logitech G-Keys.
175 Note: This feature does not require any build-
176 time dependencies, and requires Logitech Gaming
177 Software to be installed to have any effect at
178 runtime.
179
180CONFIG+=no-qssldiffiehellmanparameters
181 Don't build in support for custom Diffie-Hellman
182 parameters, even if the QSslDiffieHellmanParameters
183 class is available in the version of Qt you are
184 building against.
185
186CONFIG+=no-xboxinput (Mumble, Win32)
187 Don't build in support for global shortcuts
188 from Xbox controllers via the XInput DLL.
189
190CONFIG+=g15-emulator (Mumble, Win32)
191 Build the g15helper executable in emulator
192 mode. This will cause an emulated G15 window
193 to appear on screen. Allows the use of Mumble's
194 G15 support without owning the physical hardware.
195
196CONFIG+=no-manual-plugin (Mumble)
197 Don't include the built-in 'manual' positional
198 audio plugin.
199
200CONFIG+=qtspeech (Mumble)
201 Use Qt's text-to-speech system (part of the experimental
202 Qt Speech module), if available, instead of Mumble's own
203 OS-specific text-to-speech implementations.
204
205CONFIG+=dpkg-buildflags
206 Add CFLAGS, CXXFLAGS, CPPFLAGS and LDFLAGS
207 from dpkg-buildflags to Mumble's build flags.
208
209CONFIG+=no-classic-theme
210 Don't include the classic theme.
211