Skip to content
Permalink
Browse files

Merge PR #2653: Add plugin for Final Fantasy XIV

  • Loading branch information...
mkrautz committed Nov 27, 2016
2 parents 0df5c64 + 07308dc commit 8bbb34d7c1af37d4f49095dc22f257b3f59f75e9
Showing with 215 additions and 1 deletion.
  1. +203 −0 plugins/ffxiv/ffxiv.cpp
  2. +11 −0 plugins/ffxiv/ffxiv.pro
  3. +1 −1 plugins/plugins.pro
@@ -0,0 +1,203 @@
// Copyright 2005-2016 The Mumble Developers. All rights reserved.
// Use of this source code is governed by a BSD-style license
// that can be found in the LICENSE file at the root of the
// Mumble source tree or at <https://www.mumble.info/LICENSE>.

#include "../mumble_plugin_win32_32bit.h" // Include standard plugin header.
#include "../mumble_plugin_utils.h" // Include plugin header for special functions, like "escape".
#include <cmath>

// Offset values can be obtained from:
// http://xivapp.com/api/structures?patchVersion=latest&platform=x86
// Y is North/South, South is increasing values
// X is East/West, West is increasing values
// Heading is in radians, 0 faces south

// Memory offsets
const procptr32_t camera_ptr = 0x1045C40;
const procptr32_t avatar_ptr = 0x10468EC;
const procptr32_t state_offset = 0x1048C60;
const procptr32_t map_id_offset = 0x10210B0;
// Avatar struct offsets
const procptr32_t identity_offset = 48; // Name
const procptr32_t avatar_pos_offset = 160; // X, Z, Y
const procptr32_t avatar_azimuth_offset = 176; // Heading (-pi to pi)
// Camera struct offsets
const procptr32_t camera_is_free_offset = 256; // 0: First person mode; 1: 3rd person
const procptr32_t camera_pos_offset = 64; // X, Z, Y
const procptr32_t camera_azimuth_offset = 288; // (-pi to pi)
const procptr32_t camera_elevation_offset = 292; // (-pi to pi)
// Module names
const wchar_t *exe_name = L"ffxiv.exe";

static int fetch(float *avatar_pos, float *avatar_front, float *avatar_top, float *camera_pos, float *camera_front, float *camera_top, std::string &context, std::wstring &identity) {
for (int i=0;i<3;i++) {
avatar_pos[i] = avatar_front[i] = avatar_top[i] = camera_pos[i] = camera_front[i] = camera_top[i] = 0.0f;
}

// Boolean value to check if game addresses retrieval is successful
bool ok;
// Create containers to stuff our raw data into, so we can convert it to Mumble's coordinate system
float avatar_pos_corrector[3], camera_pos_corrector[3], avatar_azimuth, camera_azimuth, camera_elevation;
// Values for extra features
char player[64];
unsigned int map_id;
// State
unsigned char state, camera_is_free;

// Avatar pointer
procptr32_t avatar_address = peekProc<procptr32_t>(pModule + avatar_ptr);
if (!avatar_address) return false;

// Camera pointer
procptr32_t camera_address = peekProc<procptr32_t>(pModule + camera_ptr);
if (!camera_address) return false;

// Peekproc and assign game addresses to our containers, so we can retrieve positional data
ok = peekProc(pModule + state_offset, &state, 1) && // Magical state value: 0 or 255 when in main menu and 1 when in-game.
peekProc(camera_address + camera_pos_offset, &camera_pos_corrector, 12) && // Camera Position values (X, Z and Y).
peekProc(camera_address + camera_azimuth_offset, &camera_azimuth, 4) && // Camera azimuth float.
peekProc(camera_address + camera_elevation_offset, &camera_elevation, 4) && // Camera elevation float.
peekProc(camera_address + camera_is_free_offset, &camera_is_free, 1) && // Camera is in first person mode
peekProc(avatar_address + avatar_pos_offset, &avatar_pos_corrector, 12) && // Avatar Position values (X, Z and Y).
peekProc(avatar_address + avatar_azimuth_offset, &avatar_azimuth, 4) && // Avatar azimuth float.
peekProc(pModule + map_id_offset, &map_id, 4) && // Map id.
peekProc(avatar_address + identity_offset, player); // Player name.

// This prevents the plugin from linking to the game in case something goes wrong during values retrieval from memory addresses.
if (! ok)
return false;

// State
if (state != 1) { // If not in-game
context.clear(); // Clear context
identity.clear(); // Clear identity
// Set vectors values to 0.
for (int i=0;i<3;i++) {
avatar_pos[i] = avatar_front[i] = avatar_top[i] = camera_pos[i] = camera_front[i] = camera_top[i] = 0.0f;
}

return true; // This tells Mumble to ignore all vectors.
}

// Begin context
std::ostringstream ocontext;
ocontext << "{";

// Map id
ocontext << "Map: " << map_id << ""; // Set map id in identity.

ocontext << "}";
context = ocontext.str();
// End context

// Begin identity
std::wostringstream oidentity;
oidentity << "{";

// Map id
oidentity << "Map: " << map_id << ", "; // Set map id in identity.

// Player name
escape(player, sizeof(player));
if (strcmp(player, "") != 0) {
oidentity << "Player: \"" << player << "\""; // Set player name in identity.
} else {
oidentity << "Player: null";
}

oidentity << "}";
identity = oidentity.str();
// End identity

/*
Mumble | Game (in L hand coordinate system)
X | -X
Y | Y
Z | Z
*/
avatar_pos[0] = -avatar_pos_corrector[0];
avatar_pos[1] = avatar_pos_corrector[1];
avatar_pos[2] = avatar_pos_corrector[2];

camera_pos[0] = -camera_pos_corrector[0];
camera_pos[1] = camera_pos_corrector[1];
camera_pos[2] = camera_pos_corrector[2];

avatar_front[0] = static_cast<float>(std::sin(-avatar_azimuth));
avatar_front[1] = 0.0f;
avatar_front[2] = static_cast<float>(std::cos(-avatar_azimuth));

camera_front[0] = static_cast<float>(std::cos(camera_elevation) * std::sin(-camera_azimuth));
camera_front[1] = static_cast<float>(std::sin(camera_elevation));
camera_front[2] = static_cast<float>(std::cos(camera_elevation) * std::cos(-camera_azimuth));

if (camera_is_free) {
camera_front[0] *= -1;
camera_front[2] *= -1;
}

// Convert from yards (yalms) to meters
for (int i=0;i<3;i++) {
avatar_pos[i]*=0.9144f;
camera_pos[i]*=0.9144f;
}

return true;
}

