Difference between revisions of "Overlay"

From Mumble Wiki
Jump to: navigation, search
m (use internal wiki url)
(Incompatible games: added h1z1 to list)
 
(3 intermediate revisions by 2 users not shown)
Line 5: Line 5:
  
 
== Incompatible games ==
 
== Incompatible games ==
Games that are known to have '''major issues''' with the Mumble overlay:
+
Games that are known to have '''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.
 
 
 
 
{|class="sortable" style="margin:4px; background-color:#eeeeee; border:1px;"
 
{|class="sortable" style="margin:4px; background-color:#eeeeee; border:1px;"
!style="width:150px; text-align:left;"|Game
+
!style="width:120px; text-align:left;"|Game
!style="width:100px; text-align:left;"|API
+
!style="width:50px; text-align:left;"|API
!style="text-align:left;"|Comment (Why does it not work?)
+
!style="text-align:left;"|Comments
!style="width:100px;"| fixed in
+
!style="width:65px;"|Fixed in
|-
+
|- style="background-color:#dddddd;"
 +
|| Warcraft 3
 +
|| any
 +
|| Fixed in the latest 1.3.0 snapshot builds
 +
|| <div style="font-weight:bold;color:#338833;">1.3.0</div>
 +
|- style="background-color:#dddddd;"
 +
|| Combat Arms
 +
|| unknown
 +
|| overlay causes CA to crash after map changes;<br/> overlay will not display unless one joins a server and then leaves it
 +
|| unknown
 +
|- style="background-color:#dddddd;"
 +
|| Vanguard
 +
|| n/a
 +
|| crashes to desktop when overlay is enabled
 +
|| unknown
 +
|- style="background-color:#dddddd;"
 +
|| Call of Duty 4
 +
|| n/a
 +
|| PunkBuster kick playing online
 +
|| unknown
 +
|- style="background-color:#dddddd;"
 +
|| Call of Duty 2
 +
|| n/a
 +
|| PunkBuster kick playing online
 +
|| unknown
 
|- style="background-color:#dddddd;"
 
|- style="background-color:#dddddd;"
| Counterstrike: Source
+
|| Killing Floor
|| Direct3D 9ex
+
|| n/a
|| Workaround: <code>-nod3d9ex</code>
+
|| the game will crash when changing resolutions or going into fullscreen mode
|| <div style="font-weight:bold;color:#338833;">1.2.5</div>
+
|| unknown
|-
 
|| Dota 2
 
|| Direct3D 9ex
 
|| <sup>[https://sourceforge.net/tracker/?func=detail&aid=3496043&group_id=147372&atid=768005 1]</sup><br/>Workaround: <code>-nod3d9ex</code>
 
||  <div style="font-weight:bold;color:#338833;">1.2.5</div>
 
 
|- style="background-color:#dddddd;"
 
|- style="background-color:#dddddd;"
|| Guild Wars 2
+
|| Red Orchestra
|| Direct3D 9
+
|| n/a
|| because of device recreation
+
|| the game will crash when changing resolutions or going into fullscreen mode
|| <div style="font-weight:bold;color:#338833;">1.2.5</div>
+
|| unknown
||
 
|-
 
|| League of Legends
 
||
 
|| device recreation? (disappears on loading) <sup>[https://sourceforge.net/tracker/?func=detail&aid=3577499&group_id=147372&atid=768005 1]</sup>
 
|| <div style="font-weight:bold;color:#338833;">1.2.5</div>
 
 
|- style="background-color:#dddddd;"
 
|- style="background-color:#dddddd;"
|| Team Fortress 2
+
|| H1Z1
|| Direct3D 9ex
+
|| n/a
|| Workaround: <code>-nod3d9ex</code>
+
|| game crashes at startup
|| <div style="font-weight:bold;color:#338833;">1.2.5</div>
+
|| unknown
|-
 
|| Warcraft 3
 
||
 
||
 
||  
 
 
|- style="background-color:#dddddd;"
 
|- style="background-color:#dddddd;"
|| World of Tanks > 8.0
 
|| Direct3D <s>11</s> 10.1 (?)
 
|| <sup>[https://sourceforge.net/tracker/?func=detail&aid=3573353&group_id=147372&atid=768005 1], [https://sourceforge.net/apps/phpbb/mumble/viewtopic.php?p=3393#p3393 2]</sup>
 
||
 
|-
 
 
|}
 
|}
  
Line 67: Line 60:
 
!style="width:150px; text-align:left;"|CPU-Architecture
 
!style="width:150px; text-align:left;"|CPU-Architecture
 
!style="width:150px; text-align:left;"|Platform
 
!style="width:150px; text-align:left;"|Platform
!style="text-align:left;"|Overlay displays?
+
!style="text-align:left;"|Status
 
|- style="background-color:#dddddd;"
 
|- style="background-color:#dddddd;"
 
| rowspan="2" | OpenGL
 
| rowspan="2" | OpenGL
 
|| x86
 
|| x86
| rowspan="2" | Linux, Mac
+
| rowspan="2" | Windows, Linux, Mac
|| <div style="color:#338833;">fully works</div>
+
|| <div style="color:#338833;">fully works in 1.2.5</div>
 
|-
 
|-
 
| x64
 
| x64
 
|| <div style="color:#338833;">fully works</div>
 
|| <div style="color:#338833;">fully works</div>
 
|- style="background-color:#dddddd;"
 
|- style="background-color:#dddddd;"
| rowspan="2" | OpenGL
+
| rowspan="2" | Vulkan|| x86
|| x86
+
| rowspan="2" | Windows, Linux, Mac
| rowspan="2" | Windows
+
|| <div style="color:#338833;">fully works in 1.3.0</div>
|| <div style="color:#338833;">fully works</div>
 
 
|-
 
|-
 
| x64
 
| x64
|| <div style="color:#883333;">does not display</div>
+
|| <div style="color:#338833;">fully works in 1.3.0</div>
 
|- style="background-color:#dddddd;"
 
|- style="background-color:#dddddd;"
 
| rowspan="2" | Direct3D 9
 
| rowspan="2" | Direct3D 9
 
|| x86
 
|| x86
 
| rowspan="2" | Windows
 
| rowspan="2" | Windows
|| <div style="color:#226622;">fully works (on first device creation)</div>
+
|| <div style="color:#338833;">fully works in 1.2.5</div>
<div style="color:#338833;">fully works in 1.2.5</div>
 
 
|-
 
|-
 
| x64
 
| x64
|| <div style="color:#883333;">does not display</div>
+
|| <div style="color:#338833;">fully works in 1.3.0</div>
 
|- style="background-color:#dddddd;"
 
|- style="background-color:#dddddd;"
 
| rowspan="2" | Direct3D 9ex
 
| rowspan="2" | Direct3D 9ex
 
|| x86
 
|| x86
 
| rowspan="2" | Windows
 
| rowspan="2" | Windows
|| <div style="color:#883333;">does not display</div>
+
|| <div style="color:#338833;">fully works in 1.2.5</div>
<div style="color:#338833;">fully works in 1.2.5</div>
 
 
|-
 
|-
 
|| x64
 
|| x64
|| <div style="color:#883333;">does not display</div>
+
|| <div style="color:#338833;">fully works in 1.3.0</div>
 
|- style="background-color:#dddddd;"
 
|- style="background-color:#dddddd;"
 
| rowspan="2" | Direct3D 10
 
| rowspan="2" | Direct3D 10
 
|| x86
 
|| x86
 
| rowspan="2" | Windows
 
| rowspan="2" | Windows
|| <div style="color:#226622;">fully works (on first device creation)</div>
+
|| <div style="color:#338833;">fully works in 1.2.5</div>
<div style="color:#338833;">fully works in 1.2.5</div>
 
 
|-
 
|-
 
|| x64
 
|| x64
|| <div style="color:#883333;">does not display</div>
+
|| <div style="color:#338833;">fully works in 1.3.0</div>
 
|- style="background-color:#dddddd;"
 
|- style="background-color:#dddddd;"
 
| rowspan="2" | Direct3D 11
 
| rowspan="2" | Direct3D 11
 +
|| x86
 +
| rowspan="2" | Windows
 +
|| <div style="color:#226622;">fully works in 1.3.0</div>
 +
|-
 +
|| x64
 +
|| <div style="color:#226622;">fully works in 1.3.0</div>
 +
|- style="background-color:#dddddd;"
 +
| rowspan="2" | Direct3D 12
 
|| x86
 
|| x86
 
| rowspan="2" | Windows
 
| rowspan="2" | Windows

Latest revision as of 12:51, 29 January 2017

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