Refactor and enhance bHapticsManager architecture - (v1.1.0) #8

nalathethird · 2025-11-23T02:18:57Z

Refactored BHapticsConnection into a singleton for better state management and added event-based device handling. Improved thread safety and logging in initialization and shutdown processes.

Replaced static DeviceEventHandler with an instance-based implementation supporting IDisposable. Enhanced DeviceRegistration with thread-safe methods, a ClearAllRegistrations function, and improved logging.

Upgraded ModernBHapticsWorkerThread with dynamic device handling, better thread management, and detailed diagnostics. Added intensity boosting for weak signals in LegacyCompatibilityLayer and reduced submission intervals for responsiveness.

Modularized patch application in HapticPlayerPatches, HapticMethodPatches, and TorsoMapperFix. Improved error handling and compatibility with the modern bHaptics SDK.

Streamlined mod initialization in bHapticsManager, added lazy haptics initialization, and ensured proper shutdown handling. Updated bHapticsManager.csproj to support additional Resonite paths and removed unused references.

General improvements include better maintainability, enhanced modularity, and updated documentation.

Refactored `BHapticsConnection` into a singleton for better state management and added event-based device handling. Improved thread safety and logging in initialization and shutdown processes. Replaced static `DeviceEventHandler` with an instance-based implementation supporting `IDisposable`. Enhanced `DeviceRegistration` with thread-safe methods, a `ClearAllRegistrations` function, and improved logging. Upgraded `ModernBHapticsWorkerThread` with dynamic device handling, better thread management, and detailed diagnostics. Added intensity boosting for weak signals in `LegacyCompatibilityLayer` and reduced submission intervals for responsiveness. Modularized patch application in `HapticPlayerPatches`, `HapticMethodPatches`, and `TorsoMapperFix`. Improved error handling and compatibility with the modern bHaptics SDK. Streamlined mod initialization in `bHapticsManager`, added lazy haptics initialization, and ensured proper shutdown handling. Updated `bHapticsManager.csproj` to support additional Resonite paths and removed unused references. General improvements include better maintainability, enhanced modularity, and updated documentation.

nalathethird · 2025-11-23T02:20:00Z

this is a MASSIVE overhaul and fixes SEVERAL oversights i did not see before, SHOULD be entirely usable now!

nalathethird · 2025-11-23T02:20:20Z

doo it to it CoP!

Copilot

Pull request overview

This PR refactors the bHapticsManager architecture to version 1.1.0, implementing significant improvements to connection management, device handling, and thread safety. The changes transform the codebase from a static-based approach to a more modern singleton pattern with proper lifecycle management and event-based device hot-plugging support.

Key Changes:

Converted BHapticsConnection to a singleton pattern with instance-based event handling for device connection/disconnection
Modularized Harmony patches into separate ApplyPatches() methods for better organization and maintainability
Enhanced ModernBHapticsWorkerThread with dynamic device state tracking, improved shutdown handling, and intensity boosting for weak haptic signals

Reviewed changes

Copilot reviewed 14 out of 14 changed files in this pull request and generated 23 comments.

Show a summary per file

File	Description
bHapticsManager.csproj	Updated project file to support multiple Resonite installation paths and use `$(ResonitePath)` variable consistently for all references
bHapticsManager.cs	Refactored initialization flow with proper world synchronization, lazy haptics initialization, and structured shutdown handling
TorsoMapperFix.cs	Added `ApplyPatches()` method for modular patch application and cleaned up inline comments
RemoteHapticSource.cs	Added `DummyWorldElement` helper class to provide proper parent reference for world elements
Properties/AssemblyInfo.cs	Updated assembly description and copyright format
PositionMapper.cs	Added nullable annotation to return type of `ConvertDotPointsToMotorArray()`
ModernBHapticsWorkerThread.cs	Implemented `IDisposable`, added device state tracking, improved timing with stopwatch-based scheduling, and enhanced shutdown coordination
LegacyCompatibilityLayer.cs	Added intensity boosting for weak signals, increased buffer duration, and reduced submission intervals for better responsiveness
HapticPlayerPatches.cs	Modularized patch application and simplified patch methods by removing verbose comments
HapticMethodPatches.cs	Added `ApplyPatches()` method and changed logging from `Msg` to `Debug` for diagnostic output
DiagnosticPatches.cs	Reorganized into nested class structure and updated logging to use `Debug` instead of `Msg`
DeviceRegistration.cs	Added `ClearAllRegistrations()`, `RegisterDevice()`, and `UnregisterDevice()` helper methods with thread-safe access
DeviceEventHandler.cs	Converted from static to instance-based implementation with `IDisposable` support and simplified event handling
BHapticsConnection.cs	Converted to singleton pattern, added device connection events, and improved shutdown process with detailed error handling

