Plugin Game Settings Subsystem by Cryotechnic · Pull Request #900 · CollapseLauncher/Collapse

Cryotechnic · 2026-08-18T06:44:02Z

Main Goal

Add declarative plugin-defined game settings support to Plugin.Core and render those settings in Collapse.
Also harden plugin integration by:

Keeping the game-log callback alive throughout asynchronous game sessions.
Hydrating background notifications from an already-running activity’s current progress and status.
Correcting Wuthering Waves preload progress totals.

PR Status

Overall Status: Complete
Commits: Complete
Synced to base (Collapse:main): Yes
Build status: x64 Debug build passed
Crashing: None reported
Bugs found caused by PR: 0 reported

Changelog

[New] Add declarative plugin-defined game settings support to Plugin.Core and render those settings in Collapse.
[Fix] Keep the game-log callback alive throughout asynchronous game sessions.
[Fix] Initialize background notifications using the running activity’s current progress and status.
[Fix] Correct Wuthering Waves preload progress totals.
[Fix] Harden callback lifetimes and native-resource cleanup in plugin integration and background rendering.

Expose `Progress` and `Status` on `IBackgroundActivity` and use them when wiring notification handlers in `BackgroundActivityManager`. This immediately initializes notification text/progress for already-running activities instead of waiting for the next event, preventing placeholder content from lingering.

Add a reusable speed-calculator reset helper in `ProgressBase` and use it in plugin install progress updates to avoid bogus speed deltas after state transitions. The wrapper now resets its download baseline when install state changes, computes per-tick bytes only from monotonic progress, and clears speed/time-left values appropriately. It also ensures completed installs report zero time left and clamp per-file progress to 100%.

Refactor GSP into a responsive multi-column layout while keeping informational sections full width

socket-security · 2026-09-16T07:05:22Z

Review the following changes in direct dependencies. Learn more about Socket for GitHub.

Diff	Package	Supply Chain Security	Vulnerability	Quality	Maintenance	License
	microsoft.netframework.referenceassemblies.net462@1.0.3
	taskscheduler@2.12.2
	system.net.http@4.3.4
	fody@6.9.3
	system.security.cryptography.algorithms@4.3.0
	microsoft.netframework.referenceassemblies@1.0.3
	system.security.cryptography.encoding@4.3.0
	system.security.cryptography.primitives@4.3.0
	system.security.cryptography.x509certificates@4.3.0
	system.text.regularexpressions@4.3.1

View full report

socket-security · 2026-09-16T07:05:24Z

All alerts resolved. Learn more about Socket for GitHub.

This PR previously contained dependency changes with security issues that have been resolved, removed, or ignored.

View full report

neon-nyan

Any changes to the BG-related so far. For the game settings related, still waiting for my game to be installed first.

sentry · 2026-09-30T19:13:09Z

+public sealed partial class PluginGameSettingsPage
+{
+    private readonly GameSettingsExtension.GameSettingsContext _context;
+    private readonly TextBlock _statusText = new()


Bug: The _statusText TextBlock, intended for displaying plugin setting errors, is never added to the visual tree, so error messages are invisible to the user.
_{Severity: MEDIUM}

Suggested Fix

The _statusText TextBlock should be added to a visible parent container within the page's XAML layout, such as a Grid or StackPanel. This will ensure that when its Text property is updated with an error message, it is rendered and becomes visible to the user.

Prompt for AI Agent

Review the code at the location below. A potential bug has been identified by an AI agent. Verify if this is a real issue. If it is, propose a fix; if not, explain why it's not valid. Location: CollapseLauncher/XAMLs/MainApp/Pages/GameSettingsPages/PluginGameSettingsPage.cs#L31 Potential issue: In `PluginGameSettingsPage`, a `TextBlock` named `_statusText` is instantiated to display error messages that occur when a plugin setting is changed. However, this control is never added to the page's visual tree. When a user interacts with a setting and the plugin's `_context.SetValue()` method throws an exception, the `SetStatus(ex.Message, true)` method is called. This updates the `Text` property of `_statusText`, but because the control is not rendered, the error message remains invisible to the user, leading to silent failures.

Also affects:

CollapseLauncher/XAMLs/MainApp/Pages/GameSettingsPages/PluginGameSettingsPage.cs:279~296

Sign in to view

+                SwapChainPanelHelper.MediaPlayerCopyFrameUnsafe(_videoPlayerPtr, _canvasRenderTargetAsSurfacePtr);
+                drawingSessionPpv = SwapChainPanelHelper
+                   .CanvasSessionDrawUnsafe(_canvasImageSourceNativePtr,
+                                            _canvasRenderTargetNativePtr,
+                                            _functionTableBeginDraw,
+                                            _functionTableDrawImage,
+                                            in _canvasRenderSize);
+            }
        }
        // Device lost error. If happened, reinitialize render target
        catch (COMException comEx) when ((uint)comEx.HResult is 0x887A0005u or 0x802B0020u or 0x8899000Cu)


