Difference between revisions of "Overlay"

From Mumble Wiki
Jump to: navigation, search
(Incompatible games)
(Incompatible games: added h1z1 to list)
 
(35 intermediate revisions by 4 users not shown)
Line 1: Line 1:
<span style="float:left; margin-right:5px">[http://mumble.sourceforge.net/static/overlay123.png http://mumble.sourceforge.net/static/overlay123_s.png]</span>
+
[[File:overlay123_s.png|left|link=File:overlay123.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.
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 or OpenGL on Windows and OpenGL using games on Linux/OSX.
+
Mumble provides overlay support for Games using Direct3D 9/10/11 or OpenGL on Windows and OpenGL using games on Linux/OSX.
 
<div style="clear:left;"></div>
 
<div style="clear:left;"></div>
 
== Overlay on newer Direct3D ==
 
We are aware of the often requested feature of a Direct3D 11 overlay on Windows and would appreciate any help in documenting the issues on overlay as well as help in the implementing it.
 
 
Efforts have been made but the big changes between Direct3D versions as well as the licensing of DirectX SDK sample code prevent us from including it in our code-base at this point. Some more work is needed to adjust it to our code-base and our needs.
 
  
 
== 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)
+
{|class="sortable" style="margin:4px; background-color:#eeeeee; border:1px;"
* Supreme Commander (Multiplayer)
+
!style="width:120px; text-align:left;"|Game
* Vanguard (crashes to desktop when overlay is enabled)
+
!style="width:50px; text-align:left;"|API
* Call of Duty 2, 4 (PunkBuster kick)
+
!style="text-align:left;"|Comments
 
+
!style="width:65px;"|Fixed in
Games that are known to have '''minor issues''' with the Mumble overlay:
+
|- style="background-color:#dddddd;"
* Killing Floor and Red Orchestra (same game engine; the game will crash when changing resolutions or going into fullscreen mode)
+
|| Warcraft 3
 
+
|| any
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.
+
|| Fixed in the latest 1.3.0 snapshot builds
 
+
|| <div style="font-weight:bold;color:#338833;">1.3.0</div>
{|class="sortable" style="margin:4px; background-color:#eeeeee;"
+
|- style="background-color:#dddddd;"
!style="width:150px; text-align:left;"|Game
+
|| Combat Arms
!style="width:100px; text-align:left;"|API
+
|| unknown
!style="text-align:left;"|Comment (Why does it not work?)
+
|| 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;"
| Civilization 5 || || <sup>[https://sourceforge.net/tracker/?func=detail&aid=3577499&group_id=147372&atid=768005 1]</sup>
+
|| Vanguard
|-
+
|| n/a
| Dawn of War (series) || ||
+
|| crashes to desktop when overlay is enabled
|-
+
|| unknown
| Guild Wars 2 || Direct3D 9 || because of device recreation
+
|- style="background-color:#dddddd;"
|-
+
|| Call of Duty 4
| League of Legends || || device recreation? (disappears on loading) <sup>[https://sourceforge.net/tracker/?func=detail&aid=3577499&group_id=147372&atid=768005 1]</sup>
+
|| n/a
|-
+
|| PunkBuster kick playing online
| Planetside 2 || ? ||
+
|| unknown
|-
+
|- style="background-color:#dddddd;"
| Warcraft 3 || ||
+
|| Call of Duty 2
|-
+
|| n/a
| World of Tanks > 8.0 || ||<sup>[https://sourceforge.net/tracker/?func=detail&aid=3573353&group_id=147372&atid=768005 1]</sup>
+
|| PunkBuster kick playing online
|-
+
|| unknown
 +
|- style="background-color:#dddddd;"
 +
|| Killing Floor
 +
|| n/a
 +
|| the game will crash when changing resolutions or going into fullscreen mode
 +
|| unknown
 +
|- style="background-color:#dddddd;"
 +
|| Red Orchestra
 +
|| n/a
 +
|| the game will crash when changing resolutions or going into fullscreen mode
 +
|| unknown
 +
|- style="background-color:#dddddd;"
 +
|| H1Z1
 +
|| n/a
 +
|| game crashes at startup
 +
|| unknown
 +
|- style="background-color:#dddddd;"
 
|}
 
|}
  
Overlay functionality by API, OS and CPU-architecture:
+
Overlay availability by API, OS and CPU-architecture:
  
 
{|class="sortable" style="margin:4px; background-color:#eeeeee;"
 
{|class="sortable" style="margin:4px; background-color:#eeeeee;"
Line 50: 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;"
| OpenGL || x86 || Any || fully works
+
| rowspan="2" | OpenGL
 +
|| x86
 +
| rowspan="2" | Windows, Linux, Mac
 +
|| <div style="color:#338833;">fully works in 1.2.5</div>
 
|-
 
|-
| OpenGL || x64 || Any || does not display
+
| x64
 +
|| <div style="color:#338833;">fully works</div>
 +
|- style="background-color:#dddddd;"
 +
| rowspan="2" | Vulkan|| x86
 +
| rowspan="2" | Windows, Linux, Mac
 +
|| <div style="color:#338833;">fully works in 1.3.0</div>
 
|-
 
|-
| Direct3D 9 || x86 || Windows || fully works (on first device creation)
+
| x64
 +
|| <div style="color:#338833;">fully works in 1.3.0</div>
 +
|- style="background-color:#dddddd;"
 +
| rowspan="2" | Direct3D 9
 +
|| x86
 +
| rowspan="2" | Windows
 +
|| <div style="color:#338833;">fully works in 1.2.5</div>
 
|-
 
|-
| Direct3D 9 || x64 || Windows || does not display
+
| x64
 +
|| <div style="color:#338833;">fully works in 1.3.0</div>
 +
|- style="background-color:#dddddd;"
 +
| rowspan="2" | Direct3D 9ex
 +
|| x86
 +
| rowspan="2" | Windows
 +
|| <div style="color:#338833;">fully works in 1.2.5</div>
 
|-
 
|-
| Direct3D 9ex || x86 & x64 || Windows || does not display
+
|| x64
 +
|| <div style="color:#338833;">fully works in 1.3.0</div>
 +
|- style="background-color:#dddddd;"
 +
| rowspan="2" | Direct3D 10
 +
|| x86
 +
| rowspan="2" | Windows
 +
|| <div style="color:#338833;">fully works in 1.2.5</div>
 
|-
 
|-
| Direct3D 10 || x86 || Windows || fully works (on first device creation)
+
|| x64
 +
|| <div style="color:#338833;">fully works in 1.3.0</div>
 +
|- style="background-color:#dddddd;"
 +
| rowspan="2" | Direct3D 11
 +
|| x86
 +
| rowspan="2" | Windows
 +
|| <div style="color:#226622;">fully works in 1.3.0</div>
 
|-
 
|-
| Direct3D 10 || x64 || Windows || does not display
+
|| x64
 +
|| <div style="color:#226622;">fully works in 1.3.0</div>
 +
|- style="background-color:#dddddd;"
 +
| rowspan="2" | Direct3D 12
 +
|| x86
 +
| rowspan="2" | Windows
 +
|| <div style="color:#883333;">does not display</div>
 
|-
 
|-
| Direct3D 11 || x86 & x64 || Windows || does not display
+
|| x64
 +
|| <div style="color:#883333;">does not display</div>
 
|-
 
|-
 
|}
 
|}
  
 
== Disabling the overlay for a particular game ==
 
== 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).
+
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 client configuration|advanced]] is checked).
 +
 
 +
[[File:Mumble_Overlay_Blacklist_Win7.png]]
 +
 
 +
== Overlay on GNU/Linux ==
 +
 
 +
As described in [https://github.com/mumble-voip/mumble/blob/master/README.Linux 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 [https://github.com/mumble-voip/mumble/blob/master/README.Linux our linux README] to use the Overlay in an application you preload it.
 +
 
 +
LD_PRELOAD=/path/to/libmumble.so.1.1 gamename
  
[[Category:Documentation]]
 
 
[[Category:Documentation English]]
 
[[Category:Documentation English]]

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