Merge pull request #136 from hdgamer1404Jonas/main

Add Support for Custom Splash screens

Author: Lauriethefish

QuestPatcher.Core/Models/PatchingOptions.cs

@@ -24,12 +24,16 @@ public bool HandTracking
         public bool Microphone { get; set; }
 
         public bool OpenXR { get; set; }
-        
+
         public bool FlatScreenSupport { get; set; }
 
         public HandTrackingVersion HandTrackingType { get; set; }
 
         public ModLoader ModLoader { get; set; } = ModLoader.QuestLoader;
 
+        /// <summary>
+        /// Path to a PNG file containing a custom splash screen.
+        /// </summary>
+        public string? CustomSplashPath { get; set; } = null;
     }
 }

QuestPatcher.Core/Patching/PatchingManager.cs

@@ -201,24 +201,28 @@ private async Task PatchManifest(ApkZip apk)
                     "org.khronos.openxr.permission.OPENXR_SYSTEM",
                 });
 
-                AxmlElement providerElement = new("provider") {
-                    Attributes = {new("authorities", AndroidNamespaceUri, AuthoritiesAttributeResourceId, "org.khronos.openxr.runtime_broker;org.khronos.openxr.system_runtime_broker")},
+                AxmlElement providerElement = new("provider")
+                {
+                    Attributes = { new("authorities", AndroidNamespaceUri, AuthoritiesAttributeResourceId, "org.khronos.openxr.runtime_broker;org.khronos.openxr.system_runtime_broker") },
                 };
-                AxmlElement runtimeIntent = new("intent") {
+                AxmlElement runtimeIntent = new("intent")
+                {
                     Children = {
                         new("action") {
                             Attributes = {new("name", AndroidNamespaceUri, NameAttributeResourceId, "org.khronos.openxr.OpenXRRuntimeService")},
                         },
                     },
                 };
-                AxmlElement layerIntent = new("intent") {
+                AxmlElement layerIntent = new("intent")
+                {
                     Children = {
                         new("action") {
                             Attributes = {new("name", AndroidNamespaceUri, NameAttributeResourceId, "org.khronos.openxr.OpenXRApiLayerService")},
                         },
                     },
                 };
-                manifest.Children.Add(new("queries") {
+                manifest.Children.Add(new("queries")
+                {
                     Children = {
                         providerElement,
                         runtimeIntent,
@@ -475,6 +479,21 @@ private async Task ModifyApk(string mainPath, string? modloaderPath, string? uni
                 await AddFlatscreenSupport(apk, ovrPlatformSdkPath!);
             }
 
+            if (_config.PatchingOptions.CustomSplashPath != null)
+            {
+                Log.Information("Checking if Splash screen file exists");
+                if (File.Exists(_config.PatchingOptions.CustomSplashPath))
+                {
+                    apk.RemoveFile("assets/vr_splash.png");
+                    await AddFileToApk(_config.PatchingOptions.CustomSplashPath, "assets/vr_splash.png", apk, true);
+                    Log.Information("Replaced Splash with custom Image");
+                }
+                else
+                {
+                    Log.Warning("Could not add custom splash screen: file did not exist.");
+                }
+            }
+
             Log.Information("Patching manifest . . .");
             await PatchManifest(apk);
 
@@ -495,8 +514,9 @@ private async Task ModifyApk(string mainPath, string? modloaderPath, string? uni
         /// <param name="filePath">The path to the file to copy into the APK</param>
         /// <param name="apkFilePath">The name of the file in the APK to create</param>
         /// <param name="apk">The apk to copy the file into</param>
+        /// <param name="useStore">If enabled, compression is disabled and the STORE compression method is used.</param>
         /// <exception cref="PatchingException">If the file already exists in the APK, if configured to throw.</exception>
-        private async Task AddFileToApk(string filePath, string apkFilePath, ApkZip apk)
+        private async Task AddFileToApk(string filePath, string apkFilePath, ApkZip apk, bool useStore = false)
         {
             using var fileStream = File.OpenRead(filePath);
             if (apk.ContainsFile(apkFilePath))
@@ -511,7 +531,7 @@ private async Task AddFileToApk(string filePath, string apkFilePath, ApkZip apk)
                 fileStream.Position = 0;
             }
 
-            await apk.AddFileAsync(apkFilePath, fileStream, PatchingCompression);
+            await apk.AddFileAsync(apkFilePath, fileStream, useStore ? null : PatchingCompression);
         }
 
         /// <summary>

QuestPatcher/ViewModels/PatchingViewModel.cs

@@ -1,5 +1,7 @@
 using System;
+using System.Linq;
 using Avalonia.Controls;
+using Avalonia.Platform.Storage;
 using QuestPatcher.Core;
 using QuestPatcher.Core.Models;
 using QuestPatcher.Core.Patching;
@@ -17,6 +19,8 @@ public class PatchingViewModel : ViewModelBase
 
         public string PatchingStageText { get; private set; } = "";
 
+        public string? CustomSplashPath => Config.PatchingOptions.CustomSplashPath;
+
         public Config Config { get; }
 
         public OperationLocker Locker { get; }
@@ -104,6 +108,26 @@ public async void StartPatching()
             }
         }
 
+        public async void SelectSplashPath()
+        {
+            try
+            {
+                var files = await _mainWindow.StorageProvider.OpenFilePickerAsync(new FilePickerOpenOptions
+                {
+                    FileTypeFilter = new[]
+                    {
+                        FilePickerFileTypes.ImagePng
+                    }
+                });
+                Config.PatchingOptions.CustomSplashPath = files.FirstOrDefault()?.Path.LocalPath;
+                this.RaisePropertyChanged(nameof(CustomSplashPath));
+            }
+            catch (Exception ex)
+            {
+                Log.Error(ex, "Failed to select splash screen path");
+            }
+        }
+
         /// <summary>
         /// Updates the patching stage text in the view
         /// </summary>

QuestPatcher/Views/PatchingView.axaml

@@ -12,7 +12,7 @@
   <Panel>
     <DockPanel IsVisible="{Binding !IsPatchingInProgress}">
         <StackPanel Margin="20" Orientation="Vertical" DockPanel.Dock="Top">
-          <ToggleButton IsChecked="{Binding Config.ShowPatchingOptions}" VerticalAlignment="Top" HorizontalAlignment="Right">Customise Permissions</ToggleButton>
+          <ToggleButton IsChecked="{Binding Config.ShowPatchingOptions}" VerticalAlignment="Top" HorizontalAlignment="Right">Patching Options</ToggleButton>
           <ScrollViewer Margin="0 15 0 0" IsVisible="{Binding Config.ShowPatchingOptions}" HorizontalScrollBarVisibility="Auto" VerticalAlignment="Top" Background="{DynamicResource PatchingOptionsBackground}">
               <StackPanel Orientation="Horizontal" Spacing="25" Margin="10">
                   <ToggleSwitch IsChecked="{Binding Config.PatchingOptions.ExternalFiles}" IsEnabled="False">Allow External Files</ToggleSwitch>
@@ -32,6 +32,18 @@
                   </StackPanel>
               </StackPanel>
           </ScrollViewer>
+          <Panel Margin="0 10 0 0" Background="{DynamicResource PatchingOptionsBackground}">
+            <StackPanel Orientation="Vertical" Spacing="10" IsVisible="{Binding Config.ShowPatchingOptions}" Margin="10">
+              <StackPanel Orientation="Horizontal" Spacing="5">
+                <TextBlock>Custom Splash Screen:</TextBlock>
+              </StackPanel>
+              <StackPanel Orientation="Horizontal" Spacing="5">
+                <Button Command="{Binding SelectSplashPath}">Browse</Button>
+                <TextBlock Text="{Binding CustomSplashPath}" IsVisible="{Binding CustomSplashPath, Converter={x:Static ObjectConverters.IsNotNull}}>" VerticalAlignment="Center"/>
+                <TextBlock Text="None Selected" IsVisible="{Binding CustomSplashPath, Converter={x:Static ObjectConverters.IsNull}}>" VerticalAlignment="Center" />
+              </StackPanel>
+            </StackPanel>
+          </Panel>
         </StackPanel>
 
         <StackPanel HorizontalAlignment="Center" Orientation="Vertical" VerticalAlignment="Center" Spacing="20">