-
Notifications
You must be signed in to change notification settings - Fork 0
Help Url
A Help-Url is opened automatically when opening
the Game Menu
the editor from the Editor Menu
or when choosing retry in the CrashGuess
or via the 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):
- a file is opened with a text editor from the Editor Menu
- retry was selected in the CrashGuess
The sourcelist for the available urls for the dropdown menu comes from the [helpurls.txt](https://github.com/360900/tinkergame/blob/master/misc/helpurls.txt) file in $GLOBALMISCDIR (usually /usr/share/tinkergame/misc),
but it can be overridden with an own helpurls.txt in $STLCFGDIR (~/.config/tinkergame/).
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, tinkergame 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:

As opening the Help-Url may be requested multiple times from different places, but it is not possible to check whether 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

Quick Links
- Changelog
- Installation
- Usage
- Main Menu
- Global Menu
- Tray Icon
- Modding
- Platform-Specific Documentation
- Tweaks
- Utilities
- Advanced