update sunshine base script, add new refresh rate option

Nonary · Nonary · commit 823cd68fab04 · 2025-02-06T00:43:34.000-06:00
diff --git a/Events.ps1 b/Events.ps1
@@ -24,6 +24,12 @@ function OnStreamStart() {
     $script:arguments['original_resolution'] = Get-HostResolution
     $expectedRes = Join-Overrides -width $env:SUNSHINE_CLIENT_WIDTH -height $env:SUNSHINE_CLIENT_HEIGHT -refresh $env:SUNSHINE_CLIENT_FPS
     $expectedRes = Set-10bitCompatibilityIfApplicable -width $expectedRes.Width -height $expectedRes.Height -refresh $expectedRes.Refresh
+    # If highest refresh rate is enabled in settings, override the refresh rate with the highest available
+    if ($settings.highestRefreshRate -eq $true) {
+        $highest = Get-HighestRefreshRateForResolution $expectedRes.Width $expectedRes.Height
+        Write-Host "Highest refresh rate enabled. Overriding refresh rate to $highest."
+        $expectedRes.Refresh = $highest
+    }
     Set-ScreenResolution -Width $expectedRes.Width -Height $expectedRes.Height -Freq $expectedRes.Refresh
     Assert-ResolutionChange -width $expectedRes.Width -height $expectedRes.Height -refresh $expectedRes.Refresh
 }
@@ -53,6 +59,8 @@ function OnStreamEnd($kwargs) {
 }
 
 
+
+
 Function Set-ScreenResolution($width, $height, $frequency) { 
     Write-Debug "Function Set-ScreenResolution called with Width: $width, Height: $height, Frequency: $frequency"
     Write-Host "Setting screen resolution to $width x $height x $frequency"
@@ -258,4 +266,22 @@ function Set-10bitCompatibilityIfApplicable($width, $height, $refresh) {
         Height  = $height
         Refresh = $refresh
     }
+}
+
+function Get-HighestRefreshRateForResolution($width, $height) {
+    Write-Debug "Function Get-HighestRefreshRateForResolution called with Width: $width, Height: $height"
+    $highestRefresh = 0
+    $modeNum = 0
+    $devMode = New-Object DisplaySettings+DEVMODE
+    $devMode.dmSize = [System.Runtime.InteropServices.Marshal]::SizeOf($devMode)
+    while ([DisplaySettings]::EnumDisplaySettings([NullString]::Value, $modeNum, [ref]$devMode)) {
+        if (($devMode.dmPelsWidth -eq $width) -and ($devMode.dmPelsHeight -eq $height)) {
+            if ($devMode.dmDisplayFrequency -gt $highestRefresh) {
+                $highestRefresh = $devMode.dmDisplayFrequency
+            }
+        }
+        $modeNum++
+    }
+    Write-Debug "Highest refresh rate for resolution $width x $height is $highestRefresh"
+    return $highestRefresh
 }
diff --git a/Helpers.ps1 b/Helpers.ps1
@@ -12,6 +12,14 @@ $script:attempt = 0
 function OnStreamEndAsJob() {
     return Start-Job -Name "$scriptName-OnStreamEnd" -ScriptBlock {
         param($path, $scriptName, $arguments)
+
+        function Write-Debug($message){
+            if ($arguments['debug']) {
+                Write-Host "DEBUG: $message"
+            }
+        }
+
+        Write-Host $arguments
         
         Write-Debug "Setting location to $path"
         Set-Location $path
@@ -41,6 +49,12 @@ function OnStreamEndAsJob() {
                 break;
             }
 
+        
+            if ((IsCurrentlyStreaming)) {
+                Write-Host "Streaming is active. To prevent potential conflicts, this script will now terminate prematurely."
+            }
+        
+
             while (($tries -lt $maxTries) -and ($job.State -ne "Completed")) {
                 Start-Sleep -Milliseconds 200
                 $tries++
@@ -56,7 +70,7 @@ function OnStreamEndAsJob() {
 function IsCurrentlyStreaming() {
     $sunshineProcess = Get-Process sunshine -ErrorAction SilentlyContinue
 
-    if($null -eq $sunshineProcess) {
+    if ($null -eq $sunshineProcess) {
         return $false
     }
     return $null -ne (Get-NetUDPEndpoint -OwningProcess $sunshineProcess.Id -ErrorAction Ignore)
@@ -91,7 +105,8 @@ function Send-PipeMessage($pipeName, $message) {
             # We don't care if the disposal fails, this is common with async pipes.
             # Also, this powershell script will terminate anyway.
         }
-    } else {
+    }
+    else {
         Write-Debug "Pipe not found: $pipeName"
     }
 }
@@ -105,12 +120,12 @@ function Create-Pipe($pipeName) {
         $pipe = New-Object System.IO.Pipes.NamedPipeServerStream($pipeName, [System.IO.Pipes.PipeDirection]::In, 10, [System.IO.Pipes.PipeTransmissionMode]::Byte, [System.IO.Pipes.PipeOptions]::Asynchronous)
 
         $streamReader = New-Object System.IO.StreamReader($pipe)
-        Write-Output "Waiting for named pipe to recieve kill command"
+        Write-Host "Waiting for named pipe to recieve kill command"
         $pipe.WaitForConnection()
 
         $message = $streamReader.ReadLine()
         if ($message) {
-            Write-Output "Terminating pipe..."
+            Write-Host "Terminating pipe..."
             $pipe.Dispose()
             $streamReader.Dispose()
             New-Event -SourceIdentifier $scriptName -MessageData $message
@@ -186,6 +201,47 @@ function Get-Settings {
     }
 }
 
+function Update-JsonProperty {
+    [CmdletBinding()]
+    param(
+        [Parameter(Mandatory = $true)]
+        [string]$FilePath,
+        
+        [Parameter(Mandatory = $true)]
+        [string]$Property,
+        
+        [Parameter(Mandatory = $true)]
+        [object]$NewValue
+    )
+
+    # Read the file as a single string.
+    $content = Get-Content -Path $FilePath -Raw
+
+    if ($NewValue -is [string]) {
+        # Convert the string to a JSON-compliant string.
+        # ConvertTo-Json will take care of escaping characters properly.
+        $formattedValue = (ConvertTo-Json $NewValue -Compress)
+    }
+    else {
+        $formattedValue = $NewValue.ToString()
+    }
+
+    # Build a regex pattern for matching the property.
+    $escapedProperty = [regex]::Escape($Property)
+    $pattern = '"' + $escapedProperty + '"\s*:\s*[^,}\r\n]+'
+
+    # Build the replacement string.
+    $replacement = '"' + $Property + '": ' + $formattedValue
+
+    # Replace the matching part in the content.
+    $updatedContent = [regex]::Replace($content, $pattern, { param($match) $replacement })
+
+    # Write the updated content back.
+    Set-Content -Path $FilePath -Value $updatedContent
+}
+
+
+
 function Wait-ForStreamEndJobToComplete() {
     $job = OnStreamEndAsJob
     while ($job.State -ne "Completed") {
diff --git a/Installer.ps1 b/Installer.ps1
@@ -73,6 +73,7 @@ function Test-AndRequest-SunshineConfig {
         
 # Define the path to the Sunshine configuration file
 $confPath = Test-AndRequest-SunshineConfig -InitialPath  "C:\Program Files\Sunshine\config\sunshine.conf"
+Update-JsonProperty -FilePath "./settings.json" -Property "sunshineConfigPath" -NewValue $confPath
 $scriptRoot = Split-Path $scriptPath -Parent
 
 
@@ -107,7 +108,7 @@ function Remove-Command {
 
     # Remove any existing matching Commands
     for ($i = 0; $i -lt $globalPrepCmdArray.Count; $i++) {
-        if (-not ($globalPrepCmdArray[$i].do -like "*$scriptName*")) {
+        if (-not ($globalPrepCmdArray[$i].do -like "*$scriptRoot*")) {
             $filteredCommands += $globalPrepCmdArray[$i]
         }
     }
@@ -213,7 +214,7 @@ function Add-Command {
     $command = [PSCustomObject]@{
         do       = "powershell.exe -executionpolicy bypass -file `"$($scriptPath)`" -n $scriptName"
         elevated = "false"
-        undo     = "powershell.exe -executionpolicy bypass -file `"$($scriptRoot)\Helpers.ps1`" -n $scriptName -t 1"
+        undo     = "powershell.exe -executionpolicy bypass -file `"$($scriptRoot)\UndoScript.ps1`" -n $scriptName"
     }
 
     # Add the new object to the global_prep_cmd array
diff --git a/Readme.md b/Readme.md
@@ -1,58 +1,58 @@
-## Host Resolution Matching for Moonlight Streaming
-
-This script changes your host resolution to match exactly with Moonlight's resolution. This is mostly used for users who have different aspect ratios between the client and host, or anyone who wishes to match the resolution while streaming.
-
-### Requirements
-
-- Host must be Windows.
-- Sunshine 0.21.0 or higher
-
-### Caveats:
- - If using Windows 11, you'll need to set the default terminal to Windows Console Host as there is currently a bug in Windows Terminal that prevents hidden consoles from working properly.
-    * That can be changed at Settings > System > For Developers > Terminal [Let Windows decide] >> (change to) >> Terminal [Windows Console Host]
-    * On older versions of Windows 11 it can be found at: Settings > Privacy & security > Security > For developers > Terminal [Let Windows decide] >> (change to) >> Terminal [Windows Console Host]
- - The script will stop working if you move the folder, simply reinstall it to resolve that issue.
- - Due to Windows API restrictions, this script does not work on cold reboots (hard crashes or shutdowns of your computer).
-    * If you're cold booting, simply sign into the computer using the "Desktop" app on Moonlight, then end the stream, then start it again. 
-
-#### GFE Users
-- You'll need to use the Geforce Experience version of this script instead. 
-  - The current release for Geforce Experience users is: https://github.com/Nonary/ResolutionAutomation/releases/tag/2.0.15_gfe
-
-### Installation Instructions
-1. Store the downloaded folder in a location you intend to keep. If you delete this folder or move it, the automation will stop working.
-2. To install, double click the Install.bat file.
-3. To uninstall, double click the Uninstall.bat file.
-
-This script will ask for elevated rights because Sunshine configuration is be locked from modifications for non-administrator users.
-
-### How it Works
-1. When you start streaming any application in Sunshine, it will start the script.
-2. The script reads the environment variables passed to it via Sunshine, which contains client information such as screen resolution.
-3. It sets the host's resolution to match the Moonlight resolution (including refresh rate), unless overridden with the `overrides` file.
-4. The script waits for Sunshine to be suspended for more than 120 seconds or until the user ends the stream.
-5. It sets the host resolution back to the same resolution it was prior to starting the stream (including refresh rate).
-
-This will only work if the resolution is available to be used, so you will need to make sure to use NVIDIA Custom Resolution or CRU to add the client resolution first.
-
-### Overrides (Setting)
-You may have a mobile device that you wish to stream at a lower resolution to save bandwidth or some devices may perform better when streaming at a lower resolution. If you want your host to change the resolution to something higher than the client, make modifications to the overrides section in the settings.json file
-
-#### Format
-```
-WidthxHeightxRefresh=WidthxHeightxRefresh
-```
-
-The resolution on the left is what triggers the override, and the one on the right is what the host will be set to.
-
-#### Example
-To stream at 720p and keep the host at 4k resolution, you would add this line:
-```
-"overrides": [
-        // recommended for steam deck users, uncomment to enable, but make sure you have 3840x2400 added on your host!
-        // sunshine has issues downscaling to smaller resolutions, so it is recommended to stream above native (you will see a significant difference)
-        // simply uncomment below line once done
-        //"2560x1440x90=3840x2400x60",
-        "1280x720x60=3840x2160x60"
-    ]
-```
+## Host Resolution Matching for Moonlight Streaming
+
+This script changes your host resolution to match exactly with Moonlight's resolution. This is mostly used for users who have different aspect ratios between the client and host, or anyone who wishes to match the resolution while streaming.
+
+### Requirements
+
+- Host must be Windows.
+- Sunshine 0.21.0 or higher
+
+### Caveats:
+ - If using Windows 11, you'll need to set the default terminal to Windows Console Host as there is currently a bug in Windows Terminal that prevents hidden consoles from working properly.
+    * That can be changed at Settings > System > For Developers > Terminal [Let Windows decide] >> (change to) >> Terminal [Windows Console Host]
+    * On older versions of Windows 11 it can be found at: Settings > Privacy & security > Security > For developers > Terminal [Let Windows decide] >> (change to) >> Terminal [Windows Console Host]
+ - The script will stop working if you move the folder, simply reinstall it to resolve that issue.
+ - Due to Windows API restrictions, this script does not work on cold reboots (hard crashes or shutdowns of your computer).
+    * If you're cold booting, simply sign into the computer using the "Desktop" app on Moonlight, then end the stream, then start it again. 
+
+#### GFE Users
+- You'll need to use the Geforce Experience version of this script instead. 
+  - The current release for Geforce Experience users is: https://github.com/Nonary/ResolutionAutomation/releases/tag/2.0.15_gfe
+
+### Installation Instructions
+1. Store the downloaded folder in a location you intend to keep. If you delete this folder or move it, the automation will stop working.
+2. To install, double click the Install.bat file.
+3. To uninstall, double click the Uninstall.bat file.
+
+This script will ask for elevated rights because Sunshine configuration is be locked from modifications for non-administrator users.
+
+### How it Works
+1. When you start streaming any application in Sunshine, it will start the script.
+2. The script reads the environment variables passed to it via Sunshine, which contains client information such as screen resolution.
+3. It sets the host's resolution to match the Moonlight resolution (including refresh rate), unless overridden with the `overrides` file.
+4. The script waits for Sunshine to be suspended for more than 120 seconds or until the user ends the stream.
+5. It sets the host resolution back to the same resolution it was prior to starting the stream (including refresh rate).
+
+This will only work if the resolution is available to be used, so you will need to make sure to use NVIDIA Custom Resolution or CRU to add the client resolution first.
+
+### Overrides (Setting)
+You may have a mobile device that you wish to stream at a lower resolution to save bandwidth or some devices may perform better when streaming at a lower resolution. If you want your host to change the resolution to something higher than the client, make modifications to the overrides section in the settings.json file
+
+#### Format
+```
+WidthxHeightxRefresh=WidthxHeightxRefresh
+```
+
+The resolution on the left is what triggers the override, and the one on the right is what the host will be set to.
+
+#### Example
+To stream at 720p and keep the host at 4k resolution, you would add this line:
+```
+"overrides": [
+        // recommended for steam deck users, uncomment to enable, but make sure you have 3840x2400 added on your host!
+        // sunshine has issues downscaling to smaller resolutions, so it is recommended to stream above native (you will see a significant difference)
+        // simply uncomment below line once done
+        //"2560x1440x90=3840x2400x60",
+        "1280x720x60=3840x2160x60"
+    ]
+```
diff --git a/UndoScript.ps1 b/UndoScript.ps1
diff --git a/settings.json b/settings.json

Original file line number	Diff line number	Diff line change
`@@ -73,6 +73,7 @@ function Test-AndRequest-SunshineConfig {`
`73`	`73`
`74`	`74`	`# Define the path to the Sunshine configuration file`
`75`	`75`	`$confPath = Test-AndRequest-SunshineConfig -InitialPath "C:\Program Files\Sunshine\config\sunshine.conf"`
	`76`	`+Update-JsonProperty -FilePath "./settings.json" -Property "sunshineConfigPath" -NewValue $confPath`
`76`	`77`	`$scriptRoot = Split-Path $scriptPath -Parent`
`77`	`78`
`78`	`79`
`@@ -107,7 +108,7 @@ function Remove-Command {`
`107`	`108`
`108`	`109`	`# Remove any existing matching Commands`
`109`	`110`	`for ($i = 0; $i -lt $globalPrepCmdArray.Count; $i++) {`
`110`		`- if (-not ($globalPrepCmdArray[$i].do -like "$scriptName")) {`
	`111`	`+ if (-not ($globalPrepCmdArray[$i].do -like "$scriptRoot")) {`
`111`	`112`	`$filteredCommands += $globalPrepCmdArray[$i]`
`112`	`113`	`}`
`113`	`114`	`}`
`@@ -213,7 +214,7 @@ function Add-Command {`
`213`	`214`	`$command = [PSCustomObject]@{`
`214`	`215`	do = "powershell.exe -executionpolicy bypass -file `"$($scriptPath)`" -n $scriptName"
`215`	`216`	`elevated = "false"`
`216`		- undo = "powershell.exe -executionpolicy bypass -file `"$($scriptRoot)\Helpers.ps1`" -n $scriptName -t 1"
	`217`	+ undo = "powershell.exe -executionpolicy bypass -file `"$($scriptRoot)\UndoScript.ps1`" -n $scriptName"
`217`	`218`	`}`
`218`	`219`
`219`	`220`	`# Add the new object to the global_prep_cmd array`