Release v4.0.0-rc01

Full Changelog: v3.0.1...v4.0.0-rc01

Release v3.0.1

📑 Changelog

• ➕ Added legacy function exports:
  • EOS_AccountId_FromString
  • EOS_AccountId_IsValid
  • EOS_AccountId_ToString
• 🐞 Miscellaneous bugfixes for the hook mode
• 🗑️ Release zips no longer include config file, because most people don't need it. If you truly need it, you can still get from this repository and install as usual.

Release v3.0.0

📑 Changelog

🪝 Hook mode! Now ScreamAPI can be injected into the game process and it will patch EOS SDK functions in-memory, thus avoiding any file modifications on disk. This makes installation persist game updates, and bypasses DLL integrity checks in some games. You can find example setup here. The classical mode is now called Proxy mode, and is still working as usual. Details in README. (If you can't see the hook emoji, then it's time to update your emoji font).

🐞 Bugfixes

• Some games (such as Hunter: CotW) had issues with logging enabled. This was because ScreamAPI was intercepting EOS Logging calls. Now EOS Logging can be configured separately from the main logging, and it is disabled by default.
• Some games (such as Citites: Skylines) were loading 2 EOS SDK DLLs, which was confusing ScreamAPI, causing it to look for original DLL in the wrong directory. Now, ScreamAPI will look for original DLL in the same directory where ScreamAPI DLL itself is located.

🏗 Technical changes

• The project has undergone a minor overhaul. All of the utility functions have been moved to KoalaBox to facilitate reusability across multiple C++ projects. Reusable parts of Actions workflow, Powershell script, and CMake configuration have been moved to KoalaBox as well.
• The project is now compiled using Visual Studio 2022 toolset. The build is executed on windows-2022 GitHub runner as well.
• Releases no longer include RelWithDebInfo builds. If you need them, you can always clone the project and build debug variant locally.

Release v2.1.0

📑 Changelog

✅ Added new exports from EOS SDK v1.14

🔨 Fixed a memory leak when obtaining DLL path

♻ Changed EOS_Ecom_QueryOwnership and EOS_Ecom_QueryEntitlements callback strategy to the one used in the version 1

✨ Most importantly, added missing emoji icons in some log lines

---

Full Changelog: v2.0.0...v2.1.0

---

Update 19/12/2021
Changed block_metrics config option to false, which was originally meant to be the default option, but was mistakenly set to true. When enabled, this option was reportedly causing issues in at least one game. Credit to Szszymon14 for the report.

Release v2.0.0

📑 Changelog

💥 Breaking change: Config file is now using JSON format.

✅ New feature: Entitlement injection! Now you can choose which entitlements you wish to inject by specifying entitlement IDs in the config file. For technical details, consult the Configuration section in the README document. It is worth noting however, that you likely won't need to bother with this manual injection, thanks to another feature, described below.

✅ New feature: Entitlement auto-injection! Now ScreamAPI can automatically unlock DLCs in games that query DLC ownership via Entitlements interface without specifying entitlement IDs.

🗑 Removed feature: Achievement Manager and Overlay have been removed.

---

💭 As this is a major re-work of ScreamAPI, the above-mentioned list is merely a summary of all the changes that I have described in more detail in the announcement discussion.

Release v1.13.0 - Update 1

📃 Changelog

• Fixed a bug that was causing ScreamAPI to invoke overlay shutdown routine when overlay was disabled, which resulted in shutdown crash in some games.

Release v1.13.0

📃 Changelog

• Added latest EOS SDK exports from version 1.13.0
• Fixed a callback function's calling convention
• Changed the versioning schema to match exactly that of the EOS SDK

Update 2 for EOSSDK 1.10.2

Changelog

Bug fixes

• Fixed the recently renamed ForceSuccess config option bug that resulted in startup crash

Update 1 for EOSSDK 1.10.2

Changelog

Additions

• Added latest EOS SDK exports from version 1.10.2

Bug fixes

• Calls to EOS_EResult_ToString with older SDK versions should not lead to crashes anymore

Changes

• OfflineSupport config option has been renamed to ForceSuccess to better reflect its purpose
• Config file now suggests https://scream-db.web.app/ instead of https://epicdata.info/ for getting DLC information

Known issues

• ForceSuccess config option results in startup crash. Already fixed in the next version.

Update 1 for EOSSDK 1.10.1

Changelog

Additions

• Added latest EOS SDK exports from version 1.10.1

Bug fixes

• Now ScreamAPI should not crash the game if the config file is missing.

Known issues

• Enabling LoadIcons in Railway Empire crashes the game.
• Overlay works only with DirectX11.
• Overlay may sometimes stop working or even crash in some games when resizing the game window.