Skip to content

Commit e430350

Browse files
committed
Added instructions on adding support for new Steamworks SDK
1 parent 0341c97 commit e430350

File tree

3 files changed

+27
-5
lines changed

3 files changed

+27
-5
lines changed

.idea/SmokeAPI.iml

Lines changed: 1 addition & 5 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

README.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -346,6 +346,11 @@ They will be added to the list of missing DLC IDs to facilitate config-less oper
346346

347347
[extra DLCs]: https://github.com/acidicoala/public-entitlements/blob/main/steam/v2/dlc.json
348348

349+
### 🔢 Supported Steamworks SDK versions
350+
351+
SmokeAPI aims to support all Steamworks SDK version.
352+
At the time of writing, the latest supported version is **1.63**.
353+
349354
## 🔧 Troubleshooting
350355

351356
### 🔐 DLCs are not unlocked
@@ -409,6 +414,14 @@ For example:
409414

410415
[CMake]: https://cmake.org/
411416

417+
### 🆕 Adding support for new Steamworks SDK
418+
419+
- Run `steamworks_downloader [prompt]` providing directory which contains Steamworks SDK zip files.
420+
- Run `steamworks_parser`
421+
- Run `linux_exports_generator [32]`
422+
- Run `linux_exports_generator [64]`
423+
424+
412425
## 📚 Acknowledgments
413426

414427
This project makes use of the following open source projects:

README.template.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -44,10 +44,23 @@ They will be added to the list of missing DLC IDs to facilitate config-less oper
4444

4545
[extra DLCs]: https://github.com/acidicoala/public-entitlements/blob/main/steam/v2/dlc.json
4646

47+
### 🔢 Supported Steamworks SDK versions
48+
49+
{{ project_name }} aims to support all Steamworks SDK version.
50+
At the time of writing, the latest supported version is **1.63**.
51+
4752
{% include "KoalaBox/templates/markdown/troubleshooting.md" %}
4853

4954
{% include "KoalaBox/templates/markdown/building.md" %}
5055

56+
### 🆕 Adding support for new Steamworks SDK
57+
58+
- Run `steamworks_downloader [prompt]` providing directory which contains Steamworks SDK zip files.
59+
- Run `steamworks_parser`
60+
- Run `linux_exports_generator [32]`
61+
- Run `linux_exports_generator [64]`
62+
63+
5164
{% include "KoalaBox/templates/markdown/acknowledgements.md" %}{% block extra_oss_libs %}- [bshoshany/thread-pool](https://github.com/bshoshany/thread-pool)
5265
- [batterycenter/embed](https://github.com/batterycenter/embed)
5366

0 commit comments

Comments
 (0)