Skip to content

Help Url

frostworx edited this page Nov 20, 2021 · 3 revisions

Open automatically a Help-Url when opening the Game Menu the editor from the Editor Menu or when choosing retry in the CrashGuess or via Help-Url Extra Button

When a Help-Url (HELPURL) is selected (per game, so in the Game Settings) this Url will be automatically opened in various situations, which are (currently):

The sourcelist for the available urls for the dropdown menu comes from the [helpurls.txt](https://github.com/frostworx/steamtinkerlaunch/blob/master/misc/helpurls.txt) file in $GLOBALMISCDIR (usually /usr/share/steamtinkerlaunch/misc)_, but it can be overridden with an own helpurls.txt in $STLCFGDIR (~/.config/steamtinkerlaunch/). Additionally both the metacritic page and the game manual are available if they were found in the Appinfo and stored in the general Metadata.

If opening the Url opens a new browser session, steamtinkerlaunch tries to detect this using a KillBrowser file ($STLSHM/KillBrowser-$AID.txt) and kills the browser when 'exit' is selected and a KillBrowser file is found to close the game session properly. The KillBrowser file is removed on exit.

The default Help-Url is none.

In the CrashGuess the HELPURL can also be temporarily overridden with a dropdown menu:

crash-guess

As it may be possible that opening the Help-Url is called multiple times from different places, but it is not possible to check if the user closed it in between, opening is at least rejected if a KillBrowser ($STLSHM/KillBrowser-$AID.txt) already exists.

It is also possible to simply choose and open one of the available help urls using the Help-Url Extra Button from the Main Menu

Help-Url

Clone this wiki locally