- Extract FFmpeg decoder checks into `RequiresFFmpegDecoder` and reuse it across codec detection and loader paths. - Treat 10-bit YUV420 (`AV_PIX_FMT_YUV420P10LE/BE`) as requiring FFmpeg, improving handling for High 10 H.264 backgrounds that Windows decoders may not support. - Tighten background reload behavior by comparing decoder mode before skipping reloads. - Layer setup now starts hidden, restores opacity after attach, and only sets a foreground overlay for video backgrounds.

- Improves `LayeredBackgroundImage` video initialization robustness by logging `MediaFailed` events, handling stale/invalid playback session size reads, and making render-target setup fail-safe with explicit success/failure returns. - Add proper native interface acquisition for DrawImageToRect, ensures acquired COM references are released correctly, detaches NaturalVideoSizeChanged on teardown, and clears frame player state during disposal to prevent leaks and stale callbacks.

- Improve LayeredBackgroundImage media handling to avoid race conditions and invalid state during video setup. - Render target initialization now fails safely and resets init state, FFmpeg source opening validates the active player before wiring it, and media-open flow now responds to natural size changes before creating the frame image. - Fix UI layering by hiding the foreground grid for static backgrounds (and restoring it for normal mode), and allows non-autoplay video to start when play was explicitly requested.

Use GameSettingsPageBase

Sign in to view


-        // -- Nullify _canvasImageSource so CanvasDevice and other dependencies are reinitialized too
-        Interlocked.Exchange(ref _canvasImageSource, null!);
-        InitializeRenderTarget();
+        lock (_videoFrameRenderLock)
+        {
+            Interlocked.Exchange(ref _isBlockVideoFrameDraw, 1);
+            NullifyRenderTargetNativePointers();
+            // Drop the image source only after invalidating its borrowed native pointer.
+            Interlocked.Exchange(ref _canvasImageSource, null!);
+            InitializeRenderTarget();

-        // Try to unlock video draw progress (if a throw happened inside frame drawing routine)
-        Interlocked.Exchange(ref _isVideoFrameDrawInProgress, 0);
+            Interlocked.Exchange(ref _isVideoFrameDrawInProgress, 0);
+        }


+ Change CanvasVirtualImageSource -> CanvasImageSource + Simplify atomic check on the renderer state + Handle device lost and context lost catch correctly + Remove lock-based spin

Sign in to view

+                                    true);

