Go to file
Hartmnt 3bd6d41282
Merge PR #6457: Fix the QComboBoxes in ACLEditor
2024-06-07 13:56:51 +02:00
.ci CI: Update Windows & macOS build envs 2024-01-01 13:56:33 +01:00
.github MAINT(github): Drop obsolete, archived forums web-link from issue templates 2024-04-07 09:03:47 +02:00
3rdPartyLicenses FORMAT: Removed CRLF line endings 2021-03-28 20:17:24 +02:00
3rdparty FIX(ui): Replace Emoji One icons with MIT licensed flag-icons 2024-05-09 10:30:20 +02:00
auxiliary_files BUILD: Set timezone on release date for reproducibility 2024-02-10 17:08:31 +01:00
cmake BUILD: Detect arm64 / aarch64 architecture 2024-01-21 10:42:55 +01:00
docs Merge PR #6390: DOCS(docker): Drop outdated docker compose documentation 2024-04-10 22:26:05 +02:00
helpers MAINT: Update copyright headers to 2023 2023-01-08 15:54:35 +01:00
icons FIX(ui): Replace Emoji One icons with MIT licensed flag-icons 2024-05-09 10:30:20 +02:00
installer FEAT(client): Add ReNameNoise as a replacement for RNNoise 2024-04-04 14:59:09 +00:00
macx MAINT: Update copyright headers to 2023 2023-01-08 15:54:35 +01:00
overlay BUILD(cmake): Module to fetch compiler-dependent flags 2024-01-07 17:10:11 +01:00
overlay_gl BUILD(cmake, overlay): Install 32-bit lib on FreeBSD 2023-08-18 10:46:14 -04:00
overlay_winx64 BUILD: Use build number instead of patch version 2021-11-28 20:12:06 +01:00
plugins FIX(plugins): Compilation with new unified header 2023-11-29 19:07:13 +01: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 FIX(ui): Replace Emoji One icons with MIT licensed flag-icons 2024-05-09 10:30:20 +02:00
src Merge PR #6457: Fix the QComboBoxes in ACLEditor 2024-06-07 13:56:51 +02:00
themes FIX(client, theme): Chinese characters not displayed properly 2023-08-30 13:28:03 +08:00
.appveyor.yml CI: Update Windows & macOS build envs 2024-01-01 13:56:33 +01:00
.backportrc.json MAINT: Update backport config 2023-01-04 13:43:03 +01:00
.cirrus.yml CI(freebsd): Build with C++17 2024-01-21 10:17:49 +01: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 FIX(ui): Replace Emoji One icons with MIT licensed flag-icons 2024-05-09 10:30:20 +02:00
.mailmap Added aliases of Robert Adam 2020-01-28 12:47:16 +01:00
CMakeLists.txt BUILD: Allow overwrite of cpp standard 2024-01-21 10:17:22 +01:00
CODE_OF_CONDUCT.md MAINT: Add Code of Conduct 2021-04-07 19:58:21 +02:00
CODING_GUIDELINES.md MAINT: Add coding guidelines 2021-07-24 20:21:11 +02:00
COMMIT_GUIDELINES.md DOCS: Fix headlines, Add general intro 2024-04-07 11:44:35 +02:00
Doxyfile Doxyfile: set "EXTRACT_ALL" to "YES" 2019-12-26 20:27:52 +01:00
LICENSE MAINT(license): Fix formatting in LICENSE file 2023-06-12 19:04:18 +02:00
README.md MAINT: Fixed spelling and grammar in README.md 2023-11-04 11:33:28 +01:00
SECURITY.md Add link to advisories in SECURITY.md 2020-05-31 16:39:12 +02:00

README.md

Mumble screenshot

Mumble - Open Source voice-chat software

https://www.mumble.info

#mumble:matrix.org

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, OpenBSD, 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 some 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.

If you are new to the Mumble project, you may want to check out the general introduction to the Mumble source code.

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 how these have to be created in the plugin documentation.

Building

For information on how to build Mumble, check out 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.

Code Signing

We graciously acknowledge that this program uses free code signing provided by SignPath.io, and a free code signing certificate by the SignPath Foundation.

Windows

Running Mumble

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

Running Murmur

Double-click 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 distribution package repository, you should be able to find Mumble in your start menu. No additional steps are 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.

Build and run from Docker

On recent Docker versions, you can build images directly from sources on GitHub:

docker build --pull -t mumble-server github.com/mumble-voip/mumble#master

Example --pulls each time to check for updated base image, then downloads and builds master branch.

You can also specify the user ID (UID) and group ID (GID) for the murmur user in the image. This allows users who use bind mount volumes to use the same UID/GID in the container as in the host:

docker build --pull -t mumble-server --build-arg UID=1234 --build-arg GID=1234 github.com/mumble-voip/mumble#master

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