From 1d49e80478df610e190af50908aee7e681ea2488 Mon Sep 17 00:00:00 2001 From: loki Date: Mon, 16 Dec 2019 22:39:50 +0100 Subject: [PATCH] Update README --- README.txt | 28 ++++++++++++++++++++++++++++ 1 file changed, 28 insertions(+) diff --git a/README.txt b/README.txt index c4fdcd43..f7428265 100644 --- a/README.txt +++ b/README.txt @@ -15,6 +15,8 @@ Setup: * Modify $HOME/.config/systemd/user/sunshine.conf to point to the sunshine executable * systemctl --user start sunshine + * assets/apps.json is an example of a list of applications that are started just before running a stream: + * See below for a detailed explanation Usage: * run "sunshine" @@ -34,3 +36,29 @@ Note: Credits: * Simple-Web-Server [https://gitlab.com/eidheim/Simple-Web-Server] * Moonlight [https://github.com/moonlight-stream] + + + +Application List: + * You can use Environment variables in place of values + * $(HOME) will be replaced by the value of $HOME + * $$ will be replaced by $ --> $$(HOME) will be replaced by $(HOME) + * env: Adds or overwrites Environment variables for the commands/applications run by Sunshine. + * "Variable name":"Variable value" + * apps: The list of applications + * name: Self explanatory + * output : The file where the output of the command is stored + * If it is not specified, the output is ignored + * prep-cmd: A list of commands to be run before/after the application + * If any of the prep-commands fail, starting the application is aborted + * do: Run before the application + * If it fails, all 'undo' commands of the previously succeeded 'do' commands are run + * undo : Run after the application has terminated + * This should not fail considering it is supposed to undo the 'do' commands. + * If it fails, Sunshine is terminated + * cmd : The main application + * If not specified, a processs is started that sleeps indefinitely + +When an application is started, if there is an application already running, it will be terminated. +When the application has been shutdown, the stream shuts down as well. +In addition to the apps listed, one app "Desktop" is hardcoded into Sunshine. It does not start an application, instead it simply starts a stream.