diff --git a/KoalaBox b/KoalaBox index a2a7051..43bd142 160000 --- a/KoalaBox +++ b/KoalaBox @@ -1 +1 @@ -Subproject commit a2a7051ceaddde4df7c0aea6b2265620d062cf77 +Subproject commit 43bd1420c536e1fa2afbeb4ccd4ac5fa5c4716b3 diff --git a/README.md b/README.md index cac0ab6..463a477 100644 --- a/README.md +++ b/README.md @@ -136,7 +136,13 @@ 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) +## 🛠️ Installation instructions (🐧 Linux) + +> [!NOTE] +> Linux support in SmokeAPI is highly experimental 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 @@ -200,7 +206,7 @@ For example: Naturally, the exact options might change depending on how files are located on your filesystem or depending on other environment variables you might have configured. If you have other environment variables, and you don't know how to correctly combine them, -then please make heavy use of search engines and LLMs for guidance examples instead of the official forum topic. +then please make heavy use of search engines and LLMs for guidance and examples instead of the official forum topic. ### 🔀 Proxy mode (🐧 Linux) @@ -208,6 +214,11 @@ Same as on Windows: 1. Rename the original `libsteam_api.so` to `libsteam_api.so` 2. Extract and paste the `libsmoke_api32.so` or `libsmoke_api64.so` to the same directory, renaming it to `libsteam_api.so`. +### 🐞 Known issues + +- Steam overlay is not working in hook mode + + ## ⚙ Configuration SmokeAPI does not require any manual configuration. @@ -402,7 +413,7 @@ This project makes use of the following open source projects: - [bshoshany/thread-pool](https://github.com/bshoshany/thread-pool) - [batterycenter/embed](https://github.com/batterycenter/embed) -u +r ## 📄 License