Comments suppressed due to low confidence (1)

bHapticsManager/ModernBHapticsWorkerThread.cs:125

These 'if' statements can be combined.

			if (_workerThread != null && _workerThread.IsAlive) {
				if (!_workerThread.Join(TimeSpan.FromSeconds(2))) {
					bHapticsManager.Warn("Worker thread did not stop gracefully, interrupting...");
					try {
						_workerThread.Interrupt();
						if (!_workerThread.Join(TimeSpan.FromSeconds(1))) {
							bHapticsManager.Warn("Worker thread did not respond to interrupt");
						}
					}
					catch (Exception ex) {
						bHapticsManager.Error($"Error interrupting worker thread: {ex}");
					}
				}
			}

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

bHapticsManager/HapticPlayerPatches.cs

bHapticsManager/TorsoMapperFix.cs

bHapticsManager/HapticMethodPatches.cs

bHapticsManager/RemoteHapticSource.cs

bHapticsManager/BHapticsConnection.cs

bHapticsManager/bHapticsManager.cs

bHapticsManager/DeviceRegistration.cs

bHapticsManager/DiagnosticPatches.cs

bHapticsManager/ModernBHapticsWorkerThread.cs

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

nalathethird

should be adjusted due to comments on your suggestions please.

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Copilot

Pull request overview

Copilot reviewed 14 out of 14 changed files in this pull request and generated 16 comments.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

bHapticsManager/bHapticsManager.cs

bHapticsManager/ModernBHapticsWorkerThread.cs

bHapticsManager/DeviceEventHandler.cs

bHapticsManager/ModernBHapticsWorkerThread.cs

bHapticsManager/bHapticsManager.cs

bHapticsManager/ModernBHapticsWorkerThread.cs

bHapticsManager/bHapticsManager.cs

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Copilot · 2025-11-23T02:44:58Z

@nalathethird I've opened a new pull request, #9, to work on those changes. Once the pull request is ready, I'll request review from you.

Co-authored-by: nalathethird <36301692+nalathethird@users.noreply.github.com>

…timing Co-authored-by: nalathethird <36301692+nalathethird@users.noreply.github.com>

Co-authored-by: nalathethird <36301692+nalathethird@users.noreply.github.com>

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Fix race condition and static field access in WorldFocused event handler

Remove unused _devicePoints dictionary and _lock object from DeviceRegistration

nalathethird · 2025-11-23T03:30:04Z

legit just making sure i dident miss anything. im not THAT confident on this update cause it was CONSIDERABLY rushed to my standards... so thats why im having this clanker check my work. 💀

Copilot

Pull request overview

Copilot reviewed 14 out of 14 changed files in this pull request and generated 16 comments.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot · 2025-11-23T03:34:17Z

bHapticsManager/ModernBHapticsWorkerThread.cs

 		public ModernBHapticsWorkerThread(InputInterface inputInterface) {
 			_inputInterface = inputInterface;
-			_cancellationToken = new CancellationTokenSource();
-			_hapticPointsByDevice = new Dictionary<LegacyBHaptics.PositionType, List<HapticPointData>>();
-			_deviceKeys = new Dictionary<LegacyBHaptics.PositionType, string>();
-
+
+			_workerThread = new Thread(WorkerThreadLoop) {
+				Priority = ThreadPriority.Highest,
+				IsBackground = true,
+				Name = "ModernBHapticsWorker"
+			};
+		}


