You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
 
 
Robert Adam eb01d1b6d6
Merge PR #5967: BUILD(overlay): build overlay on Linux and FreeBSD without client flag
4 days ago
.ci CI(azure): Update to Ubuntu 20.04 3 months ago
.github CI(github-actions): Update cache action 3 weeks ago
3rdPartyLicenses FORMAT: Removed CRLF line endings 2 years ago
3rdparty BUILD(cmake): Revamp speexdsp build 3 months ago
auxiliary_files BUILD(overlay): build overlay on Linux and FreeBSD without client flag 4 days ago
cmake Merge PR #5957: BUILD(cmake): Fix syntax error 3 weeks ago
docs BUILD(overlay): build overlay on Linux and FreeBSD without client flag 4 days ago
helpers MAINT: Use separate directory for auxiliary files 3 months ago
icons MAINT: Added Mumble PNG image 2 years ago
installer MAINT: Update copyright notice to 2022 2 months ago
macx BUILD(macos): Fix plugins not getting bundled 7 months ago
overlay MAINT: Use separate directory for auxiliary files 3 months ago
overlay_gl FIX(overlay): Implement library search list for dlsym(), add "libc.so.6" to it 4 weeks ago
overlay_winx64 BUILD: Use build number instead of patch version 1 year ago
plugins FIX(positional-audio): Force 8 bytes alignment for CCameraAngles in GTAV plugin 3 months ago
samples Add sound for recording state change notifications 12 years ago
screenshots MAINT(docs): the Game bar trigger must be disabled for the guide button to work 2 years ago
scripts MAINT: Rename Murmur.ice to MumbleServer.ice 3 months ago
src BUILD(overlay): build overlay on Linux and FreeBSD without client flag 4 days ago
themes FEAT(client): Add function to pin channels when filtering 3 weeks ago
.appveyor.yml CI: Update build environment(s) 7 months ago
.backportrc.json MAINT: Add config for backport CLI 2 years ago
.cirrus.yml CHANGE(server): Remove gRPC implementation 9 months ago
.clang-format MAINT: Added clang-format support 2 years ago
.gitignore MAINT: Ignore local Visual Studio CMake settings file CMakeSettings.json 2 years ago
.gitmodules CHANGE(client): Drop support for all legacy codecs 3 months ago
.mailmap Added aliases of Robert Adam 3 years ago
CMakeLists.txt BUILD(overlay): build overlay on Linux and FreeBSD without client flag 4 days ago
CODE_OF_CONDUCT.md MAINT: Add Code of Conduct 2 years ago
CODING_GUIDELINES.md MAINT: Add coding guidelines 1 year ago
COMMIT_GUIDELINES.md CHANGE(server): Remove gRPC implementation 9 months ago
Doxyfile Doxyfile: set "EXTRACT_ALL" to "YES" 3 years ago
LICENSE MAINT: Remove reference to removed AUTHORS 4 months ago
README.md BUILD(server): allow users to specify the UID/GID for the murmur user 7 months ago
SECURITY.md Add link to advisories in SECURITY.md 3 years ago

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 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 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 repository, 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.

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 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