mumble/docs/dev/build-instructions
Robert Adam 1d45d991aa CHANGE: Use Protobuf for UDP messages
Previously Mumble was using a custom binary format for transmitting data
via UDP (mainly audio). This has worked for a long time but besides
being inconvenient for 3rdParty implementors (they had to manually
re-implement encoding and decoding support for this format) this format
was not very flexible and changes to the data format were very hard.

In order to improve on this situation, this commit introduces changes
that allow to use Protobuf for the UDP messages as well (it's already
used for TCP). With that it should be relatively easy to extend/change
the UDP packet formats in the future and 3rdParty implementors can now
simply use Protobuf to handle decoding/encoding packets for them (much
less work and much less prone to errors).

Since the new Protobuf format is incompatible with the old UDP format,
this commit also includes support for dealing with older clients or
servers that don't recognize the new protocol yet. That way the new
protocol format is only used if both the client and the server are
recent enough to have it implemented (assumed to be the case >=1.5.0).

Note also that the server will make sure that clients using the old and
the new format can seamlessly communicate with one another.

Therefore, on the surface it should not be noticeable to the user which
protocol is currently used.

Note also that the new protocol format only supports Opus as an audio
codec. If one of the legacy codecs is to be used, the legacy packet
format has to be used as well. However, all codecs except for Opus will
be removed from Mumble in the future anyway.

Fixes #4350
2022-03-27 09:49:58 +02:00
..
build_installer.md DOCS: Mention BUILD_NUMBER for building installer 2021-05-30 16:52:25 +02:00
build_linux.md CHANGE(server): Remove gRPC implementation 2022-03-16 08:23:38 +01:00
build_macos.md DOCS: Added info about Poco dependency 2021-05-14 18:24:54 +02:00
build_static.md CHANGE(server): Remove gRPC implementation 2022-03-16 08:23:38 +01:00
build_windows.md DOCS: Added instructions to install Visual Studio 2020-11-01 08:20:00 +01:00
cmake_options.md CHANGE: Use Protobuf for UDP messages 2022-03-27 09:49:58 +02:00
common_build_errors.md DOCS: Add FindPythonInterpreter error to common build errors 2022-01-24 08:23:17 +01:00
faq.md DOCS: Mention unity builds 2021-03-06 18:57:22 +01:00
find_build_number.md DOCS: Extend build number docs 2022-01-09 19:54:49 +01:00
ide_integration.md DOCS: Fix vcpkg paths in build documentation 2021-01-14 19:57:06 +01:00
README.md DOCS: Updated build instructions to remove duplicated step 2022-01-18 13:01:14 -08:00
setup_visual_studio.md DOCS: Added instructions to install Visual Studio 2020-11-01 08:20:00 +01:00

Build Mumble

A fundamental dependency for building Mumble is git, so make sure you have it installed. If you are new to git, make sure to checkout this guide on git's basics in order to be able to follow the given instructions.

Furthermore Mumble requires a Cpp14-conform compiler.

The first step in building Mumble is to clone this repository via git clone https://github.com/mumble-voip/mumble.git and then going into the cloned directory and run git submodule update --init --recursive in order to also clone all submodules.

Tip: You can also build a specific version or commit of Mumble.

In order to actually build Mumble, you can follow one of the following instruction sets:

Furthermore you might find these helpful as well: