Mumble is an open-source, low-latency, high quality voice chat software.
Go to file
Davide Beatrici a4fdc46a80 BUILD(opus): Fetch submodule from upstream repository
Upon switching to CMake, we kept using our own fork for the repository because a few fixes for the build were needed.

Now that the upstream repository works correctly as submodule, we can fetch from it directly.

Please note that tests provided in the Opus repository are not built anymore.

Fixes #5223.
2021-08-10 23:03:33 +02:00
.ci CI: Update to latest vcpkg environment 2021-07-28 00:56:30 +02:00
.github CI: Add CodeQL analysis 2021-06-15 19:40:45 +02:00
.tx Add transifex client configuration for project. 2014-04-27 03:20:48 +02:00
3rdparty BUILD(opus): Fetch submodule from upstream repository 2021-08-10 23:03:33 +02:00
3rdPartyLicenses FORMAT: Removed CRLF line endings 2021-03-28 20:17:24 +02:00
cmake BUILD(cmake): Detect ARM64 on macOS 2021-07-08 21:47:24 +03:00
docs FIX(client): Ambiguity in plugin installer 2021-06-15 08:10:06 +02:00
g15helper MAINT: Update copyright notice to 2021 (Part II) 2021-04-09 15:41:49 +02:00
helpers/vcpkg/ports/zeroc-ice MAINT: Update hash in Ice port file (vcpkg) 2021-04-07 16:21:03 +02:00
icons MAINT: Added Mumble PNG image 2020-10-18 09:15:58 +02:00
installer BUILD(installer): Add file assoc. for plugin-files 2021-07-11 11:53:12 +02:00
macx BUILD(macos): Fix package script failing 2021-05-17 08:54:52 +02:00
man DOCS(man): Add missing options from help messages to man pages 2020-08-20 00:04:29 +02:00
overlay MAINT: Update copyright notice to 2021 (Part II) 2021-04-09 15:41:49 +02:00
overlay_gl MAINT: Update copyright notice to 2021 (Part II) 2021-04-09 15:41:49 +02:00
overlay_winx64 BUILD(versioning): Make use of the 4th part (build/tweak) of the version 2021-01-06 19:42:48 +01:00
plugins FIX(positional-audio): Update Source Engine plugin to work with L4D2 2.2.2.0 2021-07-14 09:56:03 +02:00
samples Add sound for recording state change notifications 2010-08-25 23:24:37 +02:00
screenshots MAINT(docs): the Game bar trigger must be disabled for the guide button to work 2020-10-10 21:08:22 +02:00
scripts MAINT: Make changelog script work with backports 2021-07-24 16:53:35 +02:00
src BUILD(opus): Fetch submodule from upstream repository 2021-08-10 23:03:33 +02:00
themes MAINT: Improved themes README 2021-06-01 08:28:20 +02:00
.appveyor.yml CI: Update to latest vcpkg environment 2021-07-28 00:56:30 +02:00
.backportrc.json MAINT: Add config for backport CLI 2021-05-30 13:45:15 +02:00
.cirrus.yml FEAT(client): Plugin framework 2021-04-16 20:15:44 +02:00
.clang-format MAINT: Added clang-format support 2020-09-11 18:28:38 +02:00
.gitignore MAINT: Ignore local Visual Studio CMake settings file CMakeSettings.json 2021-03-19 23:56:19 +01:00
.gitmodules BUILD(opus): Fetch submodule from upstream repository 2021-08-10 23:03:33 +02:00
.mailmap Added aliases of Robert Adam 2020-01-28 12:47:16 +01:00
AUTHORS AUTHORS: update via scripts/generate-AUTHORS.py. 2020-01-10 22:33:25 +01:00
CHANGES Update AUTHORS and CHANGES. 2016-12-23 09:27:14 +01:00
CMakeLists.txt FIX(client): Ambiguity in plugin installer 2021-06-15 08:10:06 +02:00
CODE_OF_CONDUCT.md MAINT: Add Code of Conduct 2021-04-07 19:58:21 +02:00
COMMIT_GUIDELINES.md MAINT: Introduce REVERT commit type 2021-05-17 08:49:07 +02:00
Dockerfile MAINT(Dockerfile): Pin base images to Ubuntu Focal (LTS). 2021-08-08 23:23:49 +02:00
Doxyfile Doxyfile: set "EXTRACT_ALL" to "YES" 2019-12-26 20:27:52 +01:00
LICENSE MAINT: Update copyright notice to 2021 2021-03-02 10:15:01 +01:00
README.md DOCS: Document new plugin system 2021-06-06 17:49:41 +02:00
SECURITY.md Add link to advisories in SECURITY.md 2020-05-31 16:39:12 +02:00

Mumble screenshot

Mumble - Open Source voice-chat software

https://www.mumble.info

#mumble:matrix.org #mumble@freenode.net

Codacy Azure Cirrus CI Travis CI

Mumble is an Open Source, low-latency and high-quality voice-chat program written on top of Qt and Opus.

There are two modules in Mumble; the client (mumble) and the server (murmur). The client works on Windows, Linux, FreeBSD and macOS, while the server should work on anything Qt can be installed on.

Please note that with "Windows" we mean 7 and newer. Vista may be supported, but we can't guarantee it. If you don't want to encounter potential issues, you may download Mumble 1.3.x, the last version to provide support for XP.

The documentation of the project can be found on the wiki. The FAQ can also be found there.

Contributing

We always welcome contributions to the project. If you have code that you would like to contribute, please go ahead and create a PR. While doing so, please try to make sure that you follow our commit guidelines.

Translating

Mumble supports various languages. We are always looking for qualified people to contribute translations.

We are using Weblate as a translation platform. Register on Weblate, and join our translation project.

Writing plugins

Mumble supports general-purpose plugins that can provide functionality that is not implemented in the main Mumble application. You can find more information on how this works and on how these have to be created in the plugin documentation.

Building

For information on how to build Mumble, checkout the dedicated documentation.

Reporting issues

If you want to report a bug or create a feature-request, you can open a new issue (after you have checked that there is none already) on GitHub.

Windows

Running Mumble

After installation, you should have a new Mumble folder in your Start Menu, from which you can start Mumble.

Running Murmur

Doubleclick the Murmur icon to start murmur. There will be a small icon on your taskbar from which you can view the log.

To set the superuser password, run murmur with the parameters -supw <password>.

MacOS

Running Mumble

To install Mumble, drag the application from the downloaded disk image into your /Applications folder.

Running Murmur

Murmur is distributed separately from the Mumble client on MacOS. It is called Static OS X Server and can be downloaded from the main webpage.

Once downloaded it can be run in the same way as on any other Unix-like system. For more information please see the "Running Murmur" in the Linux/Unix section below.

Linux/Unix

Running Mumble

If you have installed Mumble through your distributon's package repostory, you should be able to find Mumble in your start menu. No additional steps necessary.

Running Murmur

Murmur should be run from the command line, so start a shell (command prompt) and go to wherever you installed Mumble. Run murmur as

murmurd [-supw <password>] [-ini <inifile>] [-fg] [v]

-supw   Set a new password for the user SuperUser, which is hardcoded to
        bypass ACLs. Keep this password safe. Until you set a password,
        the SuperUser is disabled. If you use this option, murmur will
        set the password in the database and then exit.

-ini    Use an inifile other than murmur.ini, use this to run several instances
        of murmur from the same directory. Make sure each instance is using
        a separate database.

-fg     Run in the foreground, logging to standard output.

-v      More verbose logging.

OpenGL Overlay

The OpenGL overlay works by intercepting the call to switch buffers, and just before the buffer switch, we draw our nice GUI.

To load a game with the overlay enabled, start the game like this:

LD_PRELOAD=/path/to/libmumble.so.1.1 gamename

If you have Mumble installed through the binary packages, this can be done by simply typing:

mumble-overlay gamename