Overwolf Guild Wars 2 Mumble Link Plugin

This is a plugin that allows an Overwolf WebApp to read information from the (Guild Wars 2) Mumble link.

Building

To build this plugin, you'll need the Gecko SDK, also known as the XULRunner SDK. The plugin was successfully tested using the version for Gecko 1.9.2 (Firefox 3.6).

Unzip the xulrunner-sdk folder side-by-side with the OverwolfGW2Plugin folder (or create a symlink) - the project references this folder (see Additional Include Directories).

NOTE: we make sure to compile the plugin /MT so there are no dependencies on the C runtime libraries.

Using the Plugin

To use the plugin, place the npOverwolfGW2Plugin.dll in the directory of you WebApp. Then, add this to the data section of your manifest.json:

    "plugins": [
      "npOverwolfGW2Plugin.dll"
    ]

And add an embed tag to your HTML:

    <embed id="plugin" type="application/x-overwolf-gw2-plugin" width="0" height="0">
    </embed>

The plugin exposes the fields of the Mumble link as properties, which can be read from your app:

    var plugin = document.getElementById("plugin");
    if (plugin.name == "Guild Wars 2") {
        console.log(plugin.identity);
    } else {
        console.log("Guild Wars 2 not running?");
    }

The following properties are implemented. Note that most of the properties are described on the Mumble Wiki or Guild Wars 2 forum. The coordinate type has properties x, y and z.

Name	Type	Notes
uiVersion	number	2
uiTick	number	Counter, incremented every frame (but not during cut-scenes).
fAvatarPosition	coordinate	Player position.
fAvatarFront	coordinate	Unit vector pointing out of the players eyes.
fAvatarTop	coordinate	Unit vector pointing out of the top of the player's head (always zeros).
name	string	Guild Wars 2
fCameraPosition	coordinate	Camera position.
fCameraFront	coordinate	See fAvatarFront.
fCameraTop	coordinate	See fAvatarTop (always zeros).
identity	string	Character identity, as a JSON string.
serverAddress	string	The server address, formatted as a string (same IP as displayed using the /ip command in-game).
mapId	number	Map Id
mapType	number	Map Type
shardId	number	Shard Id
instance	number	Instance
buildId	number	Game Version
description	string	Empty.