-            _functionTableCopyFrameToVideoSurface(_videoPlayerPtr, _canvasRenderTargetAsSurfacePtr);
-            drawingSessionPpv = SwapChainPanelHelper
-               .CanvasSessionDrawUnsafe(_canvasImageSourceNativePtr,
-                                        _canvasRenderTargetNativePtr,
-                                        _functionTableBeginDraw,
-                                        _functionTableDrawImage,
-                                        in _canvasRenderSize);
-        }
-        // Device lost error. If happened, reinitialize render target
-        catch (COMException comEx) when ((uint)comEx.HResult is 0x887A0005u or 0x802B0020u or 0x8899000Cu)
-        {
-            DispatcherQueue.TryEnqueue(CanvasDevice_OnDeviceLost);
-        }
-        catch (COMException comEx) when ((uint)comEx.HResult is 0x88980801u)
-        {
-            // Try to unlock if any error caused by DCOMPOSITION_ERROR_SURFACE_NOT_BEING_RENDERED
-            Interlocked.Exchange(ref _isVideoFrameDrawInProgress, 0);
-        }
-        catch (Exception ex)
-        {
-            Logger.LogWriteLine($"[LayeredBackgroundImage::VideoPlayer_VideoFrameAvailableUnsafe|OtherThread] {ex}",
-                                LogType.Error,
-                                true);
-        }
-        finally
-        {
-            if (drawingSessionPpv != nint.Zero)
+                // Re-create the context and start redrawing.
+                _canvasImageSource?.Recreate(_canvasDevice);
+                goto StartDraw;
+            }


Still had issues with hard crash while trying to re-create the device context for the CanvasImageSource

Sign in to view

+
+        _functionTableCopyFrameToVideoSurface(_videoPlayerPtr, _canvasRenderTargetAsSurfacePtr);


The .Dispose() still require to be called from the UI thread

sentry · 2026-10-01T20:16:43Z

