App Examples

Since not all applications behave the same, we decided to create some examples to help you get started adding games and applications to Sunshine.

Attention

Throughout these examples, any fields not shown are left blank. You can enhance your experience by adding an image or a log file (via the Output field).

Common Examples

Desktop

Field	Value
Application Name	Desktop
Image	desktop.png

Steam Big Picture

Note

Steam is launched as a detached command because Steam starts with a process that self updates itself and the original process is killed. Since the original process ends it will not work as a regular command.

Field	Linux	macOS	Windows
Application Name	Steam Big Picture
Detached Commands	setsid steam steam://open/bigpicture	open steam://open/bigpicture	steam steam://open/bigpicture
Image	steam.png

Epic Game Store game

Note

Using URI method will be the most consistent between various games, but does not allow a game to be launched using the “Command” and therefore the stream will not end when the game ends.

URI (Epic)

Field	Windows
Application Name	Surviving Mars
Detached Commands	cmd /C "start com.epicgames.launcher://apps/d759128018124dcabb1fbee9bb28e178%3A20729b9176c241f0b617c5723e70ec2d%3AOvenbird?action=launch&silent=true"

Binary (Epic w/ working directory)

Field	Windows
Application Name	Surviving Mars
Command	cmd /c "MarsEpic.exe"
Working Directory	C:\Program Files\Epic Games\SurvivingMars

Binary (Epic w/o working directory)

Field	Windows
Application Name	Surviving Mars
Command	"C:\Program Files\Epic Games\SurvivingMars\MarsEpic.exe"

Steam game

Note

Using URI method will be the most consistent between various games, but does not allow a game to be launched using the “Command” and therefore the stream will not end when the game ends.

URI (Steam)

Field	Linux	macOS	Windows
Application Name	Surviving Mars
Detached Commands	setsid steam steam://rungameid/464920	open steam://rungameid/464920	cmd /C "start steam://rungameid/464920"

Binary (Steam w/ working directory)

Field	Linux	macOS	Windows
Application Name	Surviving Mars
Command	MarsSteam		cmd /c "MarsSteam.exe"
Working Directory	~/.steam/steam/SteamApps/common/Survivng Mars		C:\Program Files (x86)\Steam\steamapps\common\Surviving Mars

Binary (Steam w/o working directory)

Field	Linux	macOS	Windows
Application Name	Surviving Mars
Command	~/.steam/steam/SteamApps/common/Survivng Mars/MarsSteam		"C:\Program Files (x86)\Steam\steamapps\common\Surviving Mars\MarsSteam.exe"

Linux

Changing Resolution and Refresh Rate (Linux - X11)

Field	Value
Command Preparations	Do: xrandr --output HDMI-1 --mode 1920x1080 --rate 60
	Undo: xrandr --output HDMI-1 --mode 3840×2160 --rate 120

Changing Resolution and Refresh Rate (Linux - Wayland)

Field	Value
Command Preparations	Do: wlr-xrandr --output HDMI-1 --mode 1920x1080@60Hz
	Undo: wlr-xrandr --output HDMI-1 --mode 3840×2160@120Hz

Flatpak

Attention

Because Flatpak packages run in a sandboxed environment and do not normally have access to the host, the Flatpak of Sunshine requires commands to be prefixed with flatpak-spawn --host.

macOS

Changing Resolution and Refresh Rate (macOS)

Note

This example uses the displayplacer tool to change the resolution. This tool can be installed following instructions in their GitHub repository.

Field	Value
Command Preparations	Do: displayplacer "id:<screenId> res:1920x1080 hz:60 scaling:on origin:(0,0) degree:0"
	Undo: displayplacer "id:<screenId> res:3840x2160 hz:120 scaling:on origin:(0,0) degree:0"

Windows

Changing Resolution and Refresh Rate (Windows)

Note

This example uses the QRes tool to change the resolution and refresh rate. This tool can be downloaded from their SourceForge repository.

Field	Value
Command Preparations	Do: FullPath\qres.exe /x:1920 /y:1080 /r:60
	Undo: FullPath\qres.exe /x:3840 /y:2160 /r:120

Tip

You can change your host resolution to match the client resolution automatically using the Nonary/ResolutionAutomation project.