Implement Plugin System for Adding Support for Third-Party (Non-miHoYo) Titles #752

neon-nyan · 2025-05-29T15:30:03Z

Main Goal

As per title says, this PR implements a Plugin System for Collapse Launcher, which will bring supports for any third-party (non-miHoYo) games.

This PR is still heavily in-development and in its state, is not yet ready to be implemented into Collapse Launcher's main repository. Though, the core library component is currently in the works.

First-Party Game Support Targets (by Collapse Project Team)

Heaven Burns Red (Plugin Maintainer: @neon-nyan) (In-progress)
- Engine: Unity 2020.x (2020.3.15f2)
- Developer: Wright Flyer Studios/GREE Holdings, Inc., Key
- Published by:
  - Global: Yostar (November 15th, 2024)
  - Japan: Wright Flyer Studios/GREE Holdings, Inc., Key
Wuthering Waves (Plugin Maintainer: @Cryotechnic) (Pending)
- Engine: Unreal Engine 4 (build 4.26.2)
- Developer: Kuro Games
- Published by:
  - Global: Kuro Games (May 22nd, 2024)

Implementation Progress Tracking

Core Library

Collapse Launcher

GitHub

Add template plugin repository for easy plugin generation
Update README, CONTRIBUTING and others to reflect future plugin support
Create CI flow for building and distributing precompiled DLLs from plugin repositories, including external forks

Websites (main & status)

Create documentation on feature set, compatibility, etc.
Create new status labels & category for plugin statuses

PR Status :

Overall Status : In Progress
Commits : In Progress
Synced to base (Collapse:main) : Yes

Templates

Changelog Prefixes

  **[New]**
  **[Imp]**
  **[Fix]**
  **[Loc]**
  **[Doc]**

Now the default values assignment only happens if correction is needed

…pdate

bagusnl · 2025-05-30T02:49:55Z

As of the CoreLib do we want to include Discord RPC as well, tho it might need quite a adjustment to detach the currently hardcoded Discord IDs to metadata or separate configs location for per-game RPCs.
The generic RPC also needs to be adjusted a little bit

Cryotechnic · 2025-05-30T11:21:22Z

I believe that for Discord RPC, we can probably do something along the lines of just showing a generic "Playing a custom game" to avoid having to implement custom IDs on our end.

The alternative would be to have the plugin developer provide their own ID through the plugin configuration interface/code that we expose and display a generic message if that feature is not used.

neon-nyan · 2025-05-30T14:33:13Z

I believe that for Discord RPC, we can probably do something along the lines of just showing a generic "Playing a custom game" to avoid having to implement custom IDs on our end.

The alternative would be to have the plugin developer provide their own ID through the plugin configuration interface/code that we expose and display a generic message if that feature is not used.

We can re-use the managed code part for Discord integration. The IDs for the Discord Presence will be provided by the plugin, stored in IPluginPresetConfig instance. If it's null, then tell the managed code to disable Discord Presence for that certain game.

github-actions · 2025-05-31T16:40:35Z

Qodana for .NET

10 new problems were found

Inspection name	Severity	Problems
`Redundant using directive`	🔶 Warning	8
`Expression is always 'true' or 'false' according to nullable reference types' annotations`	🔶 Warning	1
`Possible 'System.NullReferenceException'`	🔶 Warning	1

💡 Qodana analysis was run in the pull request mode: only the changed files were checked
☁️ View the detailed Qodana report

Detected 72 dependencies

Third-party software list

This page lists the third-party software dependencies used in CollapseLauncher

