Salastil/SmokeAPI
1
0
Fork 0
mirror of https://github.com/acidicoala/SmokeAPI.git synced 2025-12-05 21:15:39 -05:00
Code Issues Packages Projects Releases Wiki Activity

Replaced ascii-doc readme with one generated by sync

Browse Source
This commit is contained in:
acidicoala
2025-09-11 15:11:22 +05:00
parent 8ee2d77115
commit b2ab3c3116
15 changed files with 488 additions and 353 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
.clang-tidy
View File

@@ -70,4 +70,4 @@ misc-*,
-readability-function-cognitive-complexity, -readability-function-cognitive-complexity,
-*-include-cleaner, -*-include-cleaner,
-*-lambda-function-name, -*-lambda-function-name,
-*-err58-cpp' -*-err58-cpp'

2
.gitattributes vendored
View File

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

2
CMakeLists.txt
View File

@@ -4,7 +4,7 @@ project(SmokeAPI VERSION 3.1.1)
include(KoalaBox/cmake/KoalaBox.cmake) include(KoalaBox/cmake/KoalaBox.cmake)
add_subdirectory(KoalaBox EXCLUDE_FROM_ALL) add_subdirectory(KoalaBox)
add_subdirectory(tools) add_subdirectory(tools)
set_32_and_64(STEAMAPI_DLL steam_api) set_32_and_64(STEAMAPI_DLL steam_api)

2
KoalaBox

Submodule KoalaBox updated: ceff9cfe5f...90c412154d

304
README.adoc
View File

