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 major issues with the Mumble overlay:

  • Combat Arms (overlay causes CA to crash after map changes; overlay will not display unless one joins a server and then leaves it)
  • Supreme Commander (Multiplayer)
  • Vanguard (crashes to desktop when overlay is enabled)
  • Call of Duty 2, 4 (PunkBuster kick)

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

  • Killing Floor and Red Orchestra (same game engine; the game will crash when changing resolutions or going into fullscreen mode)

Depending on the API the engines of games use, and sometimes how they use it, the overlay will not display. Currently, of Direct3D only the Direct3D 9 and 10 APIs are supported in their 32-bit versions, but not 9ex or 11, or any in a 64-bit version.

Game API Comment (Why does it not work?) fixed in
Counterstrike: Source Direct3D 9ex Workaround: -nod3d9ex
1.2.5
Dota 2 Direct3D 9ex 1
Workaround: -nod3d9ex
1.2.5
Guild Wars 2 Direct3D 9 because of device recreation
1.2.5
League of Legends device recreation? (disappears on loading) 1
1.2.5
Team Fortress 2 Direct3D 9ex Workaround: -nod3d9ex
1.2.5
Warcraft 3

Overlay availability by API, OS and CPU-architecture:

API CPU-Architecture Platform Overlay displays?
OpenGL x86 Linux, Mac
fully works
x64
fully works
OpenGL x86 Windows
fully works
x64
does not display
Direct3D 9 x86 Windows
fully works (on first device creation)
fully works in 1.2.5
x64
does not display
Direct3D 9ex x86 Windows
does not display
fully works in 1.2.5
x64
does not display
Direct3D 10 x86 Windows
fully works (on first device creation)
fully works in 1.2.5
x64
does not display
Direct3D 11 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