Dependency	Version	Licenses
CommunityToolkit.Common	8.4.0	MIT
CommunityToolkit.Mvvm	8.4.0	MIT
CommunityToolkit.WinUI.Animations	8.2.250402	MIT
CommunityToolkit.WinUI.Behaviors	8.2.250402	MIT
CommunityToolkit.WinUI.Controls.Primitives	8.2.250402	MIT
CommunityToolkit.WinUI.Controls.Sizers	8.2.250402	MIT
CommunityToolkit.WinUI.Converters	8.2.250402	MIT
CommunityToolkit.WinUI.Extensions	8.2.250402	MIT
CommunityToolkit.WinUI.Helpers	8.2.250402	MIT
CommunityToolkit.WinUI.Media	8.2.250402	MIT
CommunityToolkit.WinUI.Triggers	8.2.250402	MIT
Costura.Fody	6.0.0	MIT
DependencyPropertyGenerator	1.5.0	MIT
DotNet.ReproducibleBuilds	1.2.25	MIT
EventGenerator.Generator	0.13.1	MIT
Fody	6.9.2	MIT
GitInfo	3.5.0	MIT
Google.Protobuf.Tools	3.31.1	PROTOBUF
Google.Protobuf	3.31.1	BSD-3-Clause
Hi3Helper.ZstdNet	1.6.4	BSD-3-Clause
HtmlAgilityPack	1.12.1	MIT
Markdig.Signed	0.41.2	BSD-2-Clause
Microsoft.CSharp	4.7.0	MIT
Microsoft.Extensions.DependencyInjection.Abstractions	9.0.3	MIT
Microsoft.Extensions.DependencyInjection.Abstractions	9.0.5	MIT
Microsoft.Extensions.DependencyInjection	9.0.5	MIT
Microsoft.Extensions.Logging.Abstractions	9.0.3	MIT
Microsoft.Extensions.Logging.Abstractions	9.0.5	MIT
Microsoft.Extensions.Logging	9.0.5	MIT
Microsoft.Extensions.Options	9.0.5	MIT
Microsoft.Extensions.Primitives	9.0.5	MIT
Microsoft.NET.ILLink.Tasks	9.0.6	MIT
Microsoft.NETCore.Targets	6.0.0-preview.4.21253.7	MIT
Microsoft.Web.WebView2	1.0.3344-prerelease	BSD-3-Clause BSD-MYLEX
Microsoft.Win32.SystemEvents	9.0.5	MIT
Microsoft.Windows.CsWin32	0.3.183	Apache-2.0
Microsoft.Windows.CsWinRT	2.2.0	MIT
Microsoft.Windows.SDK.BuildTools.MSIX	1.7.20250508.1	MIT
Microsoft.Windows.SDK.BuildTools	10.0.26100.4188	PROPRIETARY-LICENSE
Microsoft.Windows.SDK.Win32Docs	0.1.42-alpha	PROPRIETARY-LICENSE
Microsoft.Windows.SDK.Win32Metadata	63.0.31-preview	MIT
Microsoft.Windows.WDK.Win32Metadata	0.13.25-experimental	MIT
Microsoft.WindowsAppSDK.AI	1.8.135-experimental	MS-DXSDK-D3DX-9.29.952.3
Microsoft.WindowsAppSDK.Base	1.8.250509001-experimental	MIT MS-DXSDK-D3DX-9.29.952.3
Microsoft.WindowsAppSDK.DWrite	1.8.25050910-experimental.2	MS-DXSDK-D3DX-9.29.952.3
Microsoft.WindowsAppSDK.Foundation	1.8.250507001-experimental	MS-DXSDK-D3DX-9.29.952.3
Microsoft.WindowsAppSDK.InteractiveExperiences	1.8.250509002-experimental	MS-DXSDK-D3DX-9.29.952.3
Microsoft.WindowsAppSDK.Packages	1.8.250515001-experimental2	MIT MS-DXSDK-D3DX-9.29.952.3
Microsoft.WindowsAppSDK.Widgets	1.8.250505003-experimental	MS-DXSDK-D3DX-9.29.952.3
Microsoft.WindowsAppSDK.WinUI	1.8.250507002-experimental	MIT MS-DXSDK-D3DX-9.29.952.3
Microsoft.WindowsAppSDK	1.8.250515001-experimental2	MIT MS-DXSDK-D3DX-9.29.952.3
Microsoft.Xaml.Behaviors.WinUI.Managed	3.0.0	MIT
NuGet.Versioning	6.14.0	Apache-2.0
PhotoSauce.MagicScaler	0.15.0	MIT
PhotoSauce.NativeCodecs.Libwebp	1.4.0-preview1	MIT
Roman-Numerals	2.0.1	MIT
Sentry	5.10.0	MIT
SharpCompress	0.40.0	MIT
SharpHDiffPatch.Core	2.3.3	MIT
System.Buffers	4.6.0	MIT
System.Drawing.Common	9.0.5	MIT
System.IO.Hashing	9.0.5	MIT
System.IO.Hashing	9.0.6	MIT
System.Security.AccessControl	6.0.1	MIT
System.Security.Cryptography.ProtectedData	9.0.5	MIT
System.Text.Encoding.CodePages	9.0.5	MIT
System.Text.Json	9.0.5	MIT
System.Threading.Tasks.Extensions	4.5.4	MIT
TaskScheduler	2.12.1	MIT
ThisAssembly.Constants	2.0.6	MIT
Velopack	0.0.1297	MIT
ZstdSharp.Port	0.8.5	MIT

