forward 2.17 release changes (except typing-rewrite revert)

.env.example

@@ -1,26 +1,26 @@
 # Path to MO2 mods directory.
 # Used to set default values for INSTALL_PATH, PAPYRUS_INCLUDE
-XSE_TESV_MODS_PATH=
+XSE_TES5_MODS_PATH=
 # Path to SkyrimSE game directory.
 # Used to set default values for PAPYRUS_PATH, PAPYRUS_GAMESOURCE
-XSE_TESV_GAME_PATH=
+XSE_TES5_GAME_PATH=
 
 # Path to Spriggit.CLI.exe
 SPRIGGIT_PATH=
 # Path to PapyrusCompiler.exe
-# Default: "%XSE_TESV_GAME_PATH%\Papyrus Compiler"
+# Default: "%XSE_TES5_GAME_PATH%\Papyrus Compiler"
 PAPYRUS_PATH=
 
 # Installation Path (if not overridden on cmd line)
-# Deault: "%XSE_TESV_MODS_PATH%\SL-Dev"
+# Deault: "%XSE_TES5_MODS_PATH%\SL-Dev"
 INSTALL_PATH=
 # Enable automatic install after build (0|1)
 # Default: 0
 AUTO_INSTALL=
 
 # Path to directory conatining papyrus dependencies
-# Default: "%XSE_TESV_MODS_PATH%"
+# Default: "%XSE_TES5_MODS_PATH%"
 PAPYRUS_INCLUDE=
 # Path to directory containing game's `Source\Scripts` folder
-# Default: "%XSE_TESV_GAME_PATH%\Data"
+# Default: "%XSE_TES5_GAME_PATH%\Data"
 PAPYRUS_GAMESOURCE=

README.md

@@ -2,17 +2,26 @@
 A high performance and stability patch for SexLab for Skyrim SE.
 
 ## Requirements