@@ -1,304 +0,0 @@
= SmokeAPI
_Legit DLC Unlocker for Steamworks_
== ✨ Features
* 🔓 Legit DLC Unlocking
* 🛅 Inventory emulation
* 📝 Config-less operation
* 2️⃣ installation methods:
** 🪝 Hook mode
** 🔀 Proxy mode
== 🔗 Links
:forum-topic: https://cs.rin.ru/forum/viewtopic.php?p=2597932#p2597932[SmokeAPI forum topic]
* 📥 https://github.com/acidicoala/SmokeAPI/releases/latest[Download the latest release]
* 💬 {forum-topic}
== 📖 Introduction
=== What is SmokeAPI?
SmokeAPI is a DLC unlocker for the games that are legitimately owned in your Steam account.
It attempts to fool games that use Steamworks SDK into believing that you own desired DLCs.
However, SmokeAPI does not modify the rest of the Steamworks SDK, hence features like multiplayer, achievements, etc. remain fully functional.
IMPORTANT: DLC unlocking is possible only in games that specifically use Steamworks SDK for ownership verification.
But games may implement additional ownership checks, which may require custom solutions.
If the check is server-side, as is the case in online-only games, then SmokeAPI cannot help in any way.
Finally, even if you unlock the DLCs, games might still require additional DLC files, which would have to be downloaded from somewhere else.
Check corresponding game topic in the forum for possible download links.
.Supported versions
[%collapsible]
====
SmokeAPI aims to support all released SteamAPI versions.
When it encountered a new, unsupported interface version, it will fall back on the latest supported version.
Below is a list of supported interface versions:
* ISteamClient v6 — v21. (Versions before 6 did not contain any DLC related interfaces)
* ISteamApps v2 — v8. (Version 1 did not contain any DLC related functions)
* ISteamUser v12 — v23. (Versions before 12 did not contain any DLC related functions)
* ISteamInventory v1 — v3.
Steam inventory does not work in all games with steam inventory because of custom implementation, and online checks.
====
== 🛠 Installation Instructions
WARNING: Please proceed with installation at your own risk.
Usage of this unlocker entails breaking one or more terms of service, which might result in a permanent ban/deactivation of your account.
:koaloader: https://github.com/acidicoala/Koaloader[Koaloader]
:smokeapi_release: https://github.com/acidicoala/SmokeAPI/releases/latest[SmokeAPI Releases]
SmokeAPI is loaded into a game process, which limits it to that particular game only.
SmokeAPI supports 2 installation modes: hook mode and proxy mode.
|===
|Mode |Advantages |Disadvantages
|🪝 Hook mode
|Persists after game updates; Can be loaded by other injectors.
|Might need an additional DLL (Koaloader)
|🔀 Proxy mode
|Guaranteed to load
|Might need reinstallation if Steam updates affected DLL files
|===
Try installing the unlocker in hook mode first.
If it doesn't work, try installing it in proxy mode.
=== 🪝 Hook mode
. Download the latest SmokeAPI release zip from {smokeapi_release}.
. From SmokeAPI archive unpack `SmokeAPI32.dll` / `SmokeAPI64.dll`, depending on the game bitness
. Rename the unpacked DLL to `version.dll`.
. Place `version.dll` next to the game's `.exe` file.
=== 🪝 Hook mode (Alternative installation)
:special_k: https://www.special-k.info[Special K]
:custom_plugin: https://wiki.special-k.info/en/SpecialK/Tools#custom-plugin[custom plugin]
If a game doesn't load `version.dll`, you can use one of the {koaloader} DLLs that the game does in fact load.
For example, assuming that the game loads `winmm.dll`:
. Download the latest Koaloader release zip from https://github.com/acidicoala/Koaloader/releases/latest[Koaloader Releases].
. From Koaloader archive unpack `winmm.dll` from `winmm-32` or `winmm-64`, depending on the game bitness, and place it next to the game exe file.
. Download the latest SmokeAPI release zip from {smokeapi_release}.
. From SmokeAPI archive unpack `SmokeAPI32.dll` / `SmokeAPI64.dll`, depending on the game bitness.
. Place the unpacked DLL next to the game's `exe` file.
[[special_k_note]]
IMPORTANT: 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 `steam_api.dll` / `steam_api64.dll` file in game directory, and rename it to `steam_api_o.dll` / `steam_api64_o.dll`.
. Download the latest SmokeAPI release zip from {smokeapi_release}.
. From SmokeAPI archive unpack `SmokeAPI32.dll` / `SmokeAPI64.dll`, depending on the game bitness.
. Rename the unpacked DLL to `steam_api.dll` / `steam_api64.dll` and place it next to the `steam_api_o.dll` / `steam_api64_o.dll` file.
IMPORTANT: There are games which have extra protections that break proxy mode.
In such cases, see the note on <<special_k_note, Hook mode with Special K>>
'''
If the unlocker is not working as expected, then please fully read the https://gist.github.com/acidicoala/2c131cb90e251f97c0c1dbeaf2c174dc[Generic Unlocker Installation Instructions] before seeking support in the {forum-topic}.
== ⚙ Configuration
NOTE: This document describes configuration for version 4 of SmokeAPI.
You can find the version 3 documentation https://github.com/acidicoala/SmokeAPI/blob/v3.0.0/README.adoc#-configuration[here].
:fn-app-id: footnote:fn-app-id[App/DLC IDs can be obtained from https://steamdb.info[SteamDB] or https://steambase.io[Steambase]. Keep in mind that you need to be signed in with a steam account in order to see accurate inventory item IDs on that website.]
SmokeAPI does not require any manual configuration.
By default, it uses the most reasonable options and tries to unlock all DLCs that it can.
However, there might be circumstances in which you need more custom-tailored behaviour, such as disabling certain DLCs, or selectively enabling just a few of them.
In this case you can use a configuration file link:res/SmokeAPI.config.json[SmokeAPI.config.json] that you can find here in this repository or in the release zip.
To use it, simply place it next to the SmokeAPI DLL.
It will be read upon each launch of the game.
In the absence of the config file, default values specified below will be used.
The configuration file is expected to conform to the JSON standard.
All options within the config file are optional.
`logging`:: Toggles generation of a `SmokeAPI.log.log` file.
+
[horizontal]
Type::: Boolean
Default::: `false`
`log_steam_http`:: Toggles logging of _SteamHTTP_ traffic.
+
[horizontal]
Type::: Boolean
Default::: `false`
`default_app_status`:: This option sets the default DLC unlocking behaviour.
+
[horizontal]
Possible values:::
+
[horizontal]
`original`:::: Leaves DLC unlock status unmodified, unless specified otherwise.
`unlocked`:::: Unlocks all DLCs in all games, unless specified otherwise.
Type::: String
Default::: `unlocked`
`override_app_status`:: This option overrides the status of all DLCs that belong to a specified app ID{fn-app-id}.
+
[horizontal]
Possible values::: An object with key-value pairs, where the key corresponds to the app ID, and value to the app status.
Possible app status values are defined in the `default_app_status` option.
Type::: Object
Default::: `{}`
`override_dlc_status`:: This option overrides the status of individual DLCs, regardless of the corresponding app status.
+
[horizontal]
Possible values::: An object with key-value pairs, where the key corresponds to the app ID, and value to the app status.
Possible app status values are defined in the `default_app_status` option.
Furthermore, it is possible to lock even the legitimately locked DLCs by setting the corresponding app status value to `locked`.
Type::: Object
Default::: `{}`
`auto_inject_inventory`:: Toggles whether SmokeAPI should automatically inject a list of all registered inventory items, when a game queries user inventory
+
[horizontal]
Type::: Boolean
Default::: `true`
`extra_inventory_items`:: A list of inventory items IDs{fn-app-id} that will be added in addition to the automatically injected items.
+
[horizontal]
Type::: Array (of Integers)
Default::: `[]`
=== Advanced options
`$version`:: A technical field reserved for use by tools like GUI config editors.
Do not modify this value.
+
[horizontal]
Type::: Integer
Default::: `3`
`extra_dlcs`:: See <<How SmokeAPI works in games with large number of DLCs>> to understand the use case for this option.
+
[horizontal]
Possible values::: An object with key-value pairs, where the key corresponds to the app ID, and value to the object that contains DLC IDs.
The format is the same as in the aforementioned GitHub config.
Type::: Object
Default::: `{}`
.Complete example
[%collapsible]
====
[source,json]
----
{
"$version": 4,
"logging": true,
"log_steam_http": true,
"default_app_status": "unlocked",
"override_app_status": {
"1234": "original",
"4321": "unlocked"
},
"override_dlc_status": {
"1234": "original",
"4321": "unlocked",
"5678": "locked"
},
"auto_inject_inventory": true,
"extra_inventory_items": [],
"extra_dlcs": {
"1234": {
"dlcs": {
"56789": "Example DLC 1"
}
},
"4321": {
"dlcs": {
"98765": "Example DLC 2",
"98766": "Example DLC 3"
}
}
}
}
----
====
== 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.
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.
Unfortunately, even the web API does not solve all of our problems, because it will return only DLCs that are available in Steam store.
This means that DLCs without a dedicated store offer, such as pre-order DLCs will be left out.
That's where the `extra_dlcs` config option comes into play.
You can specify those missing DLC IDs there, and SmokeAPI will make them available to the game.
However, this introduces the need for manual configuration, which goes against the ideals of this project.
To remedy this issue SmokeAPI will also fetch a https://github.com/acidicoala/public-entitlements/blob/main/steam/v2/dlc.json[manually maintained list of extra DLCs] stored in a GitHub repository.
The purpose of this document is to contain all the DLC IDs that are lacking a Steam store page.
This enables SmokeAPI to unlock all DLCs without any config file at all.
Feel free to report in the {forum-topic} games that have more than 64 DLCs,
_and_ have DLCs without a dedicated store page.
They will be added to the list of missing DLC IDs to facilitate config-less operation.
== 🏗️ Building from source
=== 🚦 Requirements
:vs-bt-2022: https://visualstudio.microsoft.com/downloads/#build-tools-for-visual-studio-2022[Visual Studio Build Tools 2022]
* CMake v3.24 (Make sure that cmake is available from powershell)
* {vs-bt-2022} with `Desktop Development for C++` workload installed
** Tested on Windows 11 SDK (10.0.26100.4188)
=== 👨‍💻 Commands
Build the project
----
.\build.ps1 <arch> <config>
----
where
[horizontal]
arch::: `32` or `64`
config::: `Debug` or `Release`
For example:
----
.\build.ps1 64 Release
----
== 🐞 Known issues
* Crashes on startup in Project Winter in hook mode (proxy mode works fine).
== 📚 Open-Source libraries
* https://github.com/batterycenter/embed[batterycenter/embed]
* https://github.com/bshoshany/thread-pool[bshoshany/thread-pool]
* + https://github.com/acidicoala/Koalabox?tab=readme-ov-file#-open-source-libraries[libraries used by KoalaBox]
== 📄 License
This software is licensed under the https://unlicense.org/[Unlicense], terms of which are available in link:UNLICENSE.txt[UNLICENSE.txt]

318
README.md Normal file
View File

@@ -0,0 +1,318 @@
<!-- Generated by KoalaBox::sync tool. Manual changes to this file will be lost. -->
# SmokeAPI
_Legit DLC Unlocker for Steamworks._
## ✨ Features
* `🔓` Emulate DLC ownership in legitimately owned games
* `🛅` Emulate Inventory item ownership
## 🔗 Links
* `📥` [Download the latest release](https://github.com/acidicoala/SmokeAPI/releases/latest)
* `🪧` [SmokeAPI forum topic](https://cs.rin.ru/forum/viewtopic.php?p=2597932#p2597932)
* `🗂️` [DLC Database](https://steamdb.info/)
## 📖 Introduction
### ❓ What is SmokeAPI?
SmokeAPI is a DLC unlocker for games that are _legitimately_ owned in your Steam account.
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.
### ❔ Which games are supported?
Only games that use Steamworks SDK for the DLC ownership verification are supported.
Hence, if a game's installation directory does not contain any `steam_api.dll` or `steam_api64.dll` files then it's definitely not supported.
Even if a game uses Steamworks DLL, it's not guaranteed to be supported because each game might implement additional custom verification checks.
Therefore, **you have to first research the game's topic**, to see if it supports unlocking.
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 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.
* Some games don't use any DRM at all, in which case SmokeAPI is useless. All you need to do is to download the DLC files and place them in the game folder.
## :shipit: Usage
> [!WARNING]
> Please proceed with usage at your own risk.
> Usage of this unlocker entails breaking one or more terms of service,
> which might result in a permanent loss of your account.
To use SmokeAPI, you need to install it into the game folder following the instructions below.
Once installed, SmokeAPI is automatically loaded by a game every time you launch the game.
SmokeAPI supports **2** installation modes: _Hook mode_ and _Proxy mode_.
### ↔️ Mode comparison
#### 🪝 Hook mode
- **Advantages**:
- Persists after game updates
- Can be loaded by other injectors
- Can sometimes bypass DLL integrity checks
- **Disadvantages**:
- Might need an additional DLL to get injected (like [Koaloader])
#### 🔀 Proxy mode
- **Advantages**:
- Guaranteed to load
- **Disadvantages**:
- Might need reinstallation aftera 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
> [!NOTE]
> To determine the bitness of a game you can open _Task Manager_, navigate to _Details_ tab,
> right-click on the column headers, click _Select columns_, tick checkbox next to _Platform_ and click _OK_.
> This will allow you to see a game's bitness in the _Details_ tab while a game is running.
### 🪝 Hook mode
- 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.
#### 🪝 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.
One such injector is [Koaloader], which supports different DLLs that a typical game might load.
For example, assuming that the game loads `winmm.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.
- 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.
#### 🪝 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.
- 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.
[latest SmokeAPI release zip]: https://github.com/acidicoala/SmokeAPI/releases/latest
[latest Koaloader release zip]: https://github.com/acidicoala/Koaloader/releases/latest
[Special K]: https://www.special-k.info
[custom plugin]: https://wiki.special-k.info/en/SpecialK/Tools#custom-plugin
## ⚙ Configuration
SmokeAPI does not require any manual configuration.
By default, it uses the most reasonable options and tries to unlock all DLCs that it can.
However, there might be circumstances in which you need more custom-tailored behaviour, such as disabling certain DLCs, or selectively enabling just a few of them.
In this case you can use a configuration file [SmokeAPI.config.json](res/SmokeAPI.config.json) that you can find here in this repository or in the release zip.
To use it, simply place it next to the SmokeAPI DLL.
It will be read upon each launch of a game.
The config file is expected to conform to the JSON standard. It is recommended to use a text editor with JSON schema supports. This greatly assists with editing since it warns not just about syntax errors, but also about invalid values. One such editor is [Visual Studio Code](https://code.visualstudio.com/).
<details><summary>VS Code demo</summary>
This example showcases how VS code highlights an invalid value and displays a list of valid values that are accepted.
![VS Code demo](https://i.ibb.co/0y45qgtQ/schema-config-demo.jpg)
</details>
Below you can find the detailed description of each available config option. In the absence of the config file, default values specified below will be used.
| Option | Description | Type | Default | Valid values |
|--------|-------------|------|---------|--------------|
| `logging` | Enables logging to SmokeAPI.log.log file. | Boolean | `false` | `true` or `false`. |
| `log_steam_http` | Toggles logging of SteamHTTP traffic | Boolean | `false` | `true` or `false`. |
| `default_app_status` | Specifies default DLC status. | String | `"unlocked"` | `"unlocked"` or `"locked"` or `"original"`. |
| `override_app_status` | Overrides the status of all DLCs that belong to a specified app ID. | Object | `{}` | An object with `"key": "value"` pairs, where key is App ID and value is App status. |
| `override_dlc_status` | Overrides the status of individual DLCs, regardless of the corresponding app status. | Object | `{}` | An object with `"key": "value"` pairs, where key is DLC ID and value is DLC status. |
| `auto_inject_inventory` | Specifies whether SmokeAPI should automatically inject a list of all registered inventory items, when a game queries user inventory | Boolean | `true` | `true` or `false`. |
| `extra_inventory_items` | A list of inventory item IDs that will be added in addition to the automatically injected items. | Array | `[]` | An array of integer App IDs. |
| `extra_dlcs` | See [Extra info](#how_smokeapi_works_in_games_with_large_number_of_dlcs) to understand the use case for this option. | Object | `{}` | An object with `"key": "value"`, where the key is App ID and value is an object with `"dlcs"` property. See the complete example for more. |
<details><summary>Advanced options</summary>
[//]: # (Admonitions don't work inside collapsible spoilers on GitHub :/)
**NOTE**: These options do not affect the unlocker, and should be left unmodified. They serve as utilities for text or GUI editors.
| Option | Description | Type | Default | Valid values |
|--------|-------------|------|---------|--------------|
| `$schema` | URL of a JSON Schema that corresponds to this config. | String | [SmokeAPI.schema.json](res/SmokeAPI.schema.json) | URL to a valid SmokeAPI config JSON schema. |
| `$version` | Reserved for use by tools like GUI config editors. | Integer | `4` | Integer numbers from 1 and beyond. |
</details>
---
Below you can find an example config where nearly every option has been customized.
<details><summary>Complete example</summary>
```json
{
"$schema": "https://raw.githubusercontent.com/acidicoala/SmokeAPI/refs/tags/v3.1.1/res/SmokeAPI.schema.json",
"$version": 4,
"logging": true,
"log_steam_http": true,
"default_app_status": "unlocked",
"override_app_status": {
"1234": "original",
"4321": "unlocked"
},
"override_dlc_status": {
"1234": "original",
"4321": "unlocked",
"5678": "locked"
},
"auto_inject_inventory": true,
"extra_inventory_items": [
9876,
8765,
7654
],
"extra_dlcs": {
"1234": {
"dlcs": {
"56789": "Example DLC 1"
}
},
"4321": {
"dlcs": {
"98765": "Example DLC 2",
"98766": "Example DLC 3"
}
}
}
}
```
</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.
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.
Unfortunately, even the web API does not solve all of our problems, because it will return only DLCs that are available in Steam store.
This means that DLCs without a dedicated store offer, such as pre-order DLCs will be left out.
That's where the `extra_dlcs` config option comes into play.
You can specify those missing DLC IDs there, and SmokeAPI will make them available to the game.
However, this introduces the need for manual configuration, which goes against the ideals of this project.
To remedy this issue SmokeAPI will also fetch a manually maintained list of [extra DLCs] stored in a GitHub repository.
The purpose of that JSON file is to contain all the DLC IDs that are lacking a Steam store page.
This enables SmokeAPI to unlock all DLCs without any config file at all.
Feel free to report in the {forum-topic} games that have more than 64 DLCs,
_and_ have DLCs without a dedicated store page.
They will be added to the list of missing DLC IDs to facilitate config-less operation.
[extra DLCs]: https://github.com/acidicoala/public-entitlements/blob/main/steam/v2/dlc.json
## 🔧 Troubleshooting
### 🔐 DLCs are not unlocked
There are many reasons why the DLCs remain locked. In some games DLC unlocking is inherently impossible because of online-only state, profile, etc. In other cases it may be possible, but only after dealing with custom game checks. To learn about the specifics, consult the corresponding game topic in [the forum].
If you are sure that DLC unlocking in a targeted game is inherently possible, then you have to verify that installation was successful. To do that, add the unlocker's config file next to the unlocker DLL and enable logging in it. You should see a `*.log` file being generated upon the game launch, which could provide insight into what went wrong. Use this log file when requesting support in the forum. If after launching the game no `*.log` file was generated, then it means that installation was not performed correctly.
If you installed the unlocker via proxy mode, then make sure that you have renamed the unlocker DLL exactly like the original DLL and placed it exactly in its place. Also verify that the original DLL was renamed by adding `_o` at the end of the filename. Notice that the second symbol is a literal `o` (short for original), not a numeral zero `0`.
If you installed the unlocker via hook mode, then make sure that you have picked a compatible Koaloader DLL. Not all games will try to load `version.dll`, hence you need will need to try another. You can use [Process Monitor] to find out which Koaloader DLL is supported by a game, and where to place it. Click on the cyan funnel icon on the top to open filter editor, and add 3 filters (Process name, Result, and Path), as shown in the screenshot below. Launch the game with the Process Monitor active, and you should see DLLs that a game was trying to load from its directory.
<details><summary>Process Monitor screenshot</summary>
![Process Monitor](https://i.ibb.co/VmdVWLN/image.png)
</details>
[the forum]: https://cs.rin.ru/forum/viewforum.php?f=10
[Process Monitor]: https://docs.microsoft.com/en-us/sysinternals/downloads/procmon
If you have made sure that you picked the right DLL for Koaloader, then try adding Koaloader's config file and enable logging in it. The log file from Koaloader can show if it was able to successfully load the unlocker DLL.
### 💥 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>
![Download page](https://i.ibb.co/n6K0X27/redist.jpg)
</details>
## 🏗️ Building from source
### ✔️ Requirements
- [CMake] v3.24 or newer (Make sure that cmake is available from powershell)
- [Visual Studio Build Tools 2022] with `Desktop Development for C++` workload installed
- Tested on Windows 11 SDK (10.0.26100.4188)
### 👨‍💻 Commands
Build the project
```powershell
.\build.ps1 $arch $config
```
where
| Variable | Valid values |
|----------|----------------------|
| $arch | `32` or `64` |
| $config | `Debug` or `Release` |
For example:
```powershell
.\build.ps1 64 Release
```
[Visual Studio Build Tools 2022]: https://visualstudio.microsoft.com/downloads/#build-tools-for-visual-studio-2022
[CMake]: https://cmake.org/
## 📚 Acknowledgments
This project makes use of the following open source projects:
- [richgel999/miniz](https://github.com/richgel999/miniz)
- [libcpr/cpr](https://github.com/libcpr/cpr)
- [nlohmann/json](https://github.com/nlohmann/json)
- [stevemk14ebr/PolyHook_2_0](https://github.com/stevemk14ebr/PolyHook_2_0)
- [gabime/spdlog](https://github.com/gabime/spdlog)
- [nsumner/cpp-tree-sitter](https://github.com/nsumner/cpp-tree-sitter)
- [tree-sitter/tree-sitter-cpp](https://github.com/tree-sitter/tree-sitter-cpp)
- [nemtrif/utfcpp](https://github.com/nemtrif/utfcpp)
- [microsoft/wil](https://github.com/microsoft/wil)
- [p-ranav/glob](https://github.com/p-ranav/glob)
- [pantor/inja](https://github.com/pantor/inja)
- [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

58
README.template.md Normal file
View File

@@ -0,0 +1,58 @@
{% extends "./KoalaBox/templates/README.base.md" %}
{% block content %}
_Legit DLC Unlocker for Steamworks._
## ✨ Features
* `🔓` Emulate DLC ownership in legitimately owned games
* `🛅` Emulate Inventory item ownership
{% include "KoalaBox/templates/markdown/links.md" %}
{% include "KoalaBox/templates/markdown/intro.md" %}
{% include "KoalaBox/templates/markdown/usage.md" %}
{% include "KoalaBox/templates/markdown/installation.md" %}
{% include "KoalaBox/templates/markdown/configuration.md" %}
## 🎓 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.
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.
Unfortunately, even the web API does not solve all of our problems, because it will return only DLCs that are available in Steam store.
This means that DLCs without a dedicated store offer, such as pre-order DLCs will be left out.
That's where the `extra_dlcs` config option comes into play.
You can specify those missing DLC IDs there, and SmokeAPI will make them available to the game.
However, this introduces the need for manual configuration, which goes against the ideals of this project.
To remedy this issue SmokeAPI will also fetch a manually maintained list of [extra DLCs] stored in a GitHub repository.
The purpose of that JSON file is to contain all the DLC IDs that are lacking a Steam store page.
This enables SmokeAPI to unlock all DLCs without any config file at all.
Feel free to report in the {forum-topic} games that have more than 64 DLCs,
_and_ have DLCs without a dedicated store page.
They will be added to the list of missing DLC IDs to facilitate config-less operation.
[extra DLCs]: https://github.com/acidicoala/public-entitlements/blob/main/steam/v2/dlc.json
{% include "KoalaBox/templates/markdown/troubleshooting.md" %}
{% include "KoalaBox/templates/markdown/building.md" %}
{% 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 %}

2
UNLICENSE.txt
View File

@@ -21,4 +21,4 @@ OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
OTHER DEALINGS IN THE SOFTWARE. OTHER DEALINGS IN THE SOFTWARE.
For more information, please refer to <https://unlicense.org> For more information, please refer to <https://unlicense.org>

4
res/README.txt
View File

@@ -2,11 +2,11 @@ Project page: https://github.com/acidicoala/SmokeAPI#readme
Forum topic: https://cs.rin.ru/forum/viewtopic.php?p=2597932#p2597932 Forum topic: https://cs.rin.ru/forum/viewtopic.php?p=2597932#p2597932
DLC Database: https://steamdb.info/ DLC Database: https://steamdb.info/
### NOTE ### *** NOTE ***
Do NOT use the SmokeAPI.config.json file unless you have a good reason. Do NOT use the SmokeAPI.config.json file unless you have a good reason.
The default config file enables logging, which might have a negative impact on performance in games. The default config file enables logging, which might have a negative impact on performance in games.
So, unless you really need to see logs for debugging issues, it is advised to either: So, unless you really need to see logs for debugging issues, it is advised to either:
disable logging in the config file by setting the "logging" field to false disable logging in the config file by setting the "logging" field to false
or or
not use the SmokeAPI.config.json file at all not use the SmokeAPI.config.json file at all.

4
res/SmokeAPI.config.json
View File

@@ -1,8 +1,8 @@
{ {
"$schema": "https://raw.githubusercontent.com/acidicoala/SmokeAPI/refs/tags/v3.1.0/res/SmokeAPI.schema.json", "$schema": "https://raw.githubusercontent.com/acidicoala/SmokeAPI/refs/tags/v3.1.1/res/SmokeAPI.schema.json",
"$version": 4, "$version": 4,
"logging": true, "logging": true,
"log_steam_http": true, "log_steam_http": false,
"default_app_status": "unlocked", "default_app_status": "unlocked",
"override_app_status": {}, "override_app_status": {},
"override_dlc_status": {}, "override_dlc_status": {},

87
res/SmokeAPI.schema.json
View File

@@ -1,71 +1,71 @@
{ {
"$schema": "https://json-schema.org/draft/2020-12/schema", "$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://example.com/smokeapi-config.schema.json", "$id": "https://raw.githubusercontent.com/acidicoala/SmokeAPI/refs/tags/v3.1.1/res/SmokeAPI.schema.json",
"title": "SmokeAPI configuration", "title": "SmokeAPI configuration",
"type": "object", "type": "object",
"additionalProperties": false, "additionalProperties": false,
"properties": { "properties": {
"$schema": { "$schema": {
"type": "string", "type": "string",
"description": "The URI of the JSON Schema used to validate this config." "description": "URL of a JSON Schema that corresponds to this config.",
"x-default": "[SmokeAPI.schema.json](res/SmokeAPI.schema.json)",
"x-valid-values": "URL to a valid SmokeAPI config JSON schema."
}, },
"$version": { "$version": {
"type": "integer", "type": "integer",
"description": "Reserved for use by tools like GUI config editors.",
"const": 4, "const": 4,
"description": "A technical field reserved for tools like GUI config editors. Do not modify this value." "x-valid-values": "Integer numbers from 1 and beyond."
}, },
"logging": { "logging": {
"type": "boolean", "type": "boolean",
"default": false, "default": false,
"description": "Toggles generation of a SmokeAPI.log.log file." "x-packaged-default": true,
"description": "Enables logging to SmokeAPI.log.log file.",
"x-valid-values": "`true` or `false`."
}, },
"log_steam_http": { "log_steam_http": {
"type": "boolean", "type": "boolean",
"default": false, "default": false,
"description": "Toggles logging of SteamHTTP traffic" "description": "Toggles logging of SteamHTTP traffic",
"x-valid-values": "`true` or `false`."
}, },
"default_app_status": { "default_app_status": {
"description": "Sets the default DLC unlocking behaviour.", "type": "string",
"description": "Specifies default DLC status.",
"default": "unlocked", "default": "unlocked",
"$ref": "#/$defs/AppStatus" "$ref": "#/$defs/AppStatus",
"x-valid-values": "`\"unlocked\"` or `\"locked\"` or `\"original\"`."
}, },
"override_app_status": { "override_app_status": {
"type": "object", "type": "object",
"default": {}, "default": {},
"description": "Overrides the status of all DLCs that belong to a specified app ID. Keys are app IDs (as strings).", "description": "Overrides the status of all DLCs that belong to a specified app ID.",
"patternProperties": { "patternProperties": {
"^\\d{1,10}$": { "^\\d{1,10}$": {
"$ref": "#/$defs/AppStatus" "$ref": "#/$defs/AppStatus"
} }
}, },
"additionalProperties": false "additionalProperties": false,
"x-valid-values": "An object with `\"key\": \"value\"` pairs, where key is App ID and value is App status."
}, },
"override_dlc_status": { "override_dlc_status": {
"type": "object", "type": "object",
"default": {}, "default": {},
"description": "Overrides the status of individual DLCs, regardless of the corresponding app status. Keys are DLC IDs (as strings).", "description": "Overrides the status of individual DLCs, regardless of the corresponding app status.",
"patternProperties": { "patternProperties": {
"^\\d{1,10}$": { "^\\d{1,10}$": {
"$ref": "#/$defs/AppStatus" "$ref": "#/$defs/AppStatus"
} }
}, },
"additionalProperties": false "additionalProperties": false,
}, "x-valid-values": "An object with `\"key\": \"value\"` pairs, where key is DLC ID and value is DLC status."
"extra_dlcs": {
"type": "object",
"default": {},
"description": "Map of app IDs to objects containing DLC IDs with their display names.",
"patternProperties": {
"^\\d{1,10}$": {
"$ref": "#/$defs/App"
}
},
"additionalProperties": false
}, },
"auto_inject_inventory": { "auto_inject_inventory": {
"type": "boolean", "type": "boolean",
"default": true, "default": true,
"description": "Whether SmokeAPI should automatically inject a list of all registered inventory items when a game queries user inventory." "description": "Specifies whether SmokeAPI should automatically inject a list of all registered inventory items, when a game queries user inventory",
"x-valid-values": "`true` or `false`."
}, },
"extra_inventory_items": { "extra_inventory_items": {
"type": "array", "type": "array",
@@ -74,25 +74,30 @@
"items": { "items": {
"type": "integer", "type": "integer",
"minimum": 0 "minimum": 0
} },
"x-valid-values": "An array of integer App IDs."
},
"extra_dlcs": {
"type": "object",
"default": {},
"description": "See [Extra info](#how_smokeapi_works_in_games_with_large_number_of_dlcs) to understand the use case for this option.",
"patternProperties": {
"^\\d{1,10}$": {
"$ref": "#/$defs/App"
}
},
"additionalProperties": false,
"x-valid-values": "An object with `\"key\": \"value\"`, where the key is App ID and value is an object with `\"dlcs\"` property. See the complete example for more."
} }
}, },
"$defs": { "$defs": {
"AppStatus": { "AppStatus": {
"description": "Unlock status for apps or DLCs.", "description": "Unlock status for apps or DLCs.",
"anyOf": [ "type": "string",
{ "enum": [
"type": "string", "original",
"enum": [ "unlocked",
"original", "locked"
"unlocked",
"locked"
]
},
{
"type": "null",
"description": "Represents UNDEFINED in the enum."
}
] ]
}, },
"App": { "App": {
@@ -115,7 +120,7 @@
}, },
"examples": [ "examples": [
{ {
"$schema": "https://raw.githubusercontent.com/acidicoala/SmokeAPI/refs/tags/v3.1.0/res/SmokeAPI.schema.json", "$schema": "https://raw.githubusercontent.com/acidicoala/SmokeAPI/refs/tags/v3.1.1/res/SmokeAPI.schema.json",
"$version": 4, "$version": 4,
"logging": true, "logging": true,
"log_steam_http": true, "log_steam_http": true,
@@ -130,7 +135,11 @@
"5678": "locked" "5678": "locked"
}, },
"auto_inject_inventory": true, "auto_inject_inventory": true,
"extra_inventory_items": [], "extra_inventory_items": [
9876,
8765,
7654
],
"extra_dlcs": { "extra_dlcs": {
"1234": { "1234": {
"dlcs": { "dlcs": {

52
sync.json Normal file
View File

@@ -0,0 +1,52 @@
{
"$schema": "./KoalaBox/res/sync.schema.json",
"variables": {
"project_name": "SmokeAPI",
"store_name": "Steam",
"store_sdk": "Steamworks",
"store_sdk_full": "Steamworks SDK",
"sdk_dll_names": "`steam_api.dll` or `steam_api64.dll`",
"sdk_dll_orig_names": "`steam_api_o.dll` or `steam_api64_o.dll`",
"show_3rd_party_point": true,
"unlocker_dll_names": "`SmokeAPI32.dll` or `SmokeAPI64.dll`",
"config_filename": "SmokeAPI.config.json",
"github_repo_url": "https://github.com/acidicoala/SmokeAPI",
"forum_topic_url": "https://cs.rin.ru/forum/viewtopic.php?p=2597932#p2597932",
"dlc_database": "SteamDB",
"dlc_database_url": "https://steamdb.info/",
"json_schema_path": "./res/SmokeAPI.schema.json"
},
"tasks": [
{
"type": "text",
"template_file": "./KoalaBox/templates/.clang-tidy"
},
{
"type": "text",
"template_file": "./KoalaBox/templates/.gitattributes"
},
{
"type": "text",
"template_file": "./KoalaBox/templates/UNLICENSE.txt"
},
{
"type": "text",
"template_file": "./KoalaBox/templates/build.ps1"
},
{
"type": "text",
"template_file": "./KoalaBox/templates/README.txt",
"destination_dir": "./res/"
},
{
"type": "text",
"template_file": "./README.template.md",
"file_name": "README.md"
},
{
"type": "json",
"schema_file": "./res/SmokeAPI.schema.json",
"destination_file": "./res/{{ config_filename }}"
}
]
}

4
tools/CMakeLists.txt
View File

@@ -17,12 +17,12 @@ target_include_directories(BS_thread_pool INTERFACE ${BS_thread_pool_SOURCE_DIR}
### Steamworks Downloader executable ### Steamworks Downloader executable
add_executable(steamworks_downloader steamworks_downloader.cpp) add_executable(steamworks_downloader src/steamworks_downloader.cpp)
target_link_libraries(steamworks_downloader PRIVATE KoalaBox) target_link_libraries(steamworks_downloader PRIVATE KoalaBox)
### Steamworks Parser executable ### Steamworks Parser executable
add_executable(steamworks_parser steamworks_parser.cpp) add_executable(steamworks_parser src/steamworks_parser.cpp)
target_link_libraries(steamworks_parser PRIVATE target_link_libraries(steamworks_parser PRIVATE
KoalaBox KoalaBox
BS_thread_pool BS_thread_pool

0
tools/steamworks_downloader.cpp → tools/src/steamworks_downloader.cpp
View File

0
tools/steamworks_parser.cpp → tools/src/steamworks_parser.cpp
View File