mirror/Sunshine
1
0
Fork 0
mirror of https://github.com/LizardByte/Sunshine.git synced 2025-01-30 12:32:43 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Update app examples to clarify new command syntax for Windows

Browse Source
This commit is contained in:
Cameron Gutman 2024-03-06 20:55:00 -06:00
parent 06c0ed1d1c
commit f5dd0d4eaf
1 changed files with 9 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
docs/source/about/guides/app_examples.rst
View File

@ -6,6 +6,8 @@ and applications to Sunshine.
.. attention:: Throughout these examples, any fields not shown are left blank. You can enhance your experience by .. 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). adding an image or a log file (via the ``Output`` field).
.. note:: When a working directory is not specified, it defaults to the folder where the target application resides.
Common Examples Common Examples
--------------- ---------------
@ -24,7 +26,7 @@ Steam Big Picture
^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^
.. note:: Steam is launched as a detached command because Steam starts with a process that self updates itself and the original .. 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. process is killed.
.. tab:: Linux .. tab:: Linux
@ -51,7 +53,7 @@ Steam Big Picture
+----------------------+-----------------------------+ +----------------------+-----------------------------+
| Application Name | ``Steam Big Picture`` | | Application Name | ``Steam Big Picture`` |
+----------------------+-----------------------------+ +----------------------+-----------------------------+
| Detached Commands | ``steam://open/bigpicture`` | | Command | ``steam://open/bigpicture`` |
+----------------------+-----------------------------+ +----------------------+-----------------------------+
| Image | ``steam.png`` | | Image | ``steam.png`` |
+----------------------+-----------------------------+ +----------------------+-----------------------------+
@ -59,8 +61,7 @@ Steam Big Picture
Epic Game Store game 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 .. note:: Using URI method will be the most consistent between various games.
using the "Command" and therefore the stream will not end when the game ends.
URI (Epic) URI (Epic)
"""""""""" """"""""""
@ -70,7 +71,7 @@ URI (Epic)
+----------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ +----------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
| Application Name | ``Surviving Mars`` | | Application Name | ``Surviving Mars`` |
+----------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ +----------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
| Detached Commands | ``com.epicgames.launcher://apps/d759128018124dcabb1fbee9bb28e178%3A20729b9176c241f0b617c5723e70ec2d%3AOvenbird?action=launch&silent=true`` | | Command | ``com.epicgames.launcher://apps/d759128018124dcabb1fbee9bb28e178%3A20729b9176c241f0b617c5723e70ec2d%3AOvenbird?action=launch&silent=true`` |
+----------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ +----------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
Binary (Epic w/ working directory) Binary (Epic w/ working directory)
@ -81,7 +82,7 @@ Binary (Epic w/ working directory)
+----------------------+-----------------------------------------------+ +----------------------+-----------------------------------------------+
| Application Name | ``Surviving Mars`` | | Application Name | ``Surviving Mars`` |
+----------------------+-----------------------------------------------+ +----------------------+-----------------------------------------------+
| Command | ``cmd /c "MarsEpic.exe"`` | | Command | ``MarsEpic.exe`` |
+----------------------+-----------------------------------------------+ +----------------------+-----------------------------------------------+
| Working Directory | ``C:\Program Files\Epic Games\SurvivingMars`` | | Working Directory | ``C:\Program Files\Epic Games\SurvivingMars`` |
+----------------------+-----------------------------------------------+ +----------------------+-----------------------------------------------+
@ -100,8 +101,7 @@ Binary (Epic w/o working directory)
Steam game Steam game
^^^^^^^^^^ ^^^^^^^^^^
.. note:: Using URI method will be the most consistent between various games, but does not allow a game to be launched .. note:: Using URI method will be the most consistent between various games.
using the "Command" and therefore the stream will not end when the game ends.
URI (Steam) URI (Steam)
""""""""""" """""""""""
@ -127,7 +127,7 @@ URI (Steam)
+----------------------+------------------------------+ +----------------------+------------------------------+
| Application Name | ``Surviving Mars`` | | Application Name | ``Surviving Mars`` |
+----------------------+------------------------------+ +----------------------+------------------------------+
| Detached Commands | ``steam://rungameid/464920`` | | Command | ``steam://rungameid/464920`` |
+----------------------+------------------------------+ +----------------------+------------------------------+
Binary (Steam w/ working directory) Binary (Steam w/ working directory)