There are two constructors (lines 45 and 55) with different initialization logic. The first constructor creates a thread but never starts it (no _running = true or Start() call), while the second does. The first constructor appears to be unused code since Start() would need to be called separately but there's no evidence of that pattern in the codebase. Consider removing the unused constructor or documenting why both patterns are needed.

bHapticsManager/TorsoMapperFix.cs

bHapticsManager/bHapticsManager.cs

bHapticsManager/LegacyCompatibilityLayer.cs

bHapticsManager/ModernBHapticsWorkerThread.cs

bHapticsManager/BHapticsConnection.cs

bHapticsManager/bHapticsManager.cs

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Copilot · 2025-11-23T03:37:04Z

@nalathethird I've opened a new pull request, #14, to work on those changes. Once the pull request is ready, I'll request review from you.

Copilot · 2025-11-23T03:37:10Z

@nalathethird I've opened a new pull request, #15, to work on those changes. Once the pull request is ready, I'll request review from you.

Copilot · 2025-11-23T03:37:28Z

@nalathethird I've opened a new pull request, #16, to work on those changes. Once the pull request is ready, I'll request review from you.

Copilot · 2025-11-23T03:37:45Z

@nalathethird I've opened a new pull request, #17, to work on those changes. Once the pull request is ready, I'll request review from you.

Copilot · 2025-11-23T03:37:58Z

@nalathethird I've opened a new pull request, #18, to work on those changes. Once the pull request is ready, I'll request review from you.

Copilot · 2025-11-23T03:38:04Z

@nalathethird I've opened a new pull request, #19, to work on those changes. Once the pull request is ready, I'll request review from you.

Copilot · 2025-11-23T03:38:14Z

@nalathethird I've opened a new pull request, #20, to work on those changes. Once the pull request is ready, I'll request review from you.

nalathethird · 2025-11-23T03:51:14Z

that bitch is REMOVED. its causing loops. ill fix these myself thanks. lmao

nalathethird self-assigned this Nov 23, 2025

nalathethird added the enhancement New feature or request label Nov 23, 2025

nalathethird linked an issue Nov 23, 2025 that may be closed by this pull request

Bug: haptics Thread not started (Creates v1.1.0 - included new fixes for other stuff too) #6

Open

nalathethird added this to What Im Working on... (Resonite Mods/Libs) Nov 23, 2025

github-project-automation bot moved this to Backlog in What Im Working on... (Resonite Mods/Libs) Nov 23, 2025

nalathethird moved this from Backlog to In review in What Im Working on... (Resonite Mods/Libs) Nov 23, 2025

nalathethird marked this pull request as ready for review November 23, 2025 02:20

Copilot AI review requested due to automatic review settings November 23, 2025 02:20

Copilot started reviewing on behalf of nalathethird November 23, 2025 02:20 View session

Copilot finished reviewing on behalf of nalathethird November 23, 2025 02:22

Copilot AI reviewed Nov 23, 2025

View reviewed changes

nalathethird and others added 6 commits November 22, 2025 20:26

Update bHapticsManager/HapticPlayerPatches.cs

87892cd

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Update bHapticsManager/DiagnosticPatches.cs

34ab9eb

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Update bHapticsManager/DiagnosticPatches.cs

de8ff82

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Update bHapticsManager/RemoteHapticSource.cs

b4c946d

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Update bHapticsManager/bHapticsManager.cs

e82763c

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Update bHapticsManager/ModernBHapticsWorkerThread.cs

a0aef2d

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

nalathethird requested a review from Copilot November 23, 2025 02:37

Copilot started reviewing on behalf of nalathethird November 23, 2025 02:37 View session

nalathethird commented Nov 23, 2025

View reviewed changes

Copilot finished reviewing on behalf of nalathethird November 23, 2025 02:39

nalathethird and others added 2 commits November 22, 2025 20:41