+        try
+        {


Bug: The VideoPlayerSafe_OnVideoFrameAvailable method is missing the drawingSession?.DrawImage() call, causing the safe renderer fallback to display a blank video background.
_{Severity: HIGH}

Suggested Fix

Restore the missing line drawingSession?.DrawImage(_canvasRenderTarget, _canvasRenderSize); in the VideoPlayerSafe_OnVideoFrameAvailable method, after the CreateDrawingSession call, to ensure the video frame is drawn to the canvas.

Prompt for AI Agent

Review the code at the location below. A potential bug has been identified by an AI agent. Verify if this is a real issue. If it is, propose a fix; if not, explain why it's not valid. Location: CollapseLauncher/XAMLs/Theme/CustomControls/LayeredBackgroundImage.Events.FrameRenderer.cs#L184-L185 Potential issue: In the `VideoPlayerSafe_OnVideoFrameAvailable` method, a refactoring error resulted in the removal of the `drawingSession?.DrawImage()` call. The code now correctly copies a video frame to the `_canvasRenderTarget` and creates a `CanvasDrawingSession`, but it never draws the render target's content into the session. Consequently, when the drawing session is disposed, it renders a blank, transparent surface. This bug manifests when the application falls back to the 'safe' frame renderer, causing the video background to be completely blank instead of displaying the video.

Also affects:

CollapseLauncher/XAMLs/Theme/CustomControls/LayeredBackgroundImage.Events.FrameRenderer.cs:211~219

Cryotechnic force-pushed the plugin branch from 2036453 to 150f2d3 Compare August 19, 2026 20:01

Cryotechnic added 7 commits September 16, 2026 03:01

Update submodules

82e9188

feat(settings): render plugin game settings pages

7c1a411

Bump submodules

3945b9d

Fix opacity causing elements not to render correctly

90c9c1a

Improve plugin settings layout

e46deea

Refactor GSP into a responsive multi-column layout while keeping informational sections full width

Cryotechnic force-pushed the plugin branch from 5d50aa3 to e46deea Compare September 16, 2026 07:04

Cryotechnic marked this pull request as ready for review September 30, 2026 16:30

Cryotechnic changed the title ~~[DRAFT] Plugin Game Settings Subsystem~~ Plugin Game Settings Subsystem Sep 30, 2026

neon-nyan reviewed Sep 30, 2026

View reviewed changes

Comment thread CollapseLauncher/XAMLs/Theme/CustomControls/LayeredBackgroundImage.Events.FrameInitializer.cs Outdated

Comment thread CollapseLauncher/XAMLs/Theme/CustomControls/LayeredBackgroundImage.Events.FrameRenderer.cs Outdated

sentry Bot reviewed Sep 30, 2026

View reviewed changes

Comment thread CollapseLauncher/XAMLs/MainApp/Pages/GameSettingsPages/PluginGameSettingsPage.cs Outdated

sentry Bot reviewed Sep 30, 2026

View reviewed changes

Comment thread CollapseLauncher/XAMLs/Theme/CustomControls/LayeredBackgroundImage.Events.FrameInitializer.cs Outdated

Comment thread CollapseLauncher/XAMLs/Theme/CustomControls/LayeredBackgroundImage.Events.Loaders.cs

sentry Bot reviewed Sep 30, 2026

View reviewed changes

bagusnl and others added 11 commits October 1, 2026 10:02

Merge remote-tracking branch 'https/main' into plugin

88598cf

bump submodules

bdaaf91

Queue UseFfmpegDecoder property via DispatcherQueue

961f6d2

Fix HRESULT handling in unsafe video frame copying

07fc91b

Guard game settings navigation init state

e6d253a

Fix layered video render locking

7950349

Unify plugin game settings design

a6828bb

Use GameSettingsPageBase

Add custom launch args section to plugin settings

b550fb4

bagusnl force-pushed the plugin branch from e6631f3 to b550fb4 Compare October 1, 2026 14:52

sentry Bot reviewed Oct 1, 2026

View reviewed changes

[BG] Revert changes (Fix UI freeze due to lock and other changes)

ff37d4d

+ Change CanvasVirtualImageSource -> CanvasImageSource + Simplify atomic check on the renderer state + Handle device lost and context lost catch correctly + Remove lock-based spin

sentry Bot reviewed Oct 1, 2026

View reviewed changes

[BG] Revert using CanvasVirtualImageSource

f988e48

Still had issues with hard crash while trying to re-create the device context for the CanvasImageSource

sentry Bot reviewed Oct 1, 2026

View reviewed changes

Comment thread CollapseLauncher/XAMLs/Theme/CustomControls/LayeredBackgroundImage.Events.FrameRenderer.cs Outdated

Comment on lines +103 to +104

_functionTableCopyFrameToVideoSurface(_videoPlayerPtr, _canvasRenderTargetAsSurfacePtr);

This comment was marked as outdated.

Sign in to view

[BG] Off-load CanvasDrawingSession outside of UI Thread

feb26ce

The .Dispose() still require to be called from the UI thread

sentry Bot reviewed Oct 1, 2026

View reviewed changes

Navigation Menu

Repository navigation

Plugin Game Settings Subsystem - #900

Plugin Game Settings Subsystem#900
Cryotechnic wants to merge 21 commits into
mainfrom
plugin

Cryotechnic commented Aug 18, 2026 •

edited

Loading

Uh oh!

socket-security Bot commented Sep 16, 2026 •

edited

Loading

Uh oh!

socket-security Bot commented Sep 16, 2026 •

edited

Loading

Uh oh!

neon-nyan left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

sentry Bot Sep 30, 2026

Uh oh!

This comment was marked as outdated.

Uh oh!

This comment was marked as outdated.

Uh oh!

This comment was marked as outdated.

Uh oh!

This comment was marked as outdated.

Uh oh!

sentry Bot Oct 1, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants


		_functionTableCopyFrameToVideoSurface(_videoPlayerPtr, _canvasRenderTargetAsSurfacePtr);

Conversation

Cryotechnic commented Aug 18, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Main Goal

PR Status

Changelog

Uh oh!

socket-security Bot commented Sep 16, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

socket-security Bot commented Sep 16, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

neon-nyan left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

sentry Bot Sep 30, 2026

Choose a reason for hiding this comment

Uh oh!

This comment was marked as outdated.

Uh oh!

This comment was marked as outdated.

Uh oh!

This comment was marked as outdated.

Uh oh!

This comment was marked as outdated.

Uh oh!

sentry Bot Oct 1, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Cryotechnic commented Aug 18, 2026 •

edited

Loading

socket-security Bot commented Sep 16, 2026 •

edited

Loading

socket-security Bot commented Sep 16, 2026 •

edited

Loading