Returns all recognized/installed games which are currently installed with this game store/launcher. Please note that the game entries should be cached to avoid running a potentially resource intensive operation for each game the user attempts to manage.
Attempt to find a game entry using its game store Id/Ids.
of the game entry. This is obviously game store specific.
Attempt to find a game store entry using the game's name.
the game name which the game store uses to identify this game.
OptionalgetGame store may support command line arguments when launching the game. Function will return the path to the game store's executable and any required arguments to launch the game.
Returns the full path to the launcher's executable. As of 1.4, this function is no longer optional - gamestores such as the Xbox app which do not have a stat-able store path should return Promise.resolve(undefined) and define the "isGameStoreInstalled" function so that the game store helper is able to confirm that the gamestore is installed on the user's PC
OptionalgetSome launchers may support Posix paths when attempting to launch a game, if set, the launcher will be expected to generate a valid posix path which Vortex can use to start the game.
Please note that Vortex will not be able to tell if the game actually launched successfully when using Posix Paths; reason why this should only be used as a last resort.
This store's id.
Optionalidentifydetermine if the specified game is managed by/installed through this store. Stores don't have to implement this, as a fallback Vortex will go through allGames from this store and see if one matches the path. This function should only be implemented if there is a more reliable way to connect this store to the game, like every gog game contains a gog.ico file in the game root directory. The fallback function can be used to invoke the "default" behavior on top.
OptionalisDetermine whether the game has been installed by this game store launcher. returns true if the game store installed this game, false otherwise.
OptionalisIn most cases the game store helper is fully capable of determining whether a gamestore is installed by stat-ing the store's executable.
However, gamestores such as the Xbox store which do not have a stat-able executable path MUST provide this function so that the game store helper can confirm that the store is installed correctly!
Launches the game using this game launcher.
whatever the game store uses to identify a game.
Optionalapi: IExtensionApigives access to API functions if needed.
OptionallaunchGenerally the game store helper should be able to launch games directly. This functor allows game stores to define their own custom start up logic if needed. e.g. gamestore-xbox
OptionalnameThis store's name. If unset, will use the id instead of the name when displaying to users
OptionalpriorityIf a game is found on multiple stores, this controls which store is preferred (by default) (lower means preferred) This should be solely based on which store tends to be less problematic for modding (stuff like DRM and such), not a subjective preference of the store.
Values <= 30 are for stores that have features benefiting modding (no DRM GOG) Values >= 70 are for stores that have features hindering modding (extra DRM Xbox) Values between should all be ok, we only assign different values so the order is deterministic and because some stores provide better meta information than others or have more robust information
OptionalreloadAllows game stores to provide functionality to reload/refresh their game entries. This is potentially a resource intensive operation and should not be called unless it is vital to do so.
The game store helper is configured to call this function for all known game stores when a discovery scan is initiated.
interface for game store extensions
IGameStore