Added trace logs to proxy exports

.gitattributes

@@ -1,3 +1,4 @@
 * text eol=lf
 
 *.dll binary
+*.so binary

.github/workflows/ci.yml

@@ -1,18 +0,0 @@
-name: Continuous Integration
-on: push
-
-jobs:
-  ci:
-    name: CI
-    uses: acidicoala/KoalaBox/.github/workflows/build-and-package.yml@1bdfeefa9933092a747c46679b3d872470ef4998
-    permissions:
-      contents: write
-    with:
-      arch: '[ 32, 64 ]'
-      config: Release
-      modules: '[ "SmokeAPI" ]'
-      zip_command: >
-        zip -j $ZIP_NAME
-        artifacts/*/*.dll
-        res/SmokeAPI.config.json
-        res/README.txt

.github/workflows/dev-build.yml

@@ -0,0 +1,11 @@
+name: '🚧 Development Build'
+
+on:
+  push:
+    branches:
+      - '**' # This prevents dev builds on tag pushes
+
+jobs:
+  dev-build:
+    name: '🚧 Development Build'
+    uses: acidicoala/SmokeAPI/.github/workflows/matrix-build.yml@master

.github/workflows/matrix-build.yml

@@ -0,0 +1,18 @@
+name: Matrix Build
+
+on:
+  workflow_call:
+
+jobs:
+  build:
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ Linux, Windows ]
+        bitness: [ 32, 64 ]
+
+    uses: acidicoala/KoalaBox/.github/workflows/build-cmake.yml@master
+    with:
+      module: SmokeAPI
+      os: ${{ matrix.os }}
+      bitness: ${{ matrix.bitness }}

.github/workflows/tag-release.yml

@@ -0,0 +1,20 @@
+name: '🏷️ Tag Release'
+
+on:
+  push:
+    tags:
+      - '*'
+
+jobs:
+  build-binaries:
+    name: '🏗️ Build Binaries'
+    uses: acidicoala/SmokeAPI/.github/workflows/matrix-build.yml@master
+
+  create-release:
+    name: '📦 Create Release'
+    uses: acidicoala/KoalaBox/.github/workflows/create-release.yml@master
+    needs: build-binaries
+    with:
+      zip_files: >
+        res/README.txt
+        res/SmokeAPI.config.json

.idea/SmokeAPI.iml

@@ -1,2 +1,2 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<module classpath="CMake" type="CPP_MODULE" version="4" />
+<module classpath="CIDR" type="CPP_MODULE" version="4" />

.idea/dictionaries/project.xml

@@ -4,9 +4,16 @@
       <w>abcdefghijklmnopqrstuvwxyz</w>
       <w>acidicoala</w>
       <w>ajaxgetdlclist</w>
+      <w>cstring</w>
       <w>dlmopen</w>
       <w>dlopen</w>
+      <w>dlsym</w>
+      <w>dynsym</w>
+      <w>elfio</w>
+      <w>endfor</w>
+      <w>ghcr</w>
       <w>indicies</w>
+      <w>inja</w>
       <w>inlinentd</w>
       <w>isteamapps</w>
       <w>isteamclient</w>
@@ -16,9 +23,20 @@
       <w>koality</w>
       <w>koaloader</w>
       <w>libgtk</w>
+      <w>libsteam</w>
+      <w>memcpy</w>
+      <w>movabs</w>
+      <w>movl</w>
+      <w>peparse</w>
+      <w>phnt</w>
       <w>polyhook</w>
+      <w>rtld</w>
       <w>simplecpp</w>
+      <w>steamapi</w>
       <w>steamapps</w>
+      <w>steamclient</w>
+      <w>winhttp</w>
+      <w>winmm</w>
       <w>wstr</w>
     </words>
   </dictionary>

.idea/misc.xml

@@ -20,4 +20,5 @@
     <option name="useRustfmt" value="true" />
     <option name="version" value="2" />
   </component>
+  <component name="WestSettings"><![CDATA[{}]]></component>
 </project>

.idea/runConfigurations/exports_generator__32___linux_.xml

@@ -1,7 +0,0 @@
-<component name="ProjectRunConfigurationManager">
-  <configuration default="false" name="exports_generator [32] [linux]" type="CMakeRunConfiguration" factoryName="Application" PROGRAM_PARAMS="FALSE libsteam_api_o $ProjectFileDir$/res/steamworks/*/binaries/linux32/libsteam_api.so $CMakeCurrentGenerationDir$/generated/libsteam_api_exports.cpp" REDIRECT_INPUT="false" ELEVATE="false" USE_EXTERNAL_CONSOLE="false" EMULATE_TERMINAL="false" PASS_PARENT_ENVS_2="true" PROJECT_NAME="SmokeAPI" TARGET_NAME="exports_generator" CONFIG_NAME="Debug [32]" RUN_TARGET_PROJECT_NAME="SmokeAPI" RUN_TARGET_NAME="exports_generator">
-    <method v="2">
-      <option name="com.jetbrains.cidr.execution.CidrBuildBeforeRunTaskProvider$BuildBeforeRunTask" enabled="true" />
-    </method>
-  </configuration>
-</component>

