[Improv]: Add environment variables for use by wrappers

[mtkennerly]

This adds two environment variables when launching games: HEROIC_APP_NAME and HEROIC_APP_STORE. Wrapper commands can use these to look up the app info in the Heroic config (e.g., to get the title or Wine prefix for save backup purposes, in my case).

I tested this on Windows 11 with GOG and Epic. I don't have any Amazon games, so I wasn't able to test that.

In order to test on my system, I made the WrappersTable display on Windows (which I'd like to submit in a separate PR after some testing), then configured a wrapper as a Python script. Main interesting part of the script:

path = Path("C:/tmp/script.log")

with path.open("a") as f:
    f.write(f"{sys.argv}\n")
    for k, v in os.environ.items():
        if k.startswith("HEROIC_"):
            f.write(f"{k} = {v}\n")

I verified that the new environment variables were written out to the log file:

['C:/tmp/script.py', 'C:\\Users\\mtken\\Games\\Heroic\\Dead Cells\\deadcells.exe']
HEROIC_APP_NAME = 1237807960
HEROIC_APP_STORE = gog

['C:/tmp/script.py', 'C:\\Users\\mtken\\Games\\Heroic\\CaveStoryPlus\\CaveStory+.exe', '-AUTH_LOGIN=unused', '-AUTH_PASSWORD=<redacted>', '-AUTH_TYPE=exchangecode', '-epicapp=1dea8a6ddb544842a58e4b5c8675ff58', '-epicenv=Prod', '-EpicPortal', '-epicusername=<redacted>', '-epicuserid=<redacted>', '-epiclocale=en', '-epicsandboxid=78473822f724474d8e436f6bde735623']
HEROIC_APP_NAME = 1dea8a6ddb544842a58e4b5c8675ff58
HEROIC_APP_STORE = epic

---

Use the following Checklist if you have changed something on the Backend or Frontend:

• Tested the feature and it's working on a current and clean install.
• Tested the main App features and they are still working on a current and clean install. (Login, Install, Play, Uninstall, Move games, etc.)
• Created / Updated Tests (If necessary)
• Created / Updated documentation (If necessary)

I think these environment variables should be documented, but I'm not sure where that information belongs.

[imLinguin]

Looks good overall, could you also add it for sideload runner? It might not be useful for your use case, but it's good to have it consistent

[mtkennerly]

@imLinguin Updated in 8db11ac :)

I changed HEROIC_APP_STORE to HEROIC_APP_SOURCE since "store" doesn't make as much sense for sideloaded apps.

[CommandMC]

Suggested change

* @param wrapperEnv The wrapper info to be added into the environment variables

Seems like this was moved to its own function

[mtkennerly]

Ah, I originally tried adding the functionality here, but realized it worked better separate and forgot to reset the documentation. Fixed in 87ee893.

[CommandMC]

Suggested change

	let commandEnv = {
	...process.env,
	...setupWrapperEnvVars({ appName, appRunner: 'gog' })
	}
	if (!isWindows) {
	commandEnv = { ...commandEnv, ...setupEnvVars(gameSettings) }
	}
	let commandEnv = {
	...process.env,
	...setupWrapperEnvVars({ appName, appRunner: 'gog' }),
	...(isWindows ? {} : setupEnvVars(gameSettings))
	}

This feels a little cleaner

[mtkennerly]

Good call. Updated in 5d1a6fe.

[Nocccer]

Overall looks good.
I left some suggestion/question.

[Nocccer]

Why not ?

Suggested change

	switch (wrapperEnv.appRunner) {
	case 'gog':
	ret.HEROIC_APP_SOURCE = 'gog'
	break
	case 'legendary':
	ret.HEROIC_APP_SOURCE = 'epic'
	break
	case 'nile':
	ret.HEROIC_APP_SOURCE = 'amazon'
	break
	case 'sideload':
	ret.HEROIC_APP_SOURCE = 'sideload'
	break
	}
	ret.HEROIC_APP_SOURCE = wrappernEnv.appRunner

[mtkennerly]

I was thinking there could be a case in the future where it may help to distinguish the runner and the source, like if you could choose two different runners for the same store or if one runner supported multiple stores. Not sure if that's a valid/realistic concern given Heroic's design goals.

I added a HEROIC_APP_RUNNER env var in e78e680. Just let me know if you'd prefer to have HEROIC_APP_SOURCE removed as well.

[flavioislima]

Looks good, thanks for that!