Update bHapticsManager/TorsoMapperFix.cs

8b08ab3

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Update bHapticsManager/HapticMethodPatches.cs

babddda

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Copilot AI reviewed Nov 23, 2025

View reviewed changes

Copilot AI and others added 2 commits November 23, 2025 02:44

Initial plan

098752e

Update bHapticsManager/bHapticsManager.cs

be18ff7

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Copilot AI and others added 8 commits November 23, 2025 03:14

Fix race condition in WorldFocused event handler

458d750

Co-authored-by: nalathethird <36301692+nalathethird@users.noreply.github.com>

Address user feedback: remove unused _devicePoints and adjust haptic …

b4e066c

…timing Co-authored-by: nalathethird <36301692+nalathethird@users.noreply.github.com>

Improve comments based on code review feedback

788d3f5

Co-authored-by: nalathethird <36301692+nalathethird@users.noreply.github.com>

Update bHapticsManager/bHapticsManager.cs

9f84bca

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Update bHapticsManager/bHapticsManager.cs

4ca2353

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Update bHapticsManager/LegacyCompatibilityLayer.cs

1b0fdf7

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Merge pull request #13 from nalathethird/copilot/sub-pr-8-another-one

17939ec

Fix race condition and static field access in WorldFocused event handler

Merge pull request #12 from nalathethird/copilot/sub-pr-8-again

a1b03c2

Remove unused _devicePoints dictionary and _lock object from DeviceRegistration

nalathethird requested a review from Copilot November 23, 2025 03:28

Copilot started reviewing on behalf of nalathethird November 23, 2025 03:28 View session

Copilot finished reviewing on behalf of nalathethird November 23, 2025 03:31

Copilot AI reviewed Nov 23, 2025

View reviewed changes

nalathethird and others added 2 commits November 22, 2025 21:35

Update bHapticsManager/bHapticsManager.cs

89b2654

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Update bHapticsManager/LegacyCompatibilityLayer.cs

86964da

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Copilot AI mentioned this pull request Nov 23, 2025

Fix Harmony instance conflict in TorsoMapperFix #14

Closed

Copilot AI mentioned this pull request Nov 23, 2025

Separate Instance null check from no-devices check in InitializeHaptics #15

Closed

Copilot AI mentioned this pull request Nov 23, 2025

Fix Interlocked.CompareExchange pattern to use explicit comparison #16

Closed

Copilot AI mentioned this pull request Nov 23, 2025

Document haptic timing constants with rationale and performance tradeoffs #17

Closed

Copilot AI mentioned this pull request Nov 23, 2025

Fix race condition in BHapticsConnection.Initialize() #18

Closed

Copilot AI mentioned this pull request Nov 23, 2025

Extract static initialization logic from instance method OnEngineInit #19

Closed

Copilot AI mentioned this pull request Nov 23, 2025

Combine nested conditionals in WorldFocusedHandler #20

Closed

Refactor and enhance bHapticsManager architecture - (v1.1.0) #8

Are you sure you want to change the base?

Refactor and enhance bHapticsManager architecture - (v1.1.0) #8

Uh oh!

Conversation

nalathethird commented Nov 23, 2025

Uh oh!

nalathethird commented Nov 23, 2025

Uh oh!

nalathethird commented Nov 23, 2025

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

nalathethird left a comment

Choose a reason for hiding this comment

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI commented Nov 23, 2025

Uh oh!

nalathethird commented Nov 23, 2025

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Copilot AI Nov 23, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI commented Nov 23, 2025

Uh oh!

Copilot AI commented Nov 23, 2025

Uh oh!

Copilot AI commented Nov 23, 2025

Uh oh!

Copilot AI commented Nov 23, 2025

Uh oh!

Copilot AI commented Nov 23, 2025

Uh oh!

Copilot AI commented Nov 23, 2025

Uh oh!

Copilot AI commented Nov 23, 2025

Uh oh!

nalathethird commented Nov 23, 2025

Uh oh!

Reviewers