+* [python](https://www.python.org/downloads/)
 * [xmake](https://xmake.io/#/)
 	* Add this to your `PATH`
-* [python](https://www.python.org/downloads/)
+* [Spriggit CLI](https://github.com/Mutagen-Modding/Spriggit/)
+	* Requires [Microsoft .NET SDK](https://dotnet.microsoft.com/en-us/download/dotnet/)
 * [Visual Studio Community 2022](https://visualstudio.microsoft.com/)
 	* Desktop development with C++
+	* On VS Community 2026, use this command first:
+		```sh
+		xmake f --cxflags="/Wv:18"
+		```
 * Papyrus Sources:
 	* PapyrusUtil SE: [Nexus][PU-Nexus] | [GitHub][PU-GitHub]
 	* SkyUI SDK 5.1: [GitHub][SUI-GitHub]
 	* Race Menu (Modders Package): [Nexus][RM-Nexus]
 	* MfgFix NG: [Nexus][MFG-Nexus] | [GitHub][MFG-GitHub]
 	* SkyrimLovense: [Nexus][SL-Nexus] | [GitHub][SL-GitHub]
+	* VRIK Player Avatar: [Nexus][VR-Nexus]
+	* UIExtensions: [Nexus][UIX-Nexus]
+		* Extract BSA using [Bathesda Archive Extractor][BAE-Nexus]
 
 ## Building
 
@@ -94,3 +103,6 @@ This project primarily falls under the [Apache License Version 2.0](./LICENSE).
 [MFG-GitHub]: https://github.com/KrisV-777/Mfg-Fix-NG
 [SL-Nexus]: https://www.nexusmods.com/skyrimspecialedition/mods/133698
 [SL-GitHub]: https://github.com/KrisV-777/Skyrim-Lovense
+[UIX-Nexus]: https://www.nexusmods.com/skyrimspecialedition/mods/17561
+[BAE-Nexus]: https://www.nexusmods.com/skyrimspecialedition/mods/974
+[VR-Nexus]: https://www.nexusmods.com/skyrimspecialedition/mods/23416

dist/Interface/Translations/SexLab_CHINESE.txt

@@ -239,6 +239,12 @@ $SSL_bShowInMap	Show Scenes on Map
 $SSL_bShowInMapHighlight	Get a miscellaneous quest marker for each scene playing nearby (except the ones you are participating in yourself).
 $SSL_bSetAnimSpeedByEnjoyment	Enjoyment affected Animation Speed
 $SSL_bSetAnimSpeedByEnjoymentHighlight	Base animation speed changes depending on actor enjoyment (+/-20%).
+$SSL_AdjustStage	Adjust Stage Only
+$SSL_AdjustStageHighlight	Toggles whether all edits to position/stage offsets will apply for currently playing stage only.
+$SSL_fAdjustStepSize	Offset Step Size
+$SSL_fAdjustStepSizeHighlight	Determines the step size for offset adjustments.
+$SSL_bHideHUD	Hide Game HUD
+$SSL_bHideHUDHighlight	Hides the elements from game's HUD, not the scene HUD.
 $SSL_FurnitureNPC	Furniture Use: NPC
 $SSL_FurnitureNPCHighlight	Decide how NPC use Furniture. Specifically, decide if NPC use the furniture scenes over regular ones, when available.
 $SSL_AskNotSub	Ask (Unless Submissive)
@@ -310,15 +316,17 @@ $SSL_WolfVoice01	[SL] Wolf Default
 # ------------------Player Hotkeys--------------------------------------------------
 $SSL_PlayerHotkeys	Player Hotkeys
 
+$SSL_bUseSceneMenu	Use Scene Menu
+$SSL_bUseSceneMenuHighlight	Toggles the use of the native in-scene menu and enjoyment bars.\nDisabling this brings back support for some modernized legacy SL's hotkeys.
+
 # ------ Global SexLab Hotkeys
 $SSL_GlobalHotkeys	Global SexLab Hotkeys
 
-$SSL_iTargetActor	Target Actor For Edit
+$SSL_iTargetActor	Target Actor / Change Partner
 $SSL_iTargetActorHighlight	After pressing this hotkey, place your crosshairs in game over an actor until your receive a notification that the actor is targeted, afterwards the actor will be available for editing purposes in various menu pages.
 $SSL_iToggleFreeCamera	Toggle Free Camera Mode
-$SSL_iToggleFreeCameraHighlight	Toggles the camera mode into a free flying camera state, same as entering TFC into console, this hotkey it enabled at all times regardless of animation.
-$SSL_bHideHUD	Hide Game HUD
-$SSL_bHideHUDHighlight	Hides the elements from game's HUD, not the scene HUD.
+$SSL_iToggleFreeCameraHighlight	Toggles the camera mode into a free flying camera state, same as entering TFC into console, this hotkey is enabled at all times regardless of animation.
+$SSL_iToggleThreadControl	Toggle Thread Control
 
 # ------ Scene Manipulation
 $SSL_SceneManipulation	Scene Manipulation
@@ -328,12 +336,30 @@ $SSL_iKeyLeft	Decrease Speed / Left
 $SSL_iKeyRight	Increase Speed / Right
 $SSL_iKeyAdvance	Advance Scene / Select
 $SSL_iKeyEnd	End Scene / Close Menu / Back
-$SSL_iKeyExtra1	Open Menu / Swap Menu Tab
 $SSL_iKeyExtra2	Open Menu / Swap Menu Tab
 $SSL_iKeyMod	Modifier
+$SSL_iKeyModHighlight	Toggles alternative effect for other hotkeys.\nNext/Prev: ChangePartner, AdvanceStage, OffsetAdjustMode.\nAdjustTarget: EnjRaise, EnjHoldback, ChangePosition, OffsetDirections.\nThe hotkeys changing their mode to "AdjustTarget" with ModifierKey affect Player on their own.
 $SSL_iKeyReset	Inverse Action
+
+$SSL_LegacyHotkeys	Legacy Hotkeys
 $SSL_iChangeAnimation	Change Animation
 $SSL_iMoveScene	Move Scene
+$SSL_iChangePositions	Change Positions
+$SSL_iOffsetAdjustMode	Cycle Offset Adjust Modes
+$SSL_iOffsetAdjustModeHighlight	Hotkey to switch between the 5 offset adjust modes when in scene.\nNone: Offset adjustments are disabled (default).\nPOS-XY: L/R keys adjust position's X, U/D adjust Y.\nPOS-RZ: L/R adjust pos's Rotation, U/D adjust Z.\nSCENE-XY: L/R adjust scene's X, U/D adjust Y (furniture scene only).\nSCENE-RZ: L/R adjust scene's Rotation, U/D adjust Z (furniture only).
+$SSL_iToggleAdjustStage	Toggle Adjust Stage
+$SSL_iRestoreOffsets	Reset Offset Adjustments
+$SSL_iSceneSelectorMenu	Scene Selector Menu
+
+# ------ Scene Selector Menu
+$SSL_SS_OffsetAdjustMode	Select Offset Adjust Mode
+$SSL_SS_ChangeCurrentScene	Change Current Scene
+$SSL_SS_ResetScenesByTagName	Search By Tag/Name
+$SSL_SS_AdjNone	Disable Offset Adjustments
+$SSL_SS_AdjPosXY	Ajust Position XY
+$SSL_SS_AdjPosRZ	Ajust Position RZ
+$SSL_SS_AdjSceneXY	Ajust Furniture XY
+$SSL_SS_AdjSceneRZ	Ajust Furniture RZ
 
 # ------------------- Timers & Stripping -------------------------------------------------
 $SSL_TimersStripping	Timers & Stripping
@@ -434,6 +460,12 @@ $SSL_bSubmissiveTargetHighlight	Filter scenes with target actor in the submissiv
 
 # ------------------ Enjoyment --------------------------------------------------
 $SSL_EnjoymentSettings	Enjoyment Settings
+$SSL_EnjPrimarySettings	Primary Settings
+$SSL_EnjGeneralConfigs	General Configs
+$SSL_EnjGameConfigs	Game Configs
+$SSL_EnjPainConfigs	Pain Configs
+$SSL_EnjGameHotkeys	Game Hotkeys
+$SSL_EnjMiscRateMult	Misc Rate Mult
 
 # ------ Primary Settings
 $SSL_bInternalEnjoymentEnabled	Enable Internal Enjoyment
@@ -482,22 +514,18 @@ $SSL_iEnjGameStaminaCost	Game Stamina Cost
 $SSL_iEnjGameStaminaCostHighlight	The amount of STAMINA to be depleted upon a relevant minigame action.
 $SSL_iEnjGameMagickaCost	Game Magicka Cost
 $SSL_iEnjGameMagickaCostHighlight	The amount of MAGICKA to be depleted upon a relevant minigame action.
+$SSL_iGameEnjAdjAmount	Enjoyment Adjust Amount
+$SSL_iGameEnjAdjAmountHighlight	The amount of enjoyment increased or depleted upon a relevant minigame action.
 $SSL_bGameRequiredOnHighEnj	Require Minigame on High Enj
 $SSL_bGameRequiredOnHighEnjHighlight	Toggles/disables player's enjoyment gain through collision detection when it goes above 80.\nWith this enabled, the player will have to actively rely on the minigame to reach orgasm.
 $SSL_bGameSpamDelayPenalty	Minigame Spam/Delay Penalty
 $SSL_bGameSpamDelayPenaltyHighlight	Toggles enjoyment penalties along with stamina and magicka depletion for the player upon badly timed attempts at raising enjoyment. (IMP: This option only works when combined with the above option.)
 
 # ------ Game Hotkeys
-$SSL_iGameUtilityKey	Game Modifier Key
-$SSL_iGameUtilityKeyHighlight	Modifier key for alternate functions of other enjoyment game hotkeys.
-$SSL_iGamePauseKey	Game Pause Key
-$SSL_iGamePauseKeyHighlight	Hotkey to pause/resume the enjoyment game.\nAlternative functions toggled by combining with utility key.
 $SSL_iGameRaiseEnjKey	RaiseEnj Key
 $SSL_iGameRaiseEnjKeyHighlight	Hotkey to manually raise enjoyment at the cost of stamina. To raise self/player enjoyment, combine with utility key.\nOnce enjoyment reaches 90, this hotkey is used to maintain edge state, whereby timed clicks are required to avoid spam penalties.
 $SSL_iGameHoldbackKey	Holdback Key
 $SSL_iGameHoldbackKeyHighlight	Hotkey to manually holdback/reduce enjoyment at the cost of magicka. To reduce self/player enjoyment, combine with utility key.
-$SSL_iGameSelectNextPos	Next Actor Key
-$SSL_iGameSelectNextPosHighlight	Hotkey to cycle/select the next position or actor.\nDirection of cycle will be reversed when combined with utility key.
 
 # ------------------ Expression Editor --------------------------------------------------
 $SSL_ExpressionEditor	Expression Editor

dist/Interface/Translations/SexLab_CZECH.txt

@@ -239,6 +239,12 @@ $SSL_bShowInMap	Show Scenes on Map
 $SSL_bShowInMapHighlight	Get a miscellaneous quest marker for each scene playing nearby (except the ones you are participating in yourself).
 $SSL_bSetAnimSpeedByEnjoyment	Enjoyment affected Animation Speed
 $SSL_bSetAnimSpeedByEnjoymentHighlight	Base animation speed changes depending on actor enjoyment (+/-20%).
+$SSL_AdjustStage	Adjust Stage Only
+$SSL_AdjustStageHighlight	Toggles whether all edits to position/stage offsets will apply for currently playing stage only.
+$SSL_fAdjustStepSize	Offset Step Size
+$SSL_fAdjustStepSizeHighlight	Determines the step size for offset adjustments.
+$SSL_bHideHUD	Hide Game HUD
+$SSL_bHideHUDHighlight	Hides the elements from game's HUD, not the scene HUD.
 $SSL_FurnitureNPC	Furniture Use: NPC
 $SSL_FurnitureNPCHighlight	Decide how NPC use Furniture. Specifically, decide if NPC use the furniture scenes over regular ones, when available.
 $SSL_AskNotSub	Ask (Unless Submissive)
@@ -310,15 +316,17 @@ $SSL_WolfVoice01	[SL] Wolf Default
 # ------------------Player Hotkeys--------------------------------------------------
 $SSL_PlayerHotkeys	Player Hotkeys
 
+$SSL_bUseSceneMenu	Use Scene Menu
+$SSL_bUseSceneMenuHighlight	Toggles the use of the native in-scene menu and enjoyment bars.\nDisabling this brings back support for some modernized legacy SL's hotkeys.
+
 # ------ Global SexLab Hotkeys
 $SSL_GlobalHotkeys	Global SexLab Hotkeys
 
-$SSL_iTargetActor	Target Actor For Edit
+$SSL_iTargetActor	Target Actor / Change Partner
 $SSL_iTargetActorHighlight	After pressing this hotkey, place your crosshairs in game over an actor until your receive a notification that the actor is targeted, afterwards the actor will be available for editing purposes in various menu pages.
 $SSL_iToggleFreeCamera	Toggle Free Camera Mode
-$SSL_iToggleFreeCameraHighlight	Toggles the camera mode into a free flying camera state, same as entering TFC into console, this hotkey it enabled at all times regardless of animation.
-$SSL_bHideHUD	Hide Game HUD
-$SSL_bHideHUDHighlight	Hides the elements from game's HUD, not the scene HUD.
+$SSL_iToggleFreeCameraHighlight	Toggles the camera mode into a free flying camera state, same as entering TFC into console, this hotkey is enabled at all times regardless of animation.
+$SSL_iToggleThreadControl	Toggle Thread Control
 
 # ------ Scene Manipulation
 $SSL_SceneManipulation	Scene Manipulation
@@ -328,12 +336,30 @@ $SSL_iKeyLeft	Decrease Speed / Left
 $SSL_iKeyRight	Increase Speed / Right
 $SSL_iKeyAdvance	Advance Scene / Select
 $SSL_iKeyEnd	End Scene / Close Menu / Back
-$SSL_iKeyExtra1	Open Menu / Swap Menu Tab
 $SSL_iKeyExtra2	Open Menu / Swap Menu Tab
 $SSL_iKeyMod	Modifier
+$SSL_iKeyModHighlight	Toggles alternative effect for other hotkeys.\nNext/Prev: ChangePartner, AdvanceStage, OffsetAdjustMode.\nAdjustTarget: EnjRaise, EnjHoldback, ChangePosition, OffsetDirections.\nThe hotkeys changing their mode to "AdjustTarget" with ModifierKey affect Player on their own.
 $SSL_iKeyReset	Inverse Action
+
+$SSL_LegacyHotkeys	Legacy Hotkeys
 $SSL_iChangeAnimation	Change Animation
 $SSL_iMoveScene	Move Scene
+$SSL_iChangePositions	Change Positions
+$SSL_iOffsetAdjustMode	Cycle Offset Adjust Modes
+$SSL_iOffsetAdjustModeHighlight	Hotkey to switch between the 5 offset adjust modes when in scene.\nNone: Offset adjustments are disabled (default).\nPOS-XY: L/R keys adjust position's X, U/D adjust Y.\nPOS-RZ: L/R adjust pos's Rotation, U/D adjust Z.\nSCENE-XY: L/R adjust scene's X, U/D adjust Y (furniture scene only).\nSCENE-RZ: L/R adjust scene's Rotation, U/D adjust Z (furniture only).
+$SSL_iToggleAdjustStage	Toggle Adjust Stage
+$SSL_iRestoreOffsets	Reset Offset Adjustments
+$SSL_iSceneSelectorMenu	Scene Selector Menu
+
+# ------ Scene Selector Menu
+$SSL_SS_OffsetAdjustMode	Select Offset Adjust Mode
+$SSL_SS_ChangeCurrentScene	Change Current Scene
+$SSL_SS_ResetScenesByTagName	Search By Tag/Name
+$SSL_SS_AdjNone	Disable Offset Adjustments
+$SSL_SS_AdjPosXY	Ajust Position XY
+$SSL_SS_AdjPosRZ	Ajust Position RZ
+$SSL_SS_AdjSceneXY	Ajust Furniture XY
+$SSL_SS_AdjSceneRZ	Ajust Furniture RZ
 
 # ------------------- Timers & Stripping -------------------------------------------------
 $SSL_TimersStripping	Timers & Stripping
@@ -434,6 +460,12 @@ $SSL_bSubmissiveTargetHighlight	Filter scenes with target actor in the submissiv
 
 # ------------------ Enjoyment --------------------------------------------------
 $SSL_EnjoymentSettings	Enjoyment Settings
+$SSL_EnjPrimarySettings	Primary Settings
+$SSL_EnjGeneralConfigs	General Configs
+$SSL_EnjGameConfigs	Game Configs
+$SSL_EnjPainConfigs	Pain Configs
+$SSL_EnjGameHotkeys	Game Hotkeys
+$SSL_EnjMiscRateMult	Misc Rate Mult
 
 # ------ Primary Settings
 $SSL_bInternalEnjoymentEnabled	Enable Internal Enjoyment
@@ -482,22 +514,18 @@ $SSL_iEnjGameStaminaCost	Game Stamina Cost
 $SSL_iEnjGameStaminaCostHighlight	The amount of STAMINA to be depleted upon a relevant minigame action.
 $SSL_iEnjGameMagickaCost	Game Magicka Cost
 $SSL_iEnjGameMagickaCostHighlight	The amount of MAGICKA to be depleted upon a relevant minigame action.
+$SSL_iGameEnjAdjAmount	Enjoyment Adjust Amount
+$SSL_iGameEnjAdjAmountHighlight	The amount of enjoyment increased or depleted upon a relevant minigame action.
 $SSL_bGameRequiredOnHighEnj	Require Minigame on High Enj
 $SSL_bGameRequiredOnHighEnjHighlight	Toggles/disables player's enjoyment gain through collision detection when it goes above 80.\nWith this enabled, the player will have to actively rely on the minigame to reach orgasm.
 $SSL_bGameSpamDelayPenalty	Minigame Spam/Delay Penalty
 $SSL_bGameSpamDelayPenaltyHighlight	Toggles enjoyment penalties along with stamina and magicka depletion for the player upon badly timed attempts at raising enjoyment. (IMP: This option only works when combined with the above option.)
 
 # ------ Game Hotkeys
-$SSL_iGameUtilityKey	Game Modifier Key
-$SSL_iGameUtilityKeyHighlight	Modifier key for alternate functions of other enjoyment game hotkeys.
-$SSL_iGamePauseKey	Game Pause Key
-$SSL_iGamePauseKeyHighlight	Hotkey to pause/resume the enjoyment game.\nAlternative functions toggled by combining with utility key.
 $SSL_iGameRaiseEnjKey	RaiseEnj Key
 $SSL_iGameRaiseEnjKeyHighlight	Hotkey to manually raise enjoyment at the cost of stamina. To raise self/player enjoyment, combine with utility key.\nOnce enjoyment reaches 90, this hotkey is used to maintain edge state, whereby timed clicks are required to avoid spam penalties.
 $SSL_iGameHoldbackKey	Holdback Key
 $SSL_iGameHoldbackKeyHighlight	Hotkey to manually holdback/reduce enjoyment at the cost of magicka. To reduce self/player enjoyment, combine with utility key.
-$SSL_iGameSelectNextPos	Next Actor Key
-$SSL_iGameSelectNextPosHighlight	Hotkey to cycle/select the next position or actor.\nDirection of cycle will be reversed when combined with utility key.
 
 # ------------------ Expression Editor --------------------------------------------------
 $SSL_ExpressionEditor	Expression Editor