diff --git a/FoCAPI.vcxproj b/FoCAPI.vcxproj
index d1e2558..fa53cc3 100644
--- a/FoCAPI.vcxproj
+++ b/FoCAPI.vcxproj
@@ -166,6 +166,7 @@
+
diff --git a/FoCAPI.vcxproj.filters b/FoCAPI.vcxproj.filters
index b686d97..0ae6219 100644
--- a/FoCAPI.vcxproj.filters
+++ b/FoCAPI.vcxproj.filters
@@ -50,6 +50,9 @@
Source Files\Functions
+
+ Source Files\Functions
+
Source Files\Functions
diff --git a/README.md b/README.md
index 176c9b3..304f73f 100644
--- a/README.md
+++ b/README.md
@@ -9,5 +9,17 @@ Currently only works with the debug kit `StarWarsI.exe`; `StarWarsG.exe` support
## Functions
-- Global `WriteToFile(str a, str b)` - Appends a line of text `b` to the file name `a` in the game directory.
+- Global `WriteToFile(file, text)` - Appends a line of text specified file in the game directory.
+ - Parameter `file` string - The file name to append.
+ - Parameter `text` string - The text line to append.
- Global `Get_All_Players()` - Returns a 1-based Lua table of all active players, iterable with `ipairs()`. Each entry is the same PlayerWrapper type returned by `Find_Player()`.
+- Global `Add_Tutorial_Text(key, text, duration, r, g, b, a)` - Adds a line to the tutorial text pane.
+ - Parameter `key`: string - The key used to identify this line, later can be used to update or remove the text.
+ - Parameter `text`: string - The text to display.
+ - Parameter `duration` number? - The duration to display the text. Default: -1 (infinite)
+ - Parameter `r` number? - The red color component. Default: 1
+ - Parameter `g` number? - The green color component. Default: 1
+ - Parameter `b` number? - The blue color component. Default: 1
+ - Parameter `a` number? - The alpha component. Default: 1
+- Global `Remove_Tutorial_Text(key)` - Removes the line associated with the key.
+ - Parameter `key` string - The key used to identify the line when it was added.
\ No newline at end of file
diff --git a/functions/functions.cpp b/functions/functions.cpp
index 065519c..d7bca9f 100644
--- a/functions/functions.cpp
+++ b/functions/functions.cpp
@@ -10,4 +10,5 @@
void Register_All(lua_State* L) {
Register_FileIO(L);
Register_Players(L);
+ Register_ScreenText(L);
}
diff --git a/functions/functions.h b/functions/functions.h
index ec9ed67..7651e33 100644
--- a/functions/functions.h
+++ b/functions/functions.h
@@ -10,3 +10,4 @@ void Register_All(lua_State* L);
// Each checks its own required function pointer guards before registering.
void Register_FileIO(lua_State* L);
void Register_Players(lua_State* L);
+void Register_ScreenText(lua_State* L);
diff --git a/functions/screen_text.cpp b/functions/screen_text.cpp
new file mode 100644
index 0000000..0e75de7
--- /dev/null
+++ b/functions/screen_text.cpp
@@ -0,0 +1,66 @@
+#include "functions.h"
+#include "../lua_hook.h"
+#include
+#include
+
+// Add_Tutorial_Text(key, text [, duration [, r, g, b, a]])
+// duration defaults to -1 (perpetual). r/g/b/a default to 1.0 (white, opaque).
+// The color pointer must be non-null: the game copies 16 bytes from it unconditionally
+// before its own null check, so we always pass a valid buffer.
+static int L_Add_Tutorial_Text(lua_State* L)
+{
+ const char* key = pfn_tostring(L, 1);
+ const char* text = pfn_tostring(L, 2);
+ if (!key || !text)
+ return 0;
+
+ float duration = -1.0f;
+ float color[4] = { 1.0f, 1.0f, 1.0f, 1.0f };
+
+ if (pfn_tonumber)
+ {
+ double arg3 = pfn_tonumber(L, 3);
+ if (arg3 != 0.0) duration = (float)arg3;
+
+ double r = pfn_tonumber(L, 4);
+ double g = pfn_tonumber(L, 5);
+ double b = pfn_tonumber(L, 6);
+ double a = pfn_tonumber(L, 7);
+ if (r != 0.0 || g != 0.0 || b != 0.0 || a != 0.0)
+ {
+ color[0] = (float)r;
+ color[1] = (float)g;
+ color[2] = (float)b;
+ color[3] = (float)a;
+ }
+ }
+
+ int wlen = MultiByteToWideChar(CP_ACP, 0, text, -1, nullptr, 0);
+ std::wstring wtext(wlen - 1, L'\0');
+ MultiByteToWideChar(CP_ACP, 0, text, -1, &wtext[0], wlen);
+
+ pfn_add_tutorial_text(g_command_bar, &wtext, (char*)key, duration, 0, false, color);
+
+ return 0;
+}
+
+// Remove_Tutorial_Text(key)
+static int L_Remove_Tutorial_Text(lua_State* L)
+{
+ const char* key = pfn_tostring(L, 1);
+ if (!key)
+ return 0;
+
+ pfn_remove_tutorial_text(g_command_bar, (char*)key);
+
+ return 0;
+}
+
+void Register_ScreenText(lua_State* L)
+{
+ if (!pfn_add_tutorial_text || !pfn_remove_tutorial_text || !g_command_bar)
+ return;
+
+ register_global(L, "Add_Tutorial_Text", L_Add_Tutorial_Text);
+ register_global(L, "Remove_Tutorial_Text", L_Remove_Tutorial_Text);
+}
diff --git a/lua_hook.cpp b/lua_hook.cpp
index efc6dd9..1f9132b 100644
--- a/lua_hook.cpp
+++ b/lua_hook.cpp
@@ -17,6 +17,9 @@ void* g_player_list = nullptr;
fn_PlayerWrapperCreate pfn_player_wrapper_create = nullptr;
fn_GetScriptFromState pfn_get_script_from_state = nullptr;
fn_MapVarToLua pfn_map_var_to_lua = nullptr;
+fn_AddTutorialText pfn_add_tutorial_text = nullptr;
+fn_RemoveTutorialText pfn_remove_tutorial_text = nullptr;
+void* g_command_bar = nullptr;
fn_DebugPrint pfn_debug_print = nullptr;
void register_global(lua_State* L, const char* name, lua_CFunction fn) {
@@ -72,6 +75,12 @@ bool LuaHook_Init() {
pfn_map_var_to_lua = (fn_MapVarToLua)(base + rvas->map_var_to_lua);
}
+ if (rvas->command_bar && rvas->add_tutorial_text && rvas->remove_tutorial_text) {
+ g_command_bar = (void*)(base + rvas->command_bar);
+ pfn_add_tutorial_text = (fn_AddTutorialText)(base + rvas->add_tutorial_text);
+ pfn_remove_tutorial_text = (fn_RemoveTutorialText)(base + rvas->remove_tutorial_text);
+ }
+
if (rvas->debug_print)
pfn_debug_print = (fn_DebugPrint)(base + rvas->debug_print);
diff --git a/lua_hook.h b/lua_hook.h
index dfcf5cb..f5a2835 100644
--- a/lua_hook.h
+++ b/lua_hook.h
@@ -17,6 +17,8 @@ typedef void* (*fn_GetPlayerByIndex)(void*, int); // PlayerListC
typedef void* (*fn_PlayerWrapperCreate)(void*, void*); // PlayerWrapper::Create(PlayerClass*, LuaScriptClass*)
typedef void* (*fn_GetScriptFromState)(lua_State*); // LuaScriptClass::Get_Script_From_State
typedef void (*fn_MapVarToLua)(lua_State*, void*); // LuaScriptClass::Map_Var_To_Lua (static)
+typedef void (*fn_AddTutorialText)(void*, void*, const char*, float, unsigned int, bool, void*); // CommandBarClass::Add_Tutorial_Text (inner)
+typedef void (*fn_RemoveTutorialText)(void*, const char*); // CommandBarClass::Remove_Tutorial_Text
typedef void (*fn_DebugPrint)(const char*); // Debug_Print
// Resolved function pointers (defined in lua_hook.cpp)
@@ -33,6 +35,9 @@ extern void* g_player_list;
extern fn_PlayerWrapperCreate pfn_player_wrapper_create;
extern fn_GetScriptFromState pfn_get_script_from_state;
extern fn_MapVarToLua pfn_map_var_to_lua;
+extern fn_AddTutorialText pfn_add_tutorial_text;
+extern fn_RemoveTutorialText pfn_remove_tutorial_text;
+extern void* g_command_bar;
extern fn_DebugPrint pfn_debug_print;
constexpr int LUA_GLOBALSINDEX = -10001;
diff --git a/minhook/bin/MinHook.x64.exp b/minhook/bin/MinHook.x64.exp
deleted file mode 100644
index ad66dd6..0000000
Binary files a/minhook/bin/MinHook.x64.exp and /dev/null differ
diff --git a/minhook/bin/MinHook.x86.exp b/minhook/bin/MinHook.x86.exp
deleted file mode 100644
index 20ed634..0000000
Binary files a/minhook/bin/MinHook.x86.exp and /dev/null differ
diff --git a/minhook/include/MinHook.h b/minhook/include/MinHook.h
deleted file mode 100644
index 492d83f..0000000
--- a/minhook/include/MinHook.h
+++ /dev/null
@@ -1,185 +0,0 @@
-/*
- * MinHook - The Minimalistic API Hooking Library for x64/x86
- * Copyright (C) 2009-2017 Tsuda Kageyu.
- * All rights reserved.
- *
- * Redistribution and use in source and binary forms, with or without
- * modification, are permitted provided that the following conditions
- * are met:
- *
- * 1. Redistributions of source code must retain the above copyright
- * notice, this list of conditions and the following disclaimer.
- * 2. Redistributions in binary form must reproduce the above copyright
- * notice, this list of conditions and the following disclaimer in the
- * documentation and/or other materials provided with the distribution.
- *
- * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
- * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
- * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
- * PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER
- * OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
- * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
- * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
- * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
- * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
- * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
- * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
- */
-
-#pragma once
-
-#if !(defined _M_IX86) && !(defined _M_X64) && !(defined __i386__) && !(defined __x86_64__)
- #error MinHook supports only x86 and x64 systems.
-#endif
-
-#include
-
-// MinHook Error Codes.
-typedef enum MH_STATUS
-{
- // Unknown error. Should not be returned.
- MH_UNKNOWN = -1,
-
- // Successful.
- MH_OK = 0,
-
- // MinHook is already initialized.
- MH_ERROR_ALREADY_INITIALIZED,
-
- // MinHook is not initialized yet, or already uninitialized.
- MH_ERROR_NOT_INITIALIZED,
-
- // The hook for the specified target function is already created.
- MH_ERROR_ALREADY_CREATED,
-
- // The hook for the specified target function is not created yet.
- MH_ERROR_NOT_CREATED,
-
- // The hook for the specified target function is already enabled.
- MH_ERROR_ENABLED,
-
- // The hook for the specified target function is not enabled yet, or already
- // disabled.
- MH_ERROR_DISABLED,
-
- // The specified pointer is invalid. It points the address of non-allocated
- // and/or non-executable region.
- MH_ERROR_NOT_EXECUTABLE,
-
- // The specified target function cannot be hooked.
- MH_ERROR_UNSUPPORTED_FUNCTION,
-
- // Failed to allocate memory.
- MH_ERROR_MEMORY_ALLOC,
-
- // Failed to change the memory protection.
- MH_ERROR_MEMORY_PROTECT,
-
- // The specified module is not loaded.
- MH_ERROR_MODULE_NOT_FOUND,
-
- // The specified function is not found.
- MH_ERROR_FUNCTION_NOT_FOUND
-}
-MH_STATUS;
-
-// Can be passed as a parameter to MH_EnableHook, MH_DisableHook,
-// MH_QueueEnableHook or MH_QueueDisableHook.
-#define MH_ALL_HOOKS NULL
-
-#ifdef __cplusplus
-extern "C" {
-#endif
-
- // Initialize the MinHook library. You must call this function EXACTLY ONCE
- // at the beginning of your program.
- MH_STATUS WINAPI MH_Initialize(VOID);
-
- // Uninitialize the MinHook library. You must call this function EXACTLY
- // ONCE at the end of your program.
- MH_STATUS WINAPI MH_Uninitialize(VOID);
-
- // Creates a hook for the specified target function, in disabled state.
- // Parameters:
- // pTarget [in] A pointer to the target function, which will be
- // overridden by the detour function.
- // pDetour [in] A pointer to the detour function, which will override
- // the target function.
- // ppOriginal [out] A pointer to the trampoline function, which will be
- // used to call the original target function.
- // This parameter can be NULL.
- MH_STATUS WINAPI MH_CreateHook(LPVOID pTarget, LPVOID pDetour, LPVOID *ppOriginal);
-
- // Creates a hook for the specified API function, in disabled state.
- // Parameters:
- // pszModule [in] A pointer to the loaded module name which contains the
- // target function.
- // pszProcName [in] A pointer to the target function name, which will be
- // overridden by the detour function.
- // pDetour [in] A pointer to the detour function, which will override
- // the target function.
- // ppOriginal [out] A pointer to the trampoline function, which will be
- // used to call the original target function.
- // This parameter can be NULL.
- MH_STATUS WINAPI MH_CreateHookApi(
- LPCWSTR pszModule, LPCSTR pszProcName, LPVOID pDetour, LPVOID *ppOriginal);
-
- // Creates a hook for the specified API function, in disabled state.
- // Parameters:
- // pszModule [in] A pointer to the loaded module name which contains the
- // target function.
- // pszProcName [in] A pointer to the target function name, which will be
- // overridden by the detour function.
- // pDetour [in] A pointer to the detour function, which will override
- // the target function.
- // ppOriginal [out] A pointer to the trampoline function, which will be
- // used to call the original target function.
- // This parameter can be NULL.
- // ppTarget [out] A pointer to the target function, which will be used
- // with other functions.
- // This parameter can be NULL.
- MH_STATUS WINAPI MH_CreateHookApiEx(
- LPCWSTR pszModule, LPCSTR pszProcName, LPVOID pDetour, LPVOID *ppOriginal, LPVOID *ppTarget);
-
- // Removes an already created hook.
- // Parameters:
- // pTarget [in] A pointer to the target function.
- MH_STATUS WINAPI MH_RemoveHook(LPVOID pTarget);
-
- // Enables an already created hook.
- // Parameters:
- // pTarget [in] A pointer to the target function.
- // If this parameter is MH_ALL_HOOKS, all created hooks are
- // enabled in one go.
- MH_STATUS WINAPI MH_EnableHook(LPVOID pTarget);
-
- // Disables an already created hook.
- // Parameters:
- // pTarget [in] A pointer to the target function.
- // If this parameter is MH_ALL_HOOKS, all created hooks are
- // disabled in one go.
- MH_STATUS WINAPI MH_DisableHook(LPVOID pTarget);
-
- // Queues to enable an already created hook.
- // Parameters:
- // pTarget [in] A pointer to the target function.
- // If this parameter is MH_ALL_HOOKS, all created hooks are
- // queued to be enabled.
- MH_STATUS WINAPI MH_QueueEnableHook(LPVOID pTarget);
-
- // Queues to disable an already created hook.
- // Parameters:
- // pTarget [in] A pointer to the target function.
- // If this parameter is MH_ALL_HOOKS, all created hooks are
- // queued to be disabled.
- MH_STATUS WINAPI MH_QueueDisableHook(LPVOID pTarget);
-
- // Applies all queued changes in one go.
- MH_STATUS WINAPI MH_ApplyQueued(VOID);
-
- // Translates the MH_STATUS to its name as a string.
- const char * WINAPI MH_StatusToString(MH_STATUS status);
-
-#ifdef __cplusplus
-}
-#endif
diff --git a/rvas.h b/rvas.h
index 9f97c80..fccaeee 100644
--- a/rvas.h
+++ b/rvas.h
@@ -21,6 +21,11 @@ struct LuaRVAs {
uintptr_t get_script_from_state; // LuaScriptClass::Get_Script_From_State (static)
uintptr_t map_var_to_lua; // LuaScriptClass::Map_Var_To_Lua (member)
+ // --- Screen Text ---
+ uintptr_t command_bar; // TheCommandBar global object (data, not a function)
+ uintptr_t add_tutorial_text; // CommandBarClass::Add_Tutorial_Text (inner overload: wstring*, char*, float, uint, bool, RGBAClass*)
+ uintptr_t remove_tutorial_text; // CommandBarClass::Remove_Tutorial_Text(char*)
+
// --- Debug ---
uintptr_t debug_print; // Debug_Print(char*)
};
@@ -46,6 +51,11 @@ constexpr LuaRVAs RVAs_StarWarsI = {
0x0537BB0, // LuaScriptClass::Get_Script_From_State
0x0536FE0, // LuaScriptClass::Map_Var_To_Lua
+ // --- Screen Text ---
+ 0x1916b80, // TheCommandBar global object
+ 0x003c83a, // CommandBarClass::Add_Tutorial_Text inner
+ 0x006e1eb, // CommandBarClass::Remove_Tutorial_Text
+
// --- Debug ---
0x0476AE0, // Debug_Print
};
@@ -59,18 +69,23 @@ constexpr LuaRVAs RVAs_StarWarsG = {
0x07b9a60, // lua_settable
0x07b9cc0, // lua_tostring
0x07b9bc0, // lua_tonumber
- 0x07b9140, // lua_newtable (TODO)
- 0x07b9820, // lua_rawseti (TODO)
+ 0x07b9140, // lua_newtable
+ 0x07b9820, // lua_rawseti
// --- Players ---
- 0x0294bc0, // PlayerListClass::Get_Player_By_Index (TODO)
- 0x0a16fd0, // PlayerList global object (TODO)
- 0x06019f0, // PlayerWrapper::Create (TODO)
+ 0x0294bc0, // PlayerListClass::Get_Player_By_Index
+ 0x0a16fd0, // PlayerList global object
+ 0x06019f0, // PlayerWrapper::Create
// --- Scripts ---
- 0x0245790, // LuaScriptClass::Get_Script_From_State (TODO)
- 0x0247700, // LuaScriptClass::Map_Var_To_Lua (TODO)
+ 0x0245790, // LuaScriptClass::Get_Script_From_State
+ 0x0247700, // LuaScriptClass::Map_Var_To_Lua
+
+ // --- Screen Text ---
+ 0x0b27f60, // TheCommandBar
+ 0x02dfd10, // CommandBarClass::Add_Tutorial_Text inner
+ 0x02ff290, // CommandBarClass::Remove_Tutorial_Text
// --- Debug ---
- 0, // Debug_Print (TODO)
+ 0, // Debug_Print (not mapped)
};