Contact Qodana team

Contact us at qodana-support@jetbrains.com

Or via our issue tracker: https://jb.gg/qodana-issue
Or share your feedback: https://jb.gg/qodana-discussions

CollapseLauncher/Classes/Interfaces/Class/Structs.cs

 using System;
 using System.Diagnostics.CodeAnalysis;
 using System.IO;
+using System.Runtime.CompilerServices;
+using System.Runtime.InteropServices;


CollapseLauncher/Plugins/PluginInfo.cs

+            .GetAwaiter()
+            .GetResult();
+
+        if (resolvedIpAddresses == null || resolvedIpAddresses.Length == 0)


100% reviewed source file: 'en_US.json' on 'zh_CN'.

100% reviewed source file: 'en_US.json' on 'ja_JP'.

%AppData%\..\LocalLow\CollapseLauncher\_plugins

CollapseLauncher/Plugins/PluginGameInstallWrapper.cs

sonarqubecloud · 2025-06-20T09:54:34Z

Quality Gate failed

Failed conditions
5 Security Hotspots
E Reliability Rating on New Code (required ≥ A)

See analysis details on SonarQube Cloud

Catch issues before they fail your Quality Gate with our IDE extension SonarQube for IDE

CollapseLauncher/Classes/Interfaces/Class/Structs.cs

@@ -1,9 +1,12 @@
 using CollapseLauncher.Helper.Metadata;
 using Hi3Helper;
 using Hi3Helper.Data;
+using Hi3Helper.Plugin.Core.Management;


CollapseLauncher/Classes/Interfaces/Class/Structs.cs

 using System;
 using System.Diagnostics.CodeAnalysis;
 using System.IO;
+using System.Runtime.CompilerServices;


neon-nyan added 8 commits May 15, 2025 01:48

Some adjustment for Plugin preparation (pt. 1)

98a8eba

Cache List<T> return on Wrapper

3e1559d

Avoid config.ini default values on initialization

398e345

Now the default values assignment only happens if correction is needed

Fix GetGameState doesn't aware of alt. executable name

2f37ab6

Remove unused string on delta patch repair

ae8ce01

Fix wrong indicator if the game have both Sophon and Delta-patch on u…

e150ab8

…pdate

Update core plugin submodule

c1c47b7

Merge branch 'main' into plugin

6b5d4da

neon-nyan added this to the 1.83.x milestone May 29, 2025

neon-nyan self-assigned this May 29, 2025

neon-nyan assigned Cryotechnic May 29, 2025

Add wrapper for GameVersionManager

878fd90

neon-nyan added 5 commits May 31, 2025 21:56

Initial Plugin Loading implementation

1d6aede

Bridge DNS Resolver to Plugin

796a367

Ensure to ignore plugin-generated Config Stamp

79a0670

Explicitly define delegate type

0a852f6

Add some display texts for debug

1824325

github-advanced-security bot found potential problems May 31, 2025

View reviewed changes

neon-nyan and others added 11 commits June 6, 2025 12:21

Change FindGameInstallationPath to async

4868189

Fix Sophon forced to set while fallback is enabled

2fef0b1

Merge branch 'main' into plugin

9e40345