static int trylock(const std::multimap<std::wstring, unsigned long long int> &pids) {

if (! initialize(pids, exe_name)) { // Retrieve "exe_name" module's memory address
return false;
}

// Check if we can get meaningful data from it
float apos[3], afront[3], atop[3], cpos[3], cfront[3], ctop[3];
std::wstring sidentity;
std::string scontext;

if (fetch(apos, afront, atop, cpos, cfront, ctop, scontext, sidentity)) {
return true;
} else {
generic_unlock();
return false;
}
}

static const std::wstring longdesc() {
return std::wstring(L"Supports Final Fantasy XIV version 2016.11.11.0000.0000 with context and identity support."); // Plugin long description
}

static std::wstring description(L"Final Fantasy XIV (2016.11.11.0000.0000)"); // Plugin short description
static std::wstring shortname(L"Final Fantasy XIV"); // Plugin short name

static int trylock1() {
return trylock(std::multimap<std::wstring, unsigned long long int>());
}

static MumblePlugin ffxivplug = {
MUMBLE_PLUGIN_MAGIC,
description,
shortname,
NULL,
NULL,
trylock1,
generic_unlock,
longdesc,
fetch
};

static MumblePlugin2 ffxivplug2 = {
MUMBLE_PLUGIN_MAGIC_2,
MUMBLE_PLUGIN_VERSION,
trylock
};

extern "C" MUMBLE_PLUGIN_EXPORT MumblePlugin *getMumblePlugin() {
return &ffxivplug;
}

extern "C" MUMBLE_PLUGIN_EXPORT MumblePlugin2 *getMumblePlugin2() {
return &ffxivplug2;
}
@@ -0,0 +1,11 @@
# Copyright 2005-2016 The Mumble Developers. All rights reserved.
# Use of this source code is governed by a BSD-style license
# that can be found in the LICENSE file at the root of the
# Mumble source tree or at <https://www.mumble.info/LICENSE>.

include(../plugins.pri)

TARGET = ffxiv
SOURCES = ffxiv.cpp

win32:LIBS += -luser32
@@ -12,7 +12,7 @@ SUBDIRS = link
DIST = plugins.pri

win32 {
SUBDIRS += aoc arma2 bf1942 bf2 bf3 bf2142 bfbc2 bfheroes bf4_x86 blacklight borderlands borderlands2 breach cod2 cod4 cod5 codmw2 codmw2so cs css dods dys etqw tf2 gmod gtaiv gw hl2dm insurgency jc2 l4d l4d2 lol lotro ql rl sr sto ut2004 ut3 ut99 wolfet wow
SUBDIRS += aoc arma2 bf1942 bf2 bf3 bf2142 bfbc2 bfheroes bf4_x86 blacklight borderlands borderlands2 breach cod2 cod4 cod5 codmw2 codmw2so cs css dods dys etqw ffxiv tf2 gmod gtaiv gw hl2dm insurgency jc2 l4d l4d2 lol lotro ql rl sr sto ut2004 ut3 ut99 wolfet wow

equals(MUMBLE_ARCH, x86_64) {
SUBDIRS += bf1 bf4 gtav wow_x64

0 comments on commit 8bbb34d

Please sign in to comment.
You can’t perform that action at this time.