mumble/docs/dev/build-instructions
Robert Adam 27dbee8e62 FEAT(client): Plugin framework
This commit introduces a new plugin framework into the codebase of the
Mumble client. Note that "plugin" here really refers to a (more or less)
general purpose plugin and is therefore not to be confused with the
previously available positional data plugins (only responsible for
fetching positional data from a running game and passing that to
Mumble).

The plugin interface is written in C, removing the compiler-dependence
the old "plugins" had. Instead plugins can now be written in an
arbitrary language as long as that language is capable of being compiled
into a shared library and also being capable of being C-compatible.

As already indicated a plugin is essentially a shared library that
provides certain functions that allow Mumble to interface with it.

Inside Mumble the so-called PluginManager is responsible for managing
the plugins and relaying events to the respective callbacks. Plugins
themselves can also interact with Mumble on their own initiative by
using the provided API functions.

Fixes #2455
Fixes #2148
Fixes #1594
Fixes #2051
Fixes #3742
Fixes #4575
Fixes #4751
2021-04-16 20:15:44 +02:00
..
build_installer.md DOCS(installer): Update Win32 build instructions 2021-01-10 01:58:27 +01:00
build_linux.md DOCS: Dependencies for Cent OS 8 2020-12-13 15:27:12 +03:00
build_macos.md DOCS: Note about selecting OpenSSL directory 2020-11-20 13:55:37 +01:00
build_static.md DOCS: Added additional deps for static Linux build 2021-02-13 17:01:44 +01:00
build_windows.md DOCS: Added instructions to install Visual Studio 2020-11-01 08:20:00 +01:00
cmake_options.md FEAT(client): Plugin framework 2021-04-16 20:15:44 +02:00
faq.md DOCS: Mention unity builds 2021-03-06 18:57:22 +01:00
ide_integration.md DOCS: Fix vcpkg paths in build documentation 2021-01-14 19:57:06 +01:00
README.md Merge pull request #4692: DOCS: Added notes how to build specific versions/commits. 2021-01-17 11:14:46 +01: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.

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.

Then go into the cloned repository and run git submodule update --init --recursive in order to also clone all submodules.

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

Furthermore you might find these helpful as well: