From 8ec9b4e374bc113e0ee2f45e3d8e34cc1088aea3 Mon Sep 17 00:00:00 2001
From: acidicoala <67734819+acidicoala@users.noreply.github.com>
Date: Mon, 1 Sep 2025 00:16:22 +0500
Subject: [PATCH] Added README.txt to release zip

---
 .github/workflows/ci.yml    | 1 +
 res/README.txt              | 3 +++
 src/smoke_api/smoke_api.cpp | 5 +++++
 3 files changed, 9 insertions(+)
 create mode 100644 res/README.txt

diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
index d3f6f84..a8abf59 100644
--- a/.github/workflows/ci.yml
+++ b/.github/workflows/ci.yml
@@ -15,3 +15,4 @@ jobs:
         zip -j $ZIP_NAME
         artifacts/*/*.dll
         res/SmokeAPI.config.json
+        res/README.txt
diff --git a/res/README.txt b/res/README.txt
new file mode 100644
index 0000000..9367139
--- /dev/null
+++ b/res/README.txt
@@ -0,0 +1,3 @@
+Project page: https://github.com/acidicoala/SmokeAPI?tab=readme-ov-file#smokeapi
+Forum topic: https://cs.rin.ru/forum/viewtopic.php?p=2597932#p2597932
+DLC Database: https://steamdb.info/
\ No newline at end of file
diff --git a/src/smoke_api/smoke_api.cpp b/src/smoke_api/smoke_api.cpp
index 2841970..aa519f3 100644
--- a/src/smoke_api/smoke_api.cpp
+++ b/src/smoke_api/smoke_api.cpp
@@ -54,6 +54,11 @@ namespace {
                 if(kb::str::eq(library_name, STEAMCLIENT_DLL)) {
                     KB_HOOK_DETOUR_MODULE(CreateInterface, module_handle);
                 } else if(kb::str::eq(library_name, STEAMAPI_DLL)) {
+                    // TODO: SteamAPI_Init will be too small to hook on x64.
+                    // Ideally, we should inspect the address it jumps to and hook that instead.
+                    // Moreover, SteamAPI_InitSafe calls the same address,
+                    // so it could be used as a sanity check
+
                     KB_HOOK_DETOUR_MODULE(SteamAPI_Init, module_handle);
                     KB_HOOK_DETOUR_MODULE(SteamAPI_InitSafe, module_handle);
                     KB_HOOK_DETOUR_MODULE(SteamAPI_InitFlat, module_handle);