.idea/runConfigurations/exports_generator__64___win_.xml

@@ -1,7 +0,0 @@
-<component name="ProjectRunConfigurationManager">
-  <configuration default="false" name="exports_generator [64] [win]" type="CMakeRunConfiguration" factoryName="Application" PROGRAM_PARAMS="FALSE steam_api64_o $ProjectFileDir$/res/steamworks/*/binaries/steam_api64.dll $CMakeCurrentGenerationDir$/generated/linker_exports_for_steam_api.h" REDIRECT_INPUT="false" ELEVATE="false" USE_EXTERNAL_CONSOLE="false" EMULATE_TERMINAL="false" PASS_PARENT_ENVS_2="true" PROJECT_NAME="SmokeAPI" TARGET_NAME="exports_generator" CONFIG_NAME="Debug [32]" RUN_TARGET_PROJECT_NAME="SmokeAPI" RUN_TARGET_NAME="exports_generator">
-    <method v="2">
-      <option name="com.jetbrains.cidr.execution.CidrBuildBeforeRunTaskProvider$BuildBeforeRunTask" enabled="true" />
-    </method>
-  </configuration>
-</component>

.idea/runConfigurations/linux_exports_generator__32_.xml

@@ -0,0 +1,7 @@
+<component name="ProjectRunConfigurationManager">
+  <configuration default="false" name="linux_exports_generator [32]" type="CMakeRunConfiguration" factoryName="Application" PROGRAM_PARAMS="--input_libs_glob $ProjectFileDir$/res/steamworks/*/binaries/linux32/libsteam_api.so --output_path $ProjectFileDir$/src/generated/32/proxy_exports" REDIRECT_INPUT="false" ELEVATE="false" USE_EXTERNAL_CONSOLE="false" EMULATE_TERMINAL="false" PASS_PARENT_ENVS_2="true" PROJECT_NAME="SmokeAPI" TARGET_NAME="linux_exports_generator" CONFIG_NAME="Debug [64]" RUN_TARGET_PROJECT_NAME="SmokeAPI" RUN_TARGET_NAME="linux_exports_generator">
+    <method v="2">
+      <option name="com.jetbrains.cidr.execution.CidrBuildBeforeRunTaskProvider$BuildBeforeRunTask" enabled="true" />
+    </method>
+  </configuration>
+</component>

.idea/runConfigurations/linux_exports_generator__64_.xml

@@ -0,0 +1,7 @@
+<component name="ProjectRunConfigurationManager">
+  <configuration default="false" name="linux_exports_generator [64]" type="CMakeRunConfiguration" factoryName="Application" PROGRAM_PARAMS="--input_libs_glob $ProjectFileDir$/res/steamworks/*/binaries/linux64/libsteam_api.so --output_path $ProjectFileDir$/src/generated/64/proxy_exports" REDIRECT_INPUT="false" ELEVATE="false" USE_EXTERNAL_CONSOLE="false" EMULATE_TERMINAL="false" PASS_PARENT_ENVS_2="true" PROJECT_NAME="SmokeAPI" TARGET_NAME="linux_exports_generator" CONFIG_NAME="Debug [64]" RUN_TARGET_PROJECT_NAME="SmokeAPI" RUN_TARGET_NAME="linux_exports_generator">
+    <method v="2">
+      <option name="com.jetbrains.cidr.execution.CidrBuildBeforeRunTaskProvider$BuildBeforeRunTask" enabled="true" />
+    </method>
+  </configuration>
+</component>

.idea/runConfigurations/steamworks_downloader__prompt_.xml

@@ -1,5 +1,5 @@
 <component name="ProjectRunConfigurationManager">
-  <configuration default="false" name="steamworks_downloader [prompt]" type="CMakeRunConfiguration" factoryName="Application" PROGRAM_PARAMS="$Prompt$" REDIRECT_INPUT="false" ELEVATE="false" USE_EXTERNAL_CONSOLE="false" EMULATE_TERMINAL="false" WORKING_DIR="file://$ProjectFileDir$/res" PASS_PARENT_ENVS_2="true" PROJECT_NAME="SmokeAPI" TARGET_NAME="steamworks_downloader" CONFIG_NAME="Debug [32]" RUN_TARGET_PROJECT_NAME="SmokeAPI" RUN_TARGET_NAME="steamworks_downloader">
+  <configuration default="false" name="steamworks_downloader [prompt]" type="CMakeRunConfiguration" factoryName="Application" PROGRAM_PARAMS="$Prompt$" REDIRECT_INPUT="false" ELEVATE="false" USE_EXTERNAL_CONSOLE="false" EMULATE_TERMINAL="false" WORKING_DIR="file://$ProjectFileDir$/res" PASS_PARENT_ENVS_2="true" PROJECT_NAME="SmokeAPI" TARGET_NAME="steamworks_downloader" CONFIG_NAME="Debug [64]" RUN_TARGET_PROJECT_NAME="SmokeAPI" RUN_TARGET_NAME="steamworks_downloader">
     <method v="2">
       <option name="com.jetbrains.cidr.execution.CidrBuildBeforeRunTaskProvider$BuildBeforeRunTask" enabled="true" />
     </method>