Update submodules

09931fa

[skip ci] Sync translation Translate en_US.json in zh_CN

e175072

100% reviewed source file: 'en_US.json' on 'zh_CN'.

[skip ci] Sync translation Translate en_US.json in ja_JP

2e7f13d

100% reviewed source file: 'en_US.json' on 'ja_JP'.

Merge branch 'main' into plugin

c98f5ff

Update submodule

9203a38

Simplify string marshalling for entry structs

5f992aa

Move plugins folder to App Game Data Folder

1eecac0

%AppData%\..\LocalLow\CollapseLauncher\_plugins

Update Hi3Helper.Sophon

93fee8e

Cryotechnic changed the title ~~Implement Plugin System for Adding Support for Third-Party (Non-miHoYo) Games~~ Implement Plugin System for Adding Support for Third-Party (Non-miHoYo) Titles Jun 12, 2025

neon-nyan added 5 commits June 13, 2025 01:16

Merge branch 'main' into plugin

1e94bfe

Update Hi3Helper.Plugin.Core

e8ba6a1

Fix DynamicInterfaceCastableImplementation warning

7af5960

Fix Unnecessary save routine on UpdateGamePath and UpdateGameVersion

4b571d5

Initial PluginGameInstallWrapper implementation

2a4c700

github-advanced-security bot found potential problems Jun 14, 2025

View reviewed changes

CollapseLauncher/Plugins/PluginGameInstallWrapper.cs Fixed Show fixed Hide fixed

neon-nyan added 10 commits June 15, 2025 01:05

Hide SidePanel Grid if both Carousel and News entries aren't available

eb8bca2

Fix redundant Token allocation on ProgressBase

95189e8

Show CommunityToolsBtn if only the entries are available

3bf8a29

Implement basic install and update routine on PluginGameInstallWrapper

da9279d

Always un-cache GamePath details on GamePresetProperty

8152fbc

Set the value of GameManager.GameDirPath rather than saving

d281bc2

Update Hi3Helper.Plugin.Core

90210ac

Make PluginGameInstallWrapper aware of background task

4a5dcf1

Fix isUpdateMode detection on StartPackageInstallation

9aa261b

Use GameVersion from Plugin.Core

32982b8

github-advanced-security bot found potential problems Jun 20, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

Implement Plugin System for Adding Support for Third-Party (Non-miHoYo) Titles #752

Implement Plugin System for Adding Support for Third-Party (Non-miHoYo) Titles #752

neon-nyan commented May 29, 2025 •

edited

Loading

Uh oh!

bagusnl commented May 30, 2025

Uh oh!

Cryotechnic commented May 30, 2025 •

edited

Loading

Uh oh!

neon-nyan commented May 30, 2025

Uh oh!

github-actions bot commented May 31, 2025 •

edited

Loading

Third-party software list

Uh oh!

Check warning

Check warning

Uh oh!

sonarqubecloud bot commented Jun 20, 2025

Uh oh!

Check warning

Check warning

Uh oh!

Uh oh!

Implement Plugin System for Adding Support for Third-Party (Non-miHoYo) Titles #752

Are you sure you want to change the base?

Implement Plugin System for Adding Support for Third-Party (Non-miHoYo) Titles #752

Conversation

neon-nyan commented May 29, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Main Goal

First-Party Game Support Targets (by Collapse Project Team)

Implementation Progress Tracking

Core Library

Collapse Launcher

GitHub

Websites (main & status)

PR Status :

Templates

Uh oh!

bagusnl commented May 30, 2025

Uh oh!

Cryotechnic commented May 30, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

neon-nyan commented May 30, 2025

Uh oh!

github-actions bot commented May 31, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Qodana for .NET

Third-party software list

Uh oh!

Check warning

Check warning

Uh oh!

sonarqubecloud bot commented Jun 20, 2025

Quality Gate failed

Uh oh!

Check warning

Check warning

Uh oh!

neon-nyan commented May 29, 2025 •

edited

Loading

Cryotechnic commented May 30, 2025 •

edited

Loading

github-actions bot commented May 31, 2025 •

edited

Loading