release(skyrim-platform): version 2.6 (#1074)

Co-authored-by: Christoph Thiel <[email protected]>
Co-authored-by: Leonid Pospelov <[email protected]>

docs/release/sp-2.6.md

@@ -0,0 +1,88 @@
+# SP 2.6.0 Release Notes
+
+
+This document includes changes made since SP 2.5.0
+
+**Hey! This is a very important update that adds AE/1.6 support, improves FPS, and generally fixes lots of crashes and issues. It's quite reasonable to update instead of keep using 2.5 or even older versions.**
+
+Remember that unfortunately updating SP break save games on *some* modlists. There are still many things to be implemented or fixed. See [issues](https://github.com/skyrim-multiplayer/skymp/issues?q=is%3Aopen+is%3Aissue+label%3Aarea%3Askyrim-platform).
+
+SP supports both Steam version of Skyrim SE (1.6+) and legacy 1.5.97.
+
+If you're enjoying Skyrim Platform, please star this repo. It helps ⭐
+
+## `error` in HTTP client's response
+
+Added `error` field to `HttpResponse`. This allows checking for more detailed info
+why your HTTP request failed. Currently, it can be
+[one of these](https://github.com/yhirose/cpp-httplib/blob/b80aa7fee31a8712b1d3cae05c1d9e7f5c436e3d/httplib.h#L771-L785):
+* Empty string, if successful
+* `Unknown`
+* `Connection`
+* `BindIPAddress`
+* `Read`
+* `Write`
+* `ExceedRedirectCount`
+* `Canceled`
+* `SSLConnection`
+* `SSLLoadingCerts`
+* `SSLServerVerification`
+* `UnsupportedMultipartBoundaryChars`
+* `Compression`
+
+## Add more events
+
+* `buttonEvent`
+* `mouseMove`
+* `thumbstickEvent`
+* `kinectEvent`
+* `deviceConnect`
+* `actorKill`
+* `criticalHit`
+* `disarmedEvent`
+* `dragonSoulsGained`
+* `itemHarvested`
+* `levelIncrease`
+* `locationDiscovery`
+* `shoutAttack`
+* `skillIncrease`
+* `soulsTrapped`
+* `spellsLearned`
+
+## FileInfo API
+
+Now you can get info about files directly inside of Skyrim's Data directory.
+
+```ts
+sp.printConsole(JSON.stringify(sp.getFileInfo('Skyrim.esm')));
+// {"filename": "Skyrim.esm", "size": ..., "crc32": ...}
+```
+
+
+## Other changes
+
+- Fixed a few security issues related to local file paths checking.
+
+
+- Skyrim Platform now have settings file located at `Data\SKSE\Plugins\SkyrimPlatform.ini`.
+
+
+- Fixed displaying of non-ASCII text: fixed working with UTF-8 (from JS) text and recompiled font to include Cyrillic symbols. In case you wish to update the font to use something else, please see [SP Texts API docs](../skyrim_platform/texts.md#compiling-font).
+
+
+- The project now complies with C++20 and compiles with VS 2022 without errors.
+
+
+- CommonlibSSE updated to latest version.
+
+
+- Runtime event sink handling introduced. Except for some custom events that fire from within the code, events now will not be processed if there are no plugins that are subscribed to them. In theory this should provide more execution performance since there are less calls that need to be processed.
+
+
+- Logging introduced. Platform now uses skse runtime logging capabilities to provide users more feedback about its execution succession. Log file is located at `User\Documents\My Games\Skyrim Special Edition\SKSE.`
+
+
+- All raw offsets for hooks and game classes were replaced with Address Library IDs to support future game version changes.
+
+
+- SKSE64 is no longer a build dependency (Still required to run the plugin).

skymp5-client/src/version.ts

@@ -1,6 +1,6 @@
 import { Utility, Debug, getPlatformVersion, on, Game, Ui } from 'skyrimPlatform';
 
-const requiredVersion = '2.5.0';
+const requiredVersion = '2.6.0';
 
 const realVersion = typeof getPlatformVersion === 'function' ? getPlatformVersion() : 'unknown';
 

skyrim-platform/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@skymp/skyrim-platform",
-  "version": "2.5.0",
+  "version": "2.6.0",
   "description": "A modding tool for Skyrim allowing writing scripts with JavaScript/TypeScript",
   "license": "GPL-3.0"
 }

skyrim-platform/src/platform_se/CMakeLists.txt

@@ -1,4 +1,4 @@
-project(platform_se VERSION 2.5.0 LANGUAGES CXX)
+project(platform_se VERSION 2.6.0 LANGUAGES CXX)
 configure_file(${CMAKE_CURRENT_SOURCE_DIR}/cmake/Version.h.in ${CMAKE_CURRENT_BINARY_DIR}/include/Version.h @ONLY)
 configure_file(${CMAKE_CURRENT_SOURCE_DIR}/cmake/version.rc.in ${CMAKE_CURRENT_BINARY_DIR}/version.rc @ONLY)
 

skyrim-platform/src/platform_se/skyrim_platform/DevApi.cpp

@@ -97,7 +97,7 @@ JsValue DevApi::WritePlugin(const JsFunctionArguments& args)
 
 JsValue DevApi::GetPlatformVersion(const JsFunctionArguments& args)
 {
-  return "2.5.0";
+  return "2.6.0";
 }
 
 JsValue DevApi::GetJsMemoryUsage(const JsFunctionArguments& args)