.idea/runConfigurations/sync.xml

@@ -1,5 +1,5 @@
 <component name="ProjectRunConfigurationManager">
-  <configuration default="false" name="sync" type="CMakeRunConfiguration" factoryName="Application" REDIRECT_INPUT="false" ELEVATE="false" USE_EXTERNAL_CONSOLE="false" EMULATE_TERMINAL="false" WORKING_DIR="file://$ProjectFileDir$" PASS_PARENT_ENVS_2="true" PROJECT_NAME="SmokeAPI" TARGET_NAME="sync" CONFIG_NAME="Debug [32]" RUN_TARGET_PROJECT_NAME="SmokeAPI" RUN_TARGET_NAME="sync">
+  <configuration default="false" name="sync" type="CMakeRunConfiguration" factoryName="Application" REDIRECT_INPUT="false" ELEVATE="false" USE_EXTERNAL_CONSOLE="false" EMULATE_TERMINAL="false" WORKING_DIR="file://$ProjectFileDir$" PASS_PARENT_ENVS_2="true" PROJECT_NAME="SmokeAPI" TARGET_NAME="sync" CONFIG_NAME="Debug [64]" RUN_TARGET_PROJECT_NAME="SmokeAPI" RUN_TARGET_NAME="sync">
     <method v="2">
       <option name="com.jetbrains.cidr.execution.CidrBuildBeforeRunTaskProvider$BuildBeforeRunTask" enabled="true" />
     </method>

.idea/runConfigurations/windows_exports_generator__64_.xml

@@ -0,0 +1,7 @@
+<component name="ProjectRunConfigurationManager">
+  <configuration default="false" name="windows_exports_generator [64]" type="CMakeRunConfiguration" factoryName="Application" PROGRAM_PARAMS="--forwarded_dll_name &quot;steam_api64_o&quot; --lib_files_glob &quot;$ProjectFileDir$\res\steamworks\*\binaries\steam_api64.dll&quot; --output_file_path &quot;$CMakeCurrentGenerationDir$\generated\linker_exports_for_steam_api.h&quot; --sources_input_path &quot;&quot;" REDIRECT_INPUT="false" ELEVATE="false" USE_EXTERNAL_CONSOLE="false" EMULATE_TERMINAL="false" PASS_PARENT_ENVS_2="true" PROJECT_NAME="SmokeAPI" TARGET_NAME="windows_exports_generator" CONFIG_NAME="Debug [64]" RUN_TARGET_PROJECT_NAME="SmokeAPI" RUN_TARGET_NAME="windows_exports_generator">
+    <method v="2">
+      <option name="com.jetbrains.cidr.execution.CidrBuildBeforeRunTaskProvider$BuildBeforeRunTask" enabled="true" />
+    </method>
+  </configuration>
+</component>

CMakeLists.txt

@@ -1,11 +1,8 @@
 cmake_minimum_required(VERSION 3.24)
 
-project(SmokeAPI VERSION 3.1.3)
+project(SmokeAPI VERSION 4.1.1)
 
 include(KoalaBox/cmake/KoalaBox.cmake)
-if(CMAKE_BUILD_TYPE STREQUAL "Debug")
-    add_definitions(-DKB_DEBUG)
-endif()
 add_subdirectory(KoalaBox)
 add_subdirectory(tools)
 
@@ -29,8 +26,22 @@ set(SMOKE_API_STATIC_SOURCES
     static/smoke_api/steamclient/steamclient.hpp
 )
 
+if(IS_LINUX)
+    set(GENERATED_SOURCES_DIR src/generated/${BITNESS})
+    file(MAKE_DIRECTORY ${GENERATED_SOURCES_DIR})
+    set(GENERATED_SOURCES
+        ${GENERATED_SOURCES_DIR}/proxy_exports.hpp
+        ${GENERATED_SOURCES_DIR}/proxy_exports.cpp
+    )
+
+    foreach(SRC IN LISTS GENERATED_SOURCES)
+        file(TOUCH ${SRC})
+    endforeach()
+endif()
+
 set(SMOKE_API_SOURCES
     ${SMOKE_API_STATIC_SOURCES}
+    ${GENERATED_SOURCES}
     src/smoke_api/smoke_api.cpp
     src/smoke_api/smoke_api.hpp
     src/steam_api/virtuals/isteamapps.cpp
@@ -39,7 +50,6 @@ set(SMOKE_API_SOURCES
     src/steam_api/virtuals/isteamhttp.cpp
     src/steam_api/virtuals/isteaminventory.cpp
     src/steam_api/virtuals/isteamuser.cpp
-    src/steam_api/virtuals/isteamutils.cpp
     src/steam_api/virtuals/steam_api_virtuals.hpp
     src/steam_api/steam_client.hpp
     src/steam_api/steam_client.cpp
@@ -54,7 +64,6 @@ if(WIN32)
 
     list(APPEND SMOKE_API_SOURCES src/main_win.cpp)
 else()
-    set_32_and_64(LINUX_DIR linux32 linux64)
     set(STEAM_API_MODULE libsteam_api)
     set(STEAMCLIENT_DLL steamclient)
 
@@ -74,7 +83,6 @@ target_include_directories(SmokeAPI_common INTERFACE
 )
 target_link_libraries(SmokeAPI_common INTERFACE KoalaBox $<TARGET_OBJECTS:KoalaBox>)
 
-
 ### Static SmokeAPI
 
 add_library(SmokeAPI_static STATIC ${SMOKE_API_STATIC_SOURCES})
@@ -106,23 +114,31 @@ if(WIN32)
     configure_linker_exports(
         TARGET SmokeAPI
         HEADER_NAME "linker_exports_for_steam_api.h"
-        FORWARDED_DLL "${STEAM_API_MODULE}_o"
-        INPUT_SOURCES_DIR ""
-        DLL_FILES_GLOB "${CMAKE_CURRENT_SOURCE_DIR}/res/steamworks/*/binaries/${STEAM_API_MODULE}.dll"
+        FORWARDED_DLL_NAME "${STEAM_API_MODULE}_o"
+        LIB_FILES_GLOB "${CMAKE_CURRENT_SOURCE_DIR}/res/steamworks/*/binaries/${STEAM_API_MODULE}.dll"
+        SOURCES_INPUT_PATH ""
     )
-    configure_linker_exports(
-        TARGET SmokeAPI
-        HEADER_NAME "linker_exports_for_version.h"
-        FORWARDED_DLL "C:/Windows/System32/version.dll"
-        INPUT_SOURCES_DIR ""
-        DLL_FILES_GLOB "C:/Windows/System32/version.dll"
+
+    set(HEADER_CONTENT "#pragma once\n\n")
+
+    foreach(WIN_DLL version winhttp winmm)
+        set(HEADER_NAME "linker_exports_for_${WIN_DLL}.h")
+        configure_linker_exports(
+            TARGET SmokeAPI
+            HEADER_NAME "${HEADER_NAME}"
+            FORWARDED_DLL_NAME "C:/Windows/System32/${WIN_DLL}.dll"
+            LIB_FILES_GLOB "C:/Windows/System32/${WIN_DLL}.dll"
+            SOURCES_INPUT_PATH ""
+        )
+
+        set(HEADER_CONTENT "${HEADER_CONTENT}#include <${HEADER_NAME}>\n")
+    endforeach()
+
+    file(GENERATE
+        OUTPUT "${CMAKE_CURRENT_BINARY_DIR}/generated/linker_exports_for_windows_dlls.h"
+        CONTENT "${HEADER_CONTENT}"
     )
-else()
-#    configure_linker_exports(
-#        TARGET SmokeAPI
-#        HEADER_NAME "libsteam_api_exports.cpp"
-#        FORWARDED_DLL "${STEAM_API_MODULE}_o.so"
-#        DLL_FILES_GLOB "${CMAKE_CURRENT_SOURCE_DIR}/res/steamworks/*/binaries/${LINUX_DIR}/${STEAM_API_MODULE}.so"
-#        INPUT_SOURCES_DIR ""
-#    )
+
+    # Ignore linker warnings regarding COM-related private exports
+    set_target_properties(SmokeAPI PROPERTIES LINK_FLAGS "/ignore:4104")
 endif()

README.md

@@ -3,12 +3,15 @@
 # SmokeAPI
 
 
-_Legit DLC Unlocker for Steamworks._
+
+_Legit DLC ownership emulation for Steamworks._
 
 ## ✨ Features
 
 * `🔓` Emulate DLC ownership in legitimately owned games
 * `🛅` Emulate Inventory item ownership
+* `📄` Optional configuration
+* `🐧` Support for 32-bit and 64-bit Windows and Linux systems
 
 ## 🔗 Links
 
@@ -20,7 +23,7 @@ _Legit DLC Unlocker for Steamworks._
 
 ### ❓ What is SmokeAPI?
 
-SmokeAPI is a DLC unlocker for games that are _legitimately_ owned in your Steam account.
+SmokeAPI is a tool for Steamworks DLC ownership emulation in games that are _legitimately_ owned in Steam.
 It attempts to fool games that use Steamworks SDK (Steamworks) into thinking that you own the game's DLCs.
 However, SmokeAPI does not modify the rest of the Steamworks, hence features like multiplayer, achievements, and so on remain fully functional.
 
@@ -33,7 +36,10 @@ Therefore, **you have to first research the game's topic**, to see if it support
 
 Additionally, there are several points to bear in mind when it comes to unlocking DLCs with SmokeAPI:
 
-* SmokeAPI most definitely will not work with games that use 3rd party DRM, such as games from Ubisoft, Rockstar, etc.* SmokeAPI is unlikely to unlock anything in Free-To-Play games since they typically store all player data on the corresponding game server and hence all the checks are server-side.
+
+* SmokeAPI most definitely will not work with games that use 3rd party DRM, such as games from Ubisoft, Rockstar, etc.
+* SmokeAPI most likely will not work with games that use Denuvo SecureDLC.
+* SmokeAPI is unlikely to unlock anything in Free-To-Play games since they typically store all player data on the corresponding game server and hence all the checks are server-side.
 * SmokeAPI will not work with games that employ additional ownership protection or if the game is using alternative DLC verification mechanism.
 * SmokeAPI is unlikely to work with games that use an anti-cheat, since they typically detect any DLL/EXE that has been tampered with. Sometimes it is possible to disable an anti-cheat, but that typically entails the loss of online capabilities. Search in the respective game topic for more information about how to disable anti-cheat.
 * Some games include DLC files in their base game, regardless of whether you own the DLC or not. However, some games download additional DLC files only after a user has bought the corresponding DLC. In this case, not only will you need to install SmokeAPI, but you also have to get the additional DLC files from somewhere else and put them into the game folder. Up-to-date DLC files often can be found in corresponding game topics.
@@ -66,13 +72,13 @@ SmokeAPI supports **2** installation modes: _Hook mode_ and _Proxy mode_.
 - **Advantages**:
     - Guaranteed to load
 - **Disadvantages**:
-    - Might need reinstallation aftera game update
+    - Might need reinstallation after a game update
 
 My advice is to try installing the unlocker in hook mode first.
 If it doesn't work, try installing it in proxy mode instead.
 If that didn't work, refer to the _Troubleshooting_ section below.
 
-## 🛠 Installation instructions
+## 🛠 Installation instructions (🪟 Windows)
 
 > [!NOTE]
 > To determine the bitness of a game you can open _Task Manager_, navigate to _Details_ tab,
@@ -81,37 +87,47 @@ If that didn't work, refer to the _Troubleshooting_ section below.
 
 ### 🪝 Hook mode
 
+Hook mode itself has two sub-modes: Self-Hook and Hook with injector.
+
+#### 🪝 Self-Hook mode
+
+In self-hook mode SmokeAPI is injected automatically without the help of third-party injectors.
+It works best when a game doesn't have any protections against DLL injection.
+The main advantage of this mode is its minimal setup, which adds only 1 new DLL to the game folder.
+
 - Download the [latest SmokeAPI release zip].
-- From this downloaded zip extract `SmokeAPI32.dll` or `SmokeAPI64.dll`, depending on a game's bitness.
-- Rename the unzipped DLL to `version.dll`.
-- Place this `version.dll` next to the game's `.exe` file.
+- From this downloaded zip extract `smoke_api32.dll` or `smoke_api64.dll`, depending on a game's bitness.
+- Rename the unzipped DLL to `version.dll` or `winhttp.dll` or `winmm.dll`.
+- Place this `version.dll` or `winhttp.dll` or `winmm.dll` next to the game's `.exe` file.
 
 #### 🪝 Hook mode with Koaloader
 
-If a game doesn't load
-`version.dll`, you can use an alternative injector to load SmokeAPI into the game process.
+If a game doesn't load `version.dll` or `winhttp.dll` or `winmm.dll`, you can use an alternative injector to load
+SmokeAPI into the game process.
 One such injector is [Koaloader], which supports different DLLs that a typical game might load.
-For example, assuming that the game loads `winmm.dll`:
+For example, assuming that the game loads `d3d11.dll`:
 
 - Install Koaloader:
     - Download the [latest Koaloader release zip].
-    - From this downloaded zip extract `winmm.dll` from `winmm-32` or `winmm-64`, depending on a game's bitness.
-    - Place `winmm.dll` next to the game's `.exe` file.
+    - From this downloaded zip extract `d3d11.dll` from `d3d11-32` or `d3d11-64`, depending on a game's bitness.
+    - Place `d3d11.dll` next to the game's `.exe` file.
 - Install SmokeAPI
     - Download the [latest SmokeAPI release zip].
-    - From this downloaded zip extract `SmokeAPI32.dll` or `SmokeAPI64.dll`, depending on a game's bitness.
-    - Place `SmokeAPI32.dll` or `SmokeAPI64.dll` next to the game's `.exe` file.
+    - From this downloaded zip extract `smoke_api32.dll` or `smoke_api64.dll`, depending on a game's bitness.
+    - Place `smoke_api32.dll` or `smoke_api64.dll` next to the game's `.exe` file.
 
 #### 🪝 Hook mode with Special K
 
 There are games which have extra protections that break hook mode.
 In such cases, it might be worth trying [Special K], which can inject SmokeAPI as a [custom plugin].
 
+---
+
 ### 🔀 Proxy mode
 
 - Find a `steam_api.dll` or `steam_api64.dll` file in game directory, and rename it to `steam_api_o.dll` or `steam_api64_o.dll`.
 - Download the [latest SmokeAPI release zip].
-- From this downloaded zip extract `SmokeAPI32.dll` or `SmokeAPI64.dll`, depending on a game's bitness.
+- From this downloaded zip extract `smoke_api32.dll` or `smoke_api64.dll`, depending on a game's bitness.
 - Rename this extracted DLL to `steam_api.dll` or `steam_api64.dll`, depending on a game's bitness.
 - Place this renamed unlocker DLL next to the `steam_api_o.dll` or `steam_api64_o.dll` file.
 
@@ -120,6 +136,102 @@ In such cases, it might be worth trying [Special K], which can inject SmokeAPI a
 [Special K]: https://www.special-k.info
 [custom plugin]: https://wiki.special-k.info/en/SpecialK/Tools#custom-plugin
 
+## 🛠️ Installation instructions (🐧 Linux)
+
+> [!NOTE]
+> Linux support in SmokeAPI is highly experimental/unstable and has known issues.
+> If none of the methods below work for you, then consider running a Windows version of a game
+> via Proton compatibility layer and follow the instructions in the Windows section.
+
+### ✔️ Requirements
+
+Linux builds of SmokeAPI depend on several libraries. These libraries are usually included in the 
+[Steam Linux Runtime 3.0 (sniper)](https://github.com/ValveSoftware/steam-runtime#readme),
+so nothing is required to be installed on the system. But when launching a game directly via its executable
+(such as in case of hook mode) your system needs to have the following required libraries installed.
+
+The following list features links in Arch Linux repositories, but if you are using a different distribution,
+you should use the equivalent package for your distro.
+
+Required libraries:
+- [gcc-libs](https://archlinux.org/packages/core/x86_64/gcc-libs/)
+  [[32-bit](https://archlinux.org/packages/core/x86_64/lib32-gcc-libs/)]
+
+- [glibc](https://archlinux.org/packages/core/x86_64/glibc/)
+  [[32-bit](https://archlinux.org/packages/core/x86_64/lib32-glibc/)]
+
+- [libidn2](https://archlinux.org/packages/core/x86_64/libidn2/)
+  [[32-bit](https://archlinux.org/packages/multilib/x86_64/lib32-libidn2/)]
+
+- [libnghttp2](https://archlinux.org/packages/core/x86_64/libnghttp2/)
+  [[32-bit](https://archlinux.org/packages/multilib/x86_64/lib32-libnghttp2/)]
+
+- [zlib](https://archlinux.org/packages/core/x86_64/zlib/)
+  [[32-bit](https://archlinux.org/packages/multilib/x86_64/lib32-zlib/)]
+
+- [zstd](https://archlinux.org/packages/core/x86_64/zstd/)
+  [[32-bit](https://archlinux.org/packages/multilib/x86_64/lib32-zstd/)]
+
+
+Optional libraries:
+- [gtk3](https://archlinux.org/packages/extra/x86_64/gtk3/)
+  [[32-bit](https://archlinux.org/packages/multilib/x86_64/lib32-gtk3/)]
+
+---
+
+Just like on Windows, SmokeAPI features 32 and 64-bit Linux builds.
+In release archive they are named as `libsmoke_api32.so` or `libsmoke_api64.so` respectively.
+However, unlike Windows, it is recommended to use proxy mode, rather than hook mode.
+This is because the current hook mode installation method has to directly launch game
+executable. However, by default Steam doesn't do that, instead it launches certain wrappers
+that setup game environment with optimal parameters. Hence, launching a game without those
+wrappers might cause issues in theory. However, in practice real tests show that hook mode has higher
+chance of success compared to proxy mode. So, at the end of the day, try both modes to see which one works
+best for you.
+
+### 🔀 Proxy mode (🐧 Linux)
+
+Same as on Windows:
+1. Rename the original `libsteam_api.so` to `libsteam_api_o.so`
+2. Extract and paste the `libsmoke_api32.so` or `libsmoke_api64.so` to the same directory, renaming it to `libsteam_api.so`.
+
+### 🪝 Hook mode (🐧 Linux)
+
+Linux doesn't have the same easily exploitable library injection mechanism that Windows has.
+However, it is possible to force any Linux executable to load any library by using the
+`LD_PRELOAD` environment variable. In fact, Steam itself already uses that to inject its overlay,
+hence we can use it as well. But we have to include that overlay library as well when specifying
+`LD_PRELOAD`, otherwise the game will be launched with SmokeAPI, but without Steam overlay.
+
+For example:
+
+1. Extract and paste the `libsmoke_api32.so` or `libsmoke_api64.so` in the root of game's installation directory.
+2. In Steam _Library_ open game's _Properties_, switch to the _General_ tab, and set the following _LAUNCH OPTIONS_:
+
+| Bitness | Launch Options                                                                                                                  |
+|---------|---------------------------------------------------------------------------------------------------------------------------------|
+| 32-bit  | `LD_PRELOAD="./libsmoke_api32.so $HOME/.local/share/Steam/ubuntu12_32/gameoverlayrenderer.so" ./<GameExe32> ; exit ; %command%` |
+| 64-bit  | `LD_PRELOAD="./libsmoke_api64.so $HOME/.local/share/Steam/ubuntu12_64/gameoverlayrenderer.so" ./<GameExe64> ; exit ; %command%` |
+
+Where `<GameExe32>` and `<GameExe64>` correspond to the actual filename of the game executable. For example:
+- `TheEscapists2.x86` (32-bit)
+- `TheEscapists2.x86_64` (64-bit)
+- `_linux/darkest.bin.x86` (32-bit)
+- `_linux/darkest.bin.x86_64` (64-bit)
+- `eurotrucks2` (64-bit)
+- `binaries/victoria3` (64-bit)
+
+And so on. Notice that Linux executables do not have `.exe` extension like on Windows, so make sure to copy the entire
+file name as it is. Naturally, the exact options might change depending on where files are located on your filesystem
+and other environment variables you might have specified previously.
+If you have other environment variables, and you don't know how to correctly combine them,
+then please make extensive use of search engines and LLMs for guidance and examples
+before seeking help the official forum topic.
+
+> [!NOTE]
+> The `; exit ; %command%` at the end of launch options
+> is a trick used to force Steam to directly run the game executable.
+
 ## ⚙ Configuration
 
 SmokeAPI does not require any manual configuration.
@@ -171,7 +283,7 @@ Below you can find an example config where nearly every option has been customiz
 
 ```json
 {
-  "$schema": "https://raw.githubusercontent.com/acidicoala/SmokeAPI/refs/tags/v3.1.2/res/SmokeAPI.schema.json",
+  "$schema": "https://raw.githubusercontent.com/acidicoala/SmokeAPI/refs/tags/v4.0.0/res/SmokeAPI.schema.json",
   "$version": 4,
   "logging": true,
   "log_steam_http": true,
@@ -208,11 +320,12 @@ Below you can find an example config where nearly every option has been customiz
 ```
 </details>
 
+
 ## 🎓 Extra info
 
 ### 🔑 How SmokeAPI works in games with large number of DLCs
 
-Some games that have a large number of DLCs begin ownership verification by querying the Steamworks API for a list of all available DLCs.
+Some the games that have a large number of DLCs begin ownership verification by querying the Steamworks API for a list of all available DLCs.
 Once the game receives the list, it will go over each item and check the ownership.
 The issue arises from the fact that response from Steamworks SDK may max out at 64, depending on how much unowned DLCs the user has.
 To alleviate this issue, SmokeAPI will make a web request to Steam API for a full list of DLCs, which works well most of the time.
@@ -230,6 +343,11 @@ They will be added to the list of missing DLC IDs to facilitate config-less oper
 
 [extra DLCs]: https://github.com/acidicoala/public-entitlements/blob/main/steam/v2/dlc.json
 
+### 🔢 Supported Steamworks SDK versions
+
+SmokeAPI aims to support all Steamworks SDK version.
+At the time of writing, the latest supported version is **1.63**.
+
 ## 🔧 Troubleshooting
 
 ### 🔐 DLCs are not unlocked
@@ -254,10 +372,10 @@ If you have made sure that you picked the right DLL for Koaloader, then try addi
 
 ### 💥 The game is crashing
 
-If the game is crashing or not opening as expected after installing an unlocker, then try to download and install the latest [Microsoft Visual C++ Redistributable for Visual Studio 2015, 2017, 2019, and 2022](https://support.microsoft.com/en-gb/help/2977003/the-latest-supported-visual-c-downloads)
-<details><summary>Download page</summary>
+If the game is crashing or not opening as expected after installing an unlocker, then try to download and install the [Latest supported Visual C++ Redistributable version](https://learn.microsoft.com/en-us/cpp/windows/latest-supported-vc-redist?view=msvc-170#latest-supported-redistributable-version)
+<details><summary>Download page screenshot</summary>
 
-![Download page](https://i.ibb.co/n6K0X27/redist.jpg)
+![Download page](https://i.ibb.co/PZBXqHpB/vc-redist.jpg)
 </details>
 
 ## 🏗️ Building from source
@@ -290,8 +408,17 @@ For example:
 ```
 
 [Visual Studio Build Tools 2022]: https://visualstudio.microsoft.com/downloads/#build-tools-for-visual-studio-2022
+
 [CMake]: https://cmake.org/
 
+### 🆕 Adding support for new Steamworks SDK
+
+- Run `steamworks_downloader [prompt]` providing directory which contains Steamworks SDK zip files.
+- Run `steamworks_parser`
+- Run `linux_exports_generator [32]`
+- Run `linux_exports_generator [64]`
+
+
 ## 📚 Acknowledgments
 
 This project makes use of the following open source projects:
@@ -307,12 +434,18 @@ This project makes use of the following open source projects:
 - [microsoft/wil](https://github.com/microsoft/wil)
 - [p-ranav/glob](https://github.com/p-ranav/glob)
 - [pantor/inja](https://github.com/pantor/inja)
+- [jarro2783/cxxopts](https://github.com/jarro2783/cxxopts)
+- [serge1/ELFIO](https://github.com/serge1/ELFIO)
+- [Mbed-TLS/mbedtls](https://github.com/Mbed-TLS/mbedtls) 
 - [bshoshany/thread-pool](https://github.com/bshoshany/thread-pool)
 - [batterycenter/embed](https://github.com/batterycenter/embed)
 
+
+
 ## 📄 License
 
 This software is licensed under the [Unlicense](https://unlicense.org),
 terms of which are available in [UNLICENSE.txt](UNLICENSE.txt).
 
+
 [Koaloader]: https://github.com/acidicoala/Koaloader

README.template.md

@@ -1,24 +1,24 @@
 {% extends "./KoalaBox/templates/README.base.md" %}
 {% block content %}
 
-_Legit DLC Unlocker for Steamworks._
+_Legit DLC ownership emulation for Steamworks._
 
 ## ✨ Features
 
 * `🔓` Emulate DLC ownership in legitimately owned games
 * `🛅` Emulate Inventory item ownership
+* `📄` Optional configuration
+* `🐧` Support for 32-bit and 64-bit Windows and Linux systems
 
 {% include "KoalaBox/templates/markdown/links.md" %}
 
-
 {% include "KoalaBox/templates/markdown/intro.md" %}
 
-
 {% include "KoalaBox/templates/markdown/usage.md" %}
 
+{% include "KoalaBox/templates/markdown/install-win.md" %}
 
-{% include "KoalaBox/templates/markdown/installation.md" %}
-
+{% include "KoalaBox/templates/markdown/install-linux.md" %}
 
 {% include "KoalaBox/templates/markdown/configuration.md" %}
 
@@ -26,7 +26,7 @@ _Legit DLC Unlocker for Steamworks._
 
 ### 🔑 How SmokeAPI works in games with large number of DLCs
 
-Some games that have a large number of DLCs begin ownership verification by querying the Steamworks API for a list of all available DLCs.
+Some the games that have a large number of DLCs begin ownership verification by querying the Steamworks API for a list of all available DLCs.
 Once the game receives the list, it will go over each item and check the ownership.
 The issue arises from the fact that response from Steamworks SDK may max out at 64, depending on how much unowned DLCs the user has.
 To alleviate this issue, SmokeAPI will make a web request to Steam API for a full list of DLCs, which works well most of the time.
@@ -44,15 +44,24 @@ They will be added to the list of missing DLC IDs to facilitate config-less oper
 
 [extra DLCs]: https://github.com/acidicoala/public-entitlements/blob/main/steam/v2/dlc.json
 
-{% include "KoalaBox/templates/markdown/troubleshooting.md" %}
+### 🔢 Supported Steamworks SDK versions
 
+{{ project_name }} aims to support all Steamworks SDK version.
+At the time of writing, the latest supported version is **1.63**.
+
+{% include "KoalaBox/templates/markdown/troubleshooting.md" %}
 
 {% include "KoalaBox/templates/markdown/building.md" %}
 
+### 🆕 Adding support for new Steamworks SDK
 
-{% include "KoalaBox/templates/markdown/acknowledgements.md" %}
-{% block extra_oss_libs %}
-- [bshoshany/thread-pool](https://github.com/bshoshany/thread-pool)
+- Run `steamworks_downloader [prompt]` providing directory which contains Steamworks SDK zip files.
+- Run `steamworks_parser`
+- Run `linux_exports_generator [32]`
+- Run `linux_exports_generator [64]`
+
+
+{% include "KoalaBox/templates/markdown/acknowledgements.md" %}{% block extra_oss_libs %}- [bshoshany/thread-pool](https://github.com/bshoshany/thread-pool)
 - [batterycenter/embed](https://github.com/batterycenter/embed)
-{% endblock %}
+
 {% endblock %}

res/SmokeAPI.config.json

@@ -1,5 +1,5 @@
 {
-  "$schema": "https://raw.githubusercontent.com/acidicoala/SmokeAPI/refs/tags/v3.1.2/res/SmokeAPI.schema.json",
+  "$schema": "https://raw.githubusercontent.com/acidicoala/SmokeAPI/refs/tags/v4.0.0/res/SmokeAPI.schema.json",
   "$version": 4,
   "logging": true,
   "log_steam_http": false,

res/SmokeAPI.schema.json

@@ -1,6 +1,6 @@
 {
   "$schema": "https://json-schema.org/draft/2020-12/schema",
-  "$id": "https://raw.githubusercontent.com/acidicoala/SmokeAPI/refs/tags/v3.1.2/res/SmokeAPI.schema.json",
+  "$id": "https://raw.githubusercontent.com/acidicoala/SmokeAPI/refs/tags/v4.0.0/res/SmokeAPI.schema.json",
   "title": "SmokeAPI configuration",
   "type": "object",
   "additionalProperties": false,
@@ -120,7 +120,7 @@
   },
   "examples": [
     {
-      "$schema": "https://raw.githubusercontent.com/acidicoala/SmokeAPI/refs/tags/v3.1.2/res/SmokeAPI.schema.json",
+      "$schema": "https://raw.githubusercontent.com/acidicoala/SmokeAPI/refs/tags/v4.0.0/res/SmokeAPI.schema.json",
       "$version": 4,
       "logging": true,
       "log_steam_http": true,

res/extra_build_config.gen.h

@@ -1,4 +1,4 @@
 #pragma once
 
 #define STEAM_API_MODULE    "${STEAM_API_MODULE}"
-#define STEAMCLIENT_DLL "${STEAMCLIENT_DLL}"
+#define STEAMCLIENT_DLL     "${STEAMCLIENT_DLL}"