SunshineCaptureSwitcher

KO | EN

gitlite — search

#python #react #golang #go #android #machine-learning #rust #linux #docker #macos #java #windows #awesome #cli

SunshineCaptureSwitcher

(★ 32)

🔄 Automatic WGC/DDX switching for Sunshine.

SunshineCaptureSwitcher Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# 🔄 Sunshine Capture Switcher  
![GitHub Downloads](https://img.shields.io/github/downloads/roob-p/SunshineCaptureSwitcher/total)

✨ This utility automatically switches between WGC (*Windows.Graphics.Capture*) and DDX (*DirectX Desktop Duplication API*) in Sunshine. 
When using WGC it's not possible to stream while on the lock screen, so the program switches to DDX when the computer is locked, and switches back to WGC when the computer is unlocked.
**Works with both Sunshine and Apollo. Now includes an automatic UAC-handling system when in WGC mode.**

## 🚀 How it works:
- Two tasks are created in the Windows Task Scheduler:
  - Sunshine WGC, triggered when the computer is unlocked.
  - Sunshine DDX, triggered when the computer is locked (as well as during sleep, hibernation, etc.).
- Since version 1.0.5, a third task has been added: `Sunshine WGC Boot (Autologon and no-pw)`, triggered at logon, to handle boot scenarios where `Autologon` is enabled or `no password` is set.
- Starting from version 1.0.3, support for `Apollo` and a `UAC-handling system` have been added. The scripts can now stay active, and a system tray icon is shown to indicate which capture method is running. 
- From version 1.0.2 onwards, Sunshine Capture Switcher no longer modifies the `Sunshine.conf` file to set the capture method, but directly launches Sunshine with the `capture=wgc` flag when WGC is to be used.
- If you don't want the tasks to automatically run on locking and unlocking the computer and prefer to launch Sunshine manually, run `Deactivate Tasks Trigger` (also available as `Activate Tasks Trigger` to restore the original functionality). You can also launch Sunshine using the `Sunshine DDX` and `Sunshine WGC` shortcuts from the Start menu and desktop.
- When switching capture methods, you’ll need to reconnect from the client.
- You can edit the Sunshine and Apollo installation paths in `config.ini.`

## ⚙️ UAC Handling system (WGC-specific):
- When using WGC, UAC prompts are not visible in the stream. To work around this limitation, the script can automatically switch to DDX when a UAC prompt appears and return to WGC once the UAC window is closed (however, reconnecting from the client is required).
- In `config.ini`, `Reswitch` defines how the script behaves when UAC prompts:
   - `0`: Do nothing. Sunshine remains in WGC mode, and the WGC icon stays visible in the system tray.
   - `1`: Switch to DDX and remain there *(you’ll need to reconnect after switching).*
   - `2`: `(default)` Temporarily switch to DDX, and return to WGC once the UAC window is closed *(requires reconnecting twice from the client).* ‎‎‎‎After returning to WGC, the script remains active in the system tray and continues to monitor for future UAC prompts. 
   - `-1`: Launch Sunshine in WGC mode and then close the WGC script. *(no WGC icon in the system tray).*

## 🛰️ Support for Apollo:
- Just set `ProgToUse = Apollo` in `config.ini` and the program is ready to use!

<br>

### 🔄 Boot task for Autologon and No Password
- v1.0.5 adds a third scheduled task for scenarios where `Autologon` is enabled or `no password` is set.   
- This task runs an intermediate script (`Wait for Desktop (Autologon and no-pw).exe`) which waits until the desktop has focus before launching `Sunshine WGC`. This is necessary because directly executing`Sunshine WGC` during a traditional login (with a password) causes streaming to fail, as `Sunshine WGC` would start before the password prompt appears.  
- When the desktop is ready, you need to click on it with the mouse to launch of `Sunshine WGC`.  
- If you don't use `Autologon` and have a password, you can disable this task by running `Deactivate autologon and no-pw trigger.exe` or `Delete autologon and no-pw trigger.exe`.  
- 🔁 Alternatively, if `Autologon` is enabled or `no password` is set but you prefer not to use this task, you can deactivate or delete it first, then manually copy the `Sunshine WGC.lnk` shortcut to the `shell:startup folder`. However, this approach adds a delay before `Sunshine WGC` starts.
- If your account has no password, you can optionally change the action of the `Sunshine WGC Boot (Autologon and no-pw)` task to run `Sunshine WGC.exe` directly.

## ⚠️ Notes:
- If Sunshine is set to WGC, it cannot be launched via service (this causes errors on the localhost homepage). It must be launched directly as an .exe (which the program handles automatically).
- In WGC mode, UAC prompts won't show up, so the program now includes the workaround described above.
- You can tell if WGC mode is active by checking the tray icon or by pressing Win + G to open the Windows Game Bar: it will only show on the client side when the stream is using WGC.
- If you don't want the DDX tray icon (and its script) to stay active after launching Sunshine in DDX mode, set `DdxPersistentIcon(andScript)` to 0 in `config.ini`.
- You can specify the tray icons to use under the `[Icons]` section in `config.ini`.  
  If the icon files are located in the installation folder, **do not** use a relative path like `.\wgc.ico`, just write `wgc.ico`.  
  *Two different icon types (for WGC and DDX) are already included in the installation folder.*
<br>

[![ko-fi](https://ko-fi.com/img/githubbutton_sm.svg)](https://ko-fi.com/roobp)

SunshineCaptureSwitcher

SunshineCaptureSwitcher Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

SunshineCaptureSwitcher

SunshineCaptureSwitcher Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README