Overlay

From Mumble Wiki
Jump to: navigation, search
Overlay123 s.png
The overlay is a feature that will overlay the nicknames of users in the channel or users talking over your currently running game. That means you will be able to see who's listening and talking ingame.

Mumble provides overlay support for Games using Direct3D 9/10/11 or OpenGL on Windows and OpenGL using games on Linux/OSX.

Incompatible games

Games that are known to have issues with the Mumble overlay:

Game API Comments Fixed in
Warcraft 3 any  Fixed in the latest 1.3.0 snapshot builds
1.3.0
Combat Arms unknown  overlay causes CA to crash after map changes;
overlay will not display unless one joins a server and then leaves it
unknown
Vanguard n/a  crashes to desktop when overlay is enabled unknown
Call of Duty 4 n/a  PunkBuster kick playing online unknown
Call of Duty 2 n/a  PunkBuster kick playing online unknown
Killing Floor n/a  the game will crash when changing resolutions or going into fullscreen mode unknown
Red Orchestra n/a  the game will crash when changing resolutions or going into fullscreen mode unknown
H1Z1 n/a  game crashes at startup unknown

Overlay availability by API, OS and CPU-architecture:

API CPU-Architecture Platform Status
OpenGL x86 Windows, Linux, Mac
fully works in 1.2.5
x64
fully works
Vulkan x86 Windows, Linux, Mac
fully works in 1.3.0
x64
fully works in 1.3.0
Direct3D 9 x86 Windows
fully works in 1.2.5
x64
fully works in 1.3.0
Direct3D 9ex x86 Windows
fully works in 1.2.5
x64
fully works in 1.3.0
Direct3D 10 x86 Windows
fully works in 1.2.5
x64
fully works in 1.3.0
Direct3D 11 x86 Windows
fully works in 1.3.0
x64
fully works in 1.3.0
Direct3D 12 x86 Windows
does not display
x64
does not display

Disabling the overlay for a particular game

If you would like to disable the overlay for a certain game (because you do not want it in that particular game, or that game has issues with the overlay), and do not want to disable the overlay altogether, put a file named nooverlay (without any extensions) in the same folder as the game executable is located. This will tell Mumble that you do not want the overlay in this particular game. Current releases of Mumble also support black-/whitelisting from the client itself (Settings->Overlay, make sure advanced is checked).

Mumble Overlay Blacklist Win7.png

Overlay on GNU/Linux

As described in our linux README to use the Overlay in an application you start hat appliaction through the mumble-overlay binary:

mumble-overlay gamename

Manual approach

Using this preload command should only be necessary if you did not install a binary package (and thus do not have mumble-overlay available):

As described in our linux README to use the Overlay